com.amazonaws.services.backup.model.ListBackupJobsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-backup Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.backup.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListBackupJobsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your list
* starting at the location pointed to by the next token.
*
*/
private String nextToken;
/**
*
* The maximum number of items to be returned.
*
*/
private Integer maxResults;
/**
*
* Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
*
*/
private String byResourceArn;
/**
*
* Returns only backup jobs that are in the specified state.
*
*
* Completed with issues is a status found only in the Backup console. For API, this status refers to
* jobs with a state of COMPLETED and a MessageCategory with a value other than
* SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the second,
* smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
*
*/
private String byState;
/**
*
* Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names
* that are unique to the account used to create them and the Amazon Web Services Region where they are created.
* They consist of lowercase letters, numbers, and hyphens.
*
*/
private String byBackupVaultName;
/**
*
* Returns only backup jobs that were created before the specified date.
*
*/
private java.util.Date byCreatedBefore;
/**
*
* Returns only backup jobs that were created after the specified date.
*
*/
private java.util.Date byCreatedAfter;
/**
*
* Returns only backup jobs for the specified resources:
*
*
* -
*
* Aurora for Amazon Aurora
*
*
* -
*
* CloudFormation for CloudFormation
*
*
* -
*
* DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
*
*
* -
*
* DynamoDB for Amazon DynamoDB
*
*
* -
*
* EBS for Amazon Elastic Block Store
*
*
* -
*
* EC2 for Amazon Elastic Compute Cloud
*
*
* -
*
* EFS for Amazon Elastic File System
*
*
* -
*
* FSx for Amazon FSx
*
*
* -
*
* Neptune for Amazon Neptune
*
*
* -
*
* Redshift for Amazon Redshift
*
*
* -
*
* RDS for Amazon Relational Database Service
*
*
* -
*
* SAP HANA on Amazon EC2 for SAP HANA databases
*
*
* -
*
* Storage Gateway for Storage Gateway
*
*
* -
*
* S3 for Amazon S3
*
*
* -
*
* Timestream for Amazon Timestream
*
*
* -
*
* VirtualMachine for virtual machines
*
*
*
*/
private String byResourceType;
/**
*
* The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
*
*
* If used from an Organizations management account, passing * returns all jobs across the
* organization.
*
*/
private String byAccountId;
/**
*
* Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
*
*/
private java.util.Date byCompleteAfter;
/**
*
* Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
*
*/
private java.util.Date byCompleteBefore;
/**
*
* This is a filter to list child (nested) jobs based on parent job ID.
*
*/
private String byParentJobId;
/**
*
* This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value
* you input.
*
*
* Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and
* InvalidParameters.
*
*
* View Monitoring
*
*
* The wildcard () returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*
*/
private String byMessageCategory;
/**
*
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your list
* starting at the location pointed to by the next token.
*
*
* @param nextToken
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your
* list starting at the location pointed to by the next token.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your list
* starting at the location pointed to by the next token.
*
*
* @return The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your
* list starting at the location pointed to by the next token.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your list
* starting at the location pointed to by the next token.
*
*
* @param nextToken
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your
* list starting at the location pointed to by the next token.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of items to be returned.
*
*
* @param maxResults
* The maximum number of items to be returned.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to be returned.
*
*
* @return The maximum number of items to be returned.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to be returned.
*
*
* @param maxResults
* The maximum number of items to be returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
*
*
* @param byResourceArn
* Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
*/
public void setByResourceArn(String byResourceArn) {
this.byResourceArn = byResourceArn;
}
/**
*
* Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
*
*
* @return Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
*/
public String getByResourceArn() {
return this.byResourceArn;
}
/**
*
* Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
*
*
* @param byResourceArn
* Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByResourceArn(String byResourceArn) {
setByResourceArn(byResourceArn);
return this;
}
/**
*
* Returns only backup jobs that are in the specified state.
*
*
* Completed with issues is a status found only in the Backup console. For API, this status refers to
* jobs with a state of COMPLETED and a MessageCategory with a value other than
* SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the second,
* smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
*
*
* @param byState
* Returns only backup jobs that are in the specified state.
*
* Completed with issues is a status found only in the Backup console. For API, this status
* refers to jobs with a state of COMPLETED and a MessageCategory with a value
* other than SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the
* second, smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
* @see BackupJobState
*/
public void setByState(String byState) {
this.byState = byState;
}
/**
*
* Returns only backup jobs that are in the specified state.
*
*
* Completed with issues is a status found only in the Backup console. For API, this status refers to
* jobs with a state of COMPLETED and a MessageCategory with a value other than
* SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the second,
* smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
*
*
* @return Returns only backup jobs that are in the specified state.
*
* Completed with issues is a status found only in the Backup console. For API, this status
* refers to jobs with a state of COMPLETED and a MessageCategory with a value
* other than SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the
* second, smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
* @see BackupJobState
*/
public String getByState() {
return this.byState;
}
/**
*
* Returns only backup jobs that are in the specified state.
*
*
* Completed with issues is a status found only in the Backup console. For API, this status refers to
* jobs with a state of COMPLETED and a MessageCategory with a value other than
* SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the second,
* smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
*
*
* @param byState
* Returns only backup jobs that are in the specified state.
*
* Completed with issues is a status found only in the Backup console. For API, this status
* refers to jobs with a state of COMPLETED and a MessageCategory with a value
* other than SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the
* second, smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupJobState
*/
public ListBackupJobsRequest withByState(String byState) {
setByState(byState);
return this;
}
/**
*
* Returns only backup jobs that are in the specified state.
*
*
* Completed with issues is a status found only in the Backup console. For API, this status refers to
* jobs with a state of COMPLETED and a MessageCategory with a value other than
* SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the second,
* smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
*
*
* @param byState
* Returns only backup jobs that are in the specified state.
*
* Completed with issues is a status found only in the Backup console. For API, this status
* refers to jobs with a state of COMPLETED and a MessageCategory with a value
* other than SUCCESS; that is, the status is completed but comes with a status message.
*
*
* To obtain the job count for Completed with issues, run two GET requests, and subtract the
* second, smaller number:
*
*
* GET /backup-jobs/?state=COMPLETED
*
*
* GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupJobState
*/
public ListBackupJobsRequest withByState(BackupJobState byState) {
this.byState = byState.toString();
return this;
}
/**
*
* Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names
* that are unique to the account used to create them and the Amazon Web Services Region where they are created.
* They consist of lowercase letters, numbers, and hyphens.
*
*
* @param byBackupVaultName
* Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified
* by names that are unique to the account used to create them and the Amazon Web Services Region where they
* are created. They consist of lowercase letters, numbers, and hyphens.
*/
public void setByBackupVaultName(String byBackupVaultName) {
this.byBackupVaultName = byBackupVaultName;
}
/**
*
* Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names
* that are unique to the account used to create them and the Amazon Web Services Region where they are created.
* They consist of lowercase letters, numbers, and hyphens.
*
*
* @return Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified
* by names that are unique to the account used to create them and the Amazon Web Services Region where they
* are created. They consist of lowercase letters, numbers, and hyphens.
*/
public String getByBackupVaultName() {
return this.byBackupVaultName;
}
/**
*
* Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names
* that are unique to the account used to create them and the Amazon Web Services Region where they are created.
* They consist of lowercase letters, numbers, and hyphens.
*
*
* @param byBackupVaultName
* Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified
* by names that are unique to the account used to create them and the Amazon Web Services Region where they
* are created. They consist of lowercase letters, numbers, and hyphens.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByBackupVaultName(String byBackupVaultName) {
setByBackupVaultName(byBackupVaultName);
return this;
}
/**
*
* Returns only backup jobs that were created before the specified date.
*
*
* @param byCreatedBefore
* Returns only backup jobs that were created before the specified date.
*/
public void setByCreatedBefore(java.util.Date byCreatedBefore) {
this.byCreatedBefore = byCreatedBefore;
}
/**
*
* Returns only backup jobs that were created before the specified date.
*
*
* @return Returns only backup jobs that were created before the specified date.
*/
public java.util.Date getByCreatedBefore() {
return this.byCreatedBefore;
}
/**
*
* Returns only backup jobs that were created before the specified date.
*
*
* @param byCreatedBefore
* Returns only backup jobs that were created before the specified date.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByCreatedBefore(java.util.Date byCreatedBefore) {
setByCreatedBefore(byCreatedBefore);
return this;
}
/**
*
* Returns only backup jobs that were created after the specified date.
*
*
* @param byCreatedAfter
* Returns only backup jobs that were created after the specified date.
*/
public void setByCreatedAfter(java.util.Date byCreatedAfter) {
this.byCreatedAfter = byCreatedAfter;
}
/**
*
* Returns only backup jobs that were created after the specified date.
*
*
* @return Returns only backup jobs that were created after the specified date.
*/
public java.util.Date getByCreatedAfter() {
return this.byCreatedAfter;
}
/**
*
* Returns only backup jobs that were created after the specified date.
*
*
* @param byCreatedAfter
* Returns only backup jobs that were created after the specified date.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByCreatedAfter(java.util.Date byCreatedAfter) {
setByCreatedAfter(byCreatedAfter);
return this;
}
/**
*
* Returns only backup jobs for the specified resources:
*
*
* -
*
* Aurora for Amazon Aurora
*
*
* -
*
* CloudFormation for CloudFormation
*
*
* -
*
* DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
*
*
* -
*
* DynamoDB for Amazon DynamoDB
*
*
* -
*
* EBS for Amazon Elastic Block Store
*
*
* -
*
* EC2 for Amazon Elastic Compute Cloud
*
*
* -
*
* EFS for Amazon Elastic File System
*
*
* -
*
* FSx for Amazon FSx
*
*
* -
*
* Neptune for Amazon Neptune
*
*
* -
*
* Redshift for Amazon Redshift
*
*
* -
*
* RDS for Amazon Relational Database Service
*
*
* -
*
* SAP HANA on Amazon EC2 for SAP HANA databases
*
*
* -
*
* Storage Gateway for Storage Gateway
*
*
* -
*
* S3 for Amazon S3
*
*
* -
*
* Timestream for Amazon Timestream
*
*
* -
*
* VirtualMachine for virtual machines
*
*
*
*
* @param byResourceType
* Returns only backup jobs for the specified resources:
*
* -
*
* Aurora for Amazon Aurora
*
*
* -
*
* CloudFormation for CloudFormation
*
*
* -
*
* DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
*
*
* -
*
* DynamoDB for Amazon DynamoDB
*
*
* -
*
* EBS for Amazon Elastic Block Store
*
*
* -
*
* EC2 for Amazon Elastic Compute Cloud
*
*
* -
*
* EFS for Amazon Elastic File System
*
*
* -
*
* FSx for Amazon FSx
*
*
* -
*
* Neptune for Amazon Neptune
*
*
* -
*
* Redshift for Amazon Redshift
*
*
* -
*
* RDS for Amazon Relational Database Service
*
*
* -
*
* SAP HANA on Amazon EC2 for SAP HANA databases
*
*
* -
*
* Storage Gateway for Storage Gateway
*
*
* -
*
* S3 for Amazon S3
*
*
* -
*
* Timestream for Amazon Timestream
*
*
* -
*
* VirtualMachine for virtual machines
*
*
*/
public void setByResourceType(String byResourceType) {
this.byResourceType = byResourceType;
}
/**
*
* Returns only backup jobs for the specified resources:
*
*
* -
*
* Aurora for Amazon Aurora
*
*
* -
*
* CloudFormation for CloudFormation
*
*
* -
*
* DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
*
*
* -
*
* DynamoDB for Amazon DynamoDB
*
*
* -
*
* EBS for Amazon Elastic Block Store
*
*
* -
*
* EC2 for Amazon Elastic Compute Cloud
*
*
* -
*
* EFS for Amazon Elastic File System
*
*
* -
*
* FSx for Amazon FSx
*
*
* -
*
* Neptune for Amazon Neptune
*
*
* -
*
* Redshift for Amazon Redshift
*
*
* -
*
* RDS for Amazon Relational Database Service
*
*
* -
*
* SAP HANA on Amazon EC2 for SAP HANA databases
*
*
* -
*
* Storage Gateway for Storage Gateway
*
*
* -
*
* S3 for Amazon S3
*
*
* -
*
* Timestream for Amazon Timestream
*
*
* -
*
* VirtualMachine for virtual machines
*
*
*
*
* @return Returns only backup jobs for the specified resources:
*
* -
*
* Aurora for Amazon Aurora
*
*
* -
*
* CloudFormation for CloudFormation
*
*
* -
*
* DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
*
*
* -
*
* DynamoDB for Amazon DynamoDB
*
*
* -
*
* EBS for Amazon Elastic Block Store
*
*
* -
*
* EC2 for Amazon Elastic Compute Cloud
*
*
* -
*
* EFS for Amazon Elastic File System
*
*
* -
*
* FSx for Amazon FSx
*
*
* -
*
* Neptune for Amazon Neptune
*
*
* -
*
* Redshift for Amazon Redshift
*
*
* -
*
* RDS for Amazon Relational Database Service
*
*
* -
*
* SAP HANA on Amazon EC2 for SAP HANA databases
*
*
* -
*
* Storage Gateway for Storage Gateway
*
*
* -
*
* S3 for Amazon S3
*
*
* -
*
* Timestream for Amazon Timestream
*
*
* -
*
* VirtualMachine for virtual machines
*
*
*/
public String getByResourceType() {
return this.byResourceType;
}
/**
*
* Returns only backup jobs for the specified resources:
*
*
* -
*
* Aurora for Amazon Aurora
*
*
* -
*
* CloudFormation for CloudFormation
*
*
* -
*
* DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
*
*
* -
*
* DynamoDB for Amazon DynamoDB
*
*
* -
*
* EBS for Amazon Elastic Block Store
*
*
* -
*
* EC2 for Amazon Elastic Compute Cloud
*
*
* -
*
* EFS for Amazon Elastic File System
*
*
* -
*
* FSx for Amazon FSx
*
*
* -
*
* Neptune for Amazon Neptune
*
*
* -
*
* Redshift for Amazon Redshift
*
*
* -
*
* RDS for Amazon Relational Database Service
*
*
* -
*
* SAP HANA on Amazon EC2 for SAP HANA databases
*
*
* -
*
* Storage Gateway for Storage Gateway
*
*
* -
*
* S3 for Amazon S3
*
*
* -
*
* Timestream for Amazon Timestream
*
*
* -
*
* VirtualMachine for virtual machines
*
*
*
*
* @param byResourceType
* Returns only backup jobs for the specified resources:
*
* -
*
* Aurora for Amazon Aurora
*
*
* -
*
* CloudFormation for CloudFormation
*
*
* -
*
* DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
*
*
* -
*
* DynamoDB for Amazon DynamoDB
*
*
* -
*
* EBS for Amazon Elastic Block Store
*
*
* -
*
* EC2 for Amazon Elastic Compute Cloud
*
*
* -
*
* EFS for Amazon Elastic File System
*
*
* -
*
* FSx for Amazon FSx
*
*
* -
*
* Neptune for Amazon Neptune
*
*
* -
*
* Redshift for Amazon Redshift
*
*
* -
*
* RDS for Amazon Relational Database Service
*
*
* -
*
* SAP HANA on Amazon EC2 for SAP HANA databases
*
*
* -
*
* Storage Gateway for Storage Gateway
*
*
* -
*
* S3 for Amazon S3
*
*
* -
*
* Timestream for Amazon Timestream
*
*
* -
*
* VirtualMachine for virtual machines
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByResourceType(String byResourceType) {
setByResourceType(byResourceType);
return this;
}
/**
*
* The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
*
*
* If used from an Organizations management account, passing * returns all jobs across the
* organization.
*
*
* @param byAccountId
* The account ID to list the jobs from. Returns only backup jobs associated with the specified account
* ID.
*
* If used from an Organizations management account, passing * returns all jobs across the
* organization.
*/
public void setByAccountId(String byAccountId) {
this.byAccountId = byAccountId;
}
/**
*
* The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
*
*
* If used from an Organizations management account, passing * returns all jobs across the
* organization.
*
*
* @return The account ID to list the jobs from. Returns only backup jobs associated with the specified account
* ID.
*
* If used from an Organizations management account, passing * returns all jobs across the
* organization.
*/
public String getByAccountId() {
return this.byAccountId;
}
/**
*
* The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
*
*
* If used from an Organizations management account, passing * returns all jobs across the
* organization.
*
*
* @param byAccountId
* The account ID to list the jobs from. Returns only backup jobs associated with the specified account
* ID.
*
* If used from an Organizations management account, passing * returns all jobs across the
* organization.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByAccountId(String byAccountId) {
setByAccountId(byAccountId);
return this;
}
/**
*
* Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
*
*
* @param byCompleteAfter
* Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time
* (UTC).
*/
public void setByCompleteAfter(java.util.Date byCompleteAfter) {
this.byCompleteAfter = byCompleteAfter;
}
/**
*
* Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
*
*
* @return Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time
* (UTC).
*/
public java.util.Date getByCompleteAfter() {
return this.byCompleteAfter;
}
/**
*
* Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
*
*
* @param byCompleteAfter
* Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time
* (UTC).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByCompleteAfter(java.util.Date byCompleteAfter) {
setByCompleteAfter(byCompleteAfter);
return this;
}
/**
*
* Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
*
*
* @param byCompleteBefore
* Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time
* (UTC).
*/
public void setByCompleteBefore(java.util.Date byCompleteBefore) {
this.byCompleteBefore = byCompleteBefore;
}
/**
*
* Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
*
*
* @return Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time
* (UTC).
*/
public java.util.Date getByCompleteBefore() {
return this.byCompleteBefore;
}
/**
*
* Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
*
*
* @param byCompleteBefore
* Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time
* (UTC).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByCompleteBefore(java.util.Date byCompleteBefore) {
setByCompleteBefore(byCompleteBefore);
return this;
}
/**
*
* This is a filter to list child (nested) jobs based on parent job ID.
*
*
* @param byParentJobId
* This is a filter to list child (nested) jobs based on parent job ID.
*/
public void setByParentJobId(String byParentJobId) {
this.byParentJobId = byParentJobId;
}
/**
*
* This is a filter to list child (nested) jobs based on parent job ID.
*
*
* @return This is a filter to list child (nested) jobs based on parent job ID.
*/
public String getByParentJobId() {
return this.byParentJobId;
}
/**
*
* This is a filter to list child (nested) jobs based on parent job ID.
*
*
* @param byParentJobId
* This is a filter to list child (nested) jobs based on parent job ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByParentJobId(String byParentJobId) {
setByParentJobId(byParentJobId);
return this;
}
/**
*
* This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value
* you input.
*
*
* Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and
* InvalidParameters.
*
*
* View Monitoring
*
*
* The wildcard () returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*
*
* @param byMessageCategory
* This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the
* value you input.
*
* Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL,
* and InvalidParameters.
*
*
* View Monitoring
*
*
* The wildcard () returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*/
public void setByMessageCategory(String byMessageCategory) {
this.byMessageCategory = byMessageCategory;
}
/**
*
* This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value
* you input.
*
*
* Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and
* InvalidParameters.
*
*
* View Monitoring
*
*
* The wildcard () returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*
*
* @return This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches
* the value you input.
*
* Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL,
* and InvalidParameters.
*
*
* View Monitoring
*
*
* The wildcard () returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*/
public String getByMessageCategory() {
return this.byMessageCategory;
}
/**
*
* This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value
* you input.
*
*
* Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and
* InvalidParameters.
*
*
* View Monitoring
*
*
* The wildcard () returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*
*
* @param byMessageCategory
* This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the
* value you input.
*
* Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL,
* and InvalidParameters.
*
*
* View Monitoring
*
*
* The wildcard () returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupJobsRequest withByMessageCategory(String byMessageCategory) {
setByMessageCategory(byMessageCategory);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getByResourceArn() != null)
sb.append("ByResourceArn: ").append(getByResourceArn()).append(",");
if (getByState() != null)
sb.append("ByState: ").append(getByState()).append(",");
if (getByBackupVaultName() != null)
sb.append("ByBackupVaultName: ").append(getByBackupVaultName()).append(",");
if (getByCreatedBefore() != null)
sb.append("ByCreatedBefore: ").append(getByCreatedBefore()).append(",");
if (getByCreatedAfter() != null)
sb.append("ByCreatedAfter: ").append(getByCreatedAfter()).append(",");
if (getByResourceType() != null)
sb.append("ByResourceType: ").append(getByResourceType()).append(",");
if (getByAccountId() != null)
sb.append("ByAccountId: ").append(getByAccountId()).append(",");
if (getByCompleteAfter() != null)
sb.append("ByCompleteAfter: ").append(getByCompleteAfter()).append(",");
if (getByCompleteBefore() != null)
sb.append("ByCompleteBefore: ").append(getByCompleteBefore()).append(",");
if (getByParentJobId() != null)
sb.append("ByParentJobId: ").append(getByParentJobId()).append(",");
if (getByMessageCategory() != null)
sb.append("ByMessageCategory: ").append(getByMessageCategory());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListBackupJobsRequest == false)
return false;
ListBackupJobsRequest other = (ListBackupJobsRequest) obj;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getByResourceArn() == null ^ this.getByResourceArn() == null)
return false;
if (other.getByResourceArn() != null && other.getByResourceArn().equals(this.getByResourceArn()) == false)
return false;
if (other.getByState() == null ^ this.getByState() == null)
return false;
if (other.getByState() != null && other.getByState().equals(this.getByState()) == false)
return false;
if (other.getByBackupVaultName() == null ^ this.getByBackupVaultName() == null)
return false;
if (other.getByBackupVaultName() != null && other.getByBackupVaultName().equals(this.getByBackupVaultName()) == false)
return false;
if (other.getByCreatedBefore() == null ^ this.getByCreatedBefore() == null)
return false;
if (other.getByCreatedBefore() != null && other.getByCreatedBefore().equals(this.getByCreatedBefore()) == false)
return false;
if (other.getByCreatedAfter() == null ^ this.getByCreatedAfter() == null)
return false;
if (other.getByCreatedAfter() != null && other.getByCreatedAfter().equals(this.getByCreatedAfter()) == false)
return false;
if (other.getByResourceType() == null ^ this.getByResourceType() == null)
return false;
if (other.getByResourceType() != null && other.getByResourceType().equals(this.getByResourceType()) == false)
return false;
if (other.getByAccountId() == null ^ this.getByAccountId() == null)
return false;
if (other.getByAccountId() != null && other.getByAccountId().equals(this.getByAccountId()) == false)
return false;
if (other.getByCompleteAfter() == null ^ this.getByCompleteAfter() == null)
return false;
if (other.getByCompleteAfter() != null && other.getByCompleteAfter().equals(this.getByCompleteAfter()) == false)
return false;
if (other.getByCompleteBefore() == null ^ this.getByCompleteBefore() == null)
return false;
if (other.getByCompleteBefore() != null && other.getByCompleteBefore().equals(this.getByCompleteBefore()) == false)
return false;
if (other.getByParentJobId() == null ^ this.getByParentJobId() == null)
return false;
if (other.getByParentJobId() != null && other.getByParentJobId().equals(this.getByParentJobId()) == false)
return false;
if (other.getByMessageCategory() == null ^ this.getByMessageCategory() == null)
return false;
if (other.getByMessageCategory() != null && other.getByMessageCategory().equals(this.getByMessageCategory()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getByResourceArn() == null) ? 0 : getByResourceArn().hashCode());
hashCode = prime * hashCode + ((getByState() == null) ? 0 : getByState().hashCode());
hashCode = prime * hashCode + ((getByBackupVaultName() == null) ? 0 : getByBackupVaultName().hashCode());
hashCode = prime * hashCode + ((getByCreatedBefore() == null) ? 0 : getByCreatedBefore().hashCode());
hashCode = prime * hashCode + ((getByCreatedAfter() == null) ? 0 : getByCreatedAfter().hashCode());
hashCode = prime * hashCode + ((getByResourceType() == null) ? 0 : getByResourceType().hashCode());
hashCode = prime * hashCode + ((getByAccountId() == null) ? 0 : getByAccountId().hashCode());
hashCode = prime * hashCode + ((getByCompleteAfter() == null) ? 0 : getByCompleteAfter().hashCode());
hashCode = prime * hashCode + ((getByCompleteBefore() == null) ? 0 : getByCompleteBefore().hashCode());
hashCode = prime * hashCode + ((getByParentJobId() == null) ? 0 : getByParentJobId().hashCode());
hashCode = prime * hashCode + ((getByMessageCategory() == null) ? 0 : getByMessageCategory().hashCode());
return hashCode;
}
@Override
public ListBackupJobsRequest clone() {
return (ListBackupJobsRequest) super.clone();
}
}