com.amazonaws.services.backup.model.DescribeBackupJobResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-backup Show documentation
/*
* Copyright 2017-2022 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeBackupJobResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Returns the account ID that owns the backup job.
*
*/
private String accountId;
/**
*
* Uniquely identifies a request to Backup to back up a resource.
*
*/
private String backupJobId;
/**
*
* The name of a logical container where backups are stored. 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 backupVaultName;
/**
*
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
* arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*
*/
private String backupVaultArn;
/**
*
* An ARN that uniquely identifies a recovery point; for example,
* arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*
*/
private String recoveryPointArn;
/**
*
* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
*
*/
private String resourceArn;
/**
*
* The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
* CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
* January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date creationDate;
/**
*
* The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time
* (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
* 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date completionDate;
/**
*
* The current state of a resource recovery point.
*
*/
private String state;
/**
*
* A detailed message explaining the status of the job to back up a resource.
*
*/
private String statusMessage;
/**
*
* Contains an estimated percentage that is complete of a job at the time the job status was queried.
*
*/
private String percentDone;
/**
*
* The size, in bytes, of a backup.
*
*/
private Long backupSizeInBytes;
/**
*
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access.
*
*/
private String iamRoleArn;
/**
*
* Contains identifying information about the creation of a backup job, including the BackupPlanArn,
* BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that
* is used to create it.
*
*/
private RecoveryPointCreator createdBy;
/**
*
* The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS)
* volume or an Amazon Relational Database Service (Amazon RDS) database.
*
*/
private String resourceType;
/**
*
* The size in bytes transferred to a backup vault at the time that the job status was queried.
*
*/
private Long bytesTransferred;
/**
*
* The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated
* Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example,
* the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date expectedCompletionDate;
/**
*
* Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before
* it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled
* time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date
* specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date startBy;
/**
*
* Represents the options specified as part of backup plan or on-demand backup job.
*
*/
private java.util.Map backupOptions;
/**
*
* Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow
* Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If
* BackupType is empty, then the backup type was a regular backup.
*
*/
private String backupType;
/**
*
* Returns the account ID that owns the backup job.
*
*
* @param accountId
* Returns the account ID that owns the backup job.
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
*
* Returns the account ID that owns the backup job.
*
*
* @return Returns the account ID that owns the backup job.
*/
public String getAccountId() {
return this.accountId;
}
/**
*
* Returns the account ID that owns the backup job.
*
*
* @param accountId
* Returns the account ID that owns the backup job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withAccountId(String accountId) {
setAccountId(accountId);
return this;
}
/**
*
* Uniquely identifies a request to Backup to back up a resource.
*
*
* @param backupJobId
* Uniquely identifies a request to Backup to back up a resource.
*/
public void setBackupJobId(String backupJobId) {
this.backupJobId = backupJobId;
}
/**
*
* Uniquely identifies a request to Backup to back up a resource.
*
*
* @return Uniquely identifies a request to Backup to back up a resource.
*/
public String getBackupJobId() {
return this.backupJobId;
}
/**
*
* Uniquely identifies a request to Backup to back up a resource.
*
*
* @param backupJobId
* Uniquely identifies a request to Backup to back up a resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withBackupJobId(String backupJobId) {
setBackupJobId(backupJobId);
return this;
}
/**
*
* The name of a logical container where backups are stored. 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 backupVaultName
* The name of a logical container where backups are stored. 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 setBackupVaultName(String backupVaultName) {
this.backupVaultName = backupVaultName;
}
/**
*
* The name of a logical container where backups are stored. 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 The name of a logical container where backups are stored. 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 getBackupVaultName() {
return this.backupVaultName;
}
/**
*
* The name of a logical container where backups are stored. 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 backupVaultName
* The name of a logical container where backups are stored. 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 DescribeBackupJobResult withBackupVaultName(String backupVaultName) {
setBackupVaultName(backupVaultName);
return this;
}
/**
*
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
* arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*
*
* @param backupVaultArn
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
* arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
public void setBackupVaultArn(String backupVaultArn) {
this.backupVaultArn = backupVaultArn;
}
/**
*
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
* arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*
*
* @return An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
* arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
public String getBackupVaultArn() {
return this.backupVaultArn;
}
/**
*
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
* arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*
*
* @param backupVaultArn
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
* arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withBackupVaultArn(String backupVaultArn) {
setBackupVaultArn(backupVaultArn);
return this;
}
/**
*
* An ARN that uniquely identifies a recovery point; for example,
* arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*
*
* @param recoveryPointArn
* An ARN that uniquely identifies a recovery point; for example,
* arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
public void setRecoveryPointArn(String recoveryPointArn) {
this.recoveryPointArn = recoveryPointArn;
}
/**
*
* An ARN that uniquely identifies a recovery point; for example,
* arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*
*
* @return An ARN that uniquely identifies a recovery point; for example,
* arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
public String getRecoveryPointArn() {
return this.recoveryPointArn;
}
/**
*
* An ARN that uniquely identifies a recovery point; for example,
* arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*
*
* @param recoveryPointArn
* An ARN that uniquely identifies a recovery point; for example,
* arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withRecoveryPointArn(String recoveryPointArn) {
setRecoveryPointArn(recoveryPointArn);
return this;
}
/**
*
* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
*
*
* @param resourceArn
* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
*/
public void setResourceArn(String resourceArn) {
this.resourceArn = resourceArn;
}
/**
*
* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
*
*
* @return An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
*/
public String getResourceArn() {
return this.resourceArn;
}
/**
*
* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
*
*
* @param resourceArn
* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withResourceArn(String resourceArn) {
setResourceArn(resourceArn);
return this;
}
/**
*
* The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
* CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
* January 26, 2018 12:11:30.087 AM.
*
*
* @param creationDate
* The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The
* value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setCreationDate(java.util.Date creationDate) {
this.creationDate = creationDate;
}
/**
*
* The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
* CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
* January 26, 2018 12:11:30.087 AM.
*
*
* @return The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The
* value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getCreationDate() {
return this.creationDate;
}
/**
*
* The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
* CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
* January 26, 2018 12:11:30.087 AM.
*
*
* @param creationDate
* The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The
* value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withCreationDate(java.util.Date creationDate) {
setCreationDate(creationDate);
return this;
}
/**
*
* The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time
* (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
* 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param completionDate
* The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal
* Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
* 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setCompletionDate(java.util.Date completionDate) {
this.completionDate = completionDate;
}
/**
*
* The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time
* (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
* 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @return The date and time that a job to create a backup job is completed, in Unix format and Coordinated
* Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example,
* the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getCompletionDate() {
return this.completionDate;
}
/**
*
* The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time
* (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
* 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param completionDate
* The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal
* Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
* 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withCompletionDate(java.util.Date completionDate) {
setCompletionDate(completionDate);
return this;
}
/**
*
* The current state of a resource recovery point.
*
*
* @param state
* The current state of a resource recovery point.
* @see BackupJobState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The current state of a resource recovery point.
*
*
* @return The current state of a resource recovery point.
* @see BackupJobState
*/
public String getState() {
return this.state;
}
/**
*
* The current state of a resource recovery point.
*
*
* @param state
* The current state of a resource recovery point.
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupJobState
*/
public DescribeBackupJobResult withState(String state) {
setState(state);
return this;
}
/**
*
* The current state of a resource recovery point.
*
*
* @param state
* The current state of a resource recovery point.
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupJobState
*/
public DescribeBackupJobResult withState(BackupJobState state) {
this.state = state.toString();
return this;
}
/**
*
* A detailed message explaining the status of the job to back up a resource.
*
*
* @param statusMessage
* A detailed message explaining the status of the job to back up a resource.
*/
public void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
/**
*
* A detailed message explaining the status of the job to back up a resource.
*
*
* @return A detailed message explaining the status of the job to back up a resource.
*/
public String getStatusMessage() {
return this.statusMessage;
}
/**
*
* A detailed message explaining the status of the job to back up a resource.
*
*
* @param statusMessage
* A detailed message explaining the status of the job to back up a resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withStatusMessage(String statusMessage) {
setStatusMessage(statusMessage);
return this;
}
/**
*
* Contains an estimated percentage that is complete of a job at the time the job status was queried.
*
*
* @param percentDone
* Contains an estimated percentage that is complete of a job at the time the job status was queried.
*/
public void setPercentDone(String percentDone) {
this.percentDone = percentDone;
}
/**
*
* Contains an estimated percentage that is complete of a job at the time the job status was queried.
*
*
* @return Contains an estimated percentage that is complete of a job at the time the job status was queried.
*/
public String getPercentDone() {
return this.percentDone;
}
/**
*
* Contains an estimated percentage that is complete of a job at the time the job status was queried.
*
*
* @param percentDone
* Contains an estimated percentage that is complete of a job at the time the job status was queried.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withPercentDone(String percentDone) {
setPercentDone(percentDone);
return this;
}
/**
*
* The size, in bytes, of a backup.
*
*
* @param backupSizeInBytes
* The size, in bytes, of a backup.
*/
public void setBackupSizeInBytes(Long backupSizeInBytes) {
this.backupSizeInBytes = backupSizeInBytes;
}
/**
*
* The size, in bytes, of a backup.
*
*
* @return The size, in bytes, of a backup.
*/
public Long getBackupSizeInBytes() {
return this.backupSizeInBytes;
}
/**
*
* The size, in bytes, of a backup.
*
*
* @param backupSizeInBytes
* The size, in bytes, of a backup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withBackupSizeInBytes(Long backupSizeInBytes) {
setBackupSizeInBytes(backupSizeInBytes);
return this;
}
/**
*
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access.
*
*
* @param iamRoleArn
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access.
*/
public void setIamRoleArn(String iamRoleArn) {
this.iamRoleArn = iamRoleArn;
}
/**
*
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access.
*
*
* @return Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access.
*/
public String getIamRoleArn() {
return this.iamRoleArn;
}
/**
*
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access.
*
*
* @param iamRoleArn
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withIamRoleArn(String iamRoleArn) {
setIamRoleArn(iamRoleArn);
return this;
}
/**
*
* Contains identifying information about the creation of a backup job, including the BackupPlanArn,
* BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that
* is used to create it.
*
*
* @param createdBy
* Contains identifying information about the creation of a backup job, including the
* BackupPlanArn, BackupPlanId, BackupPlanVersion, and
* BackupRuleId of the backup plan that is used to create it.
*/
public void setCreatedBy(RecoveryPointCreator createdBy) {
this.createdBy = createdBy;
}
/**
*
* Contains identifying information about the creation of a backup job, including the BackupPlanArn,
* BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that
* is used to create it.
*
*
* @return Contains identifying information about the creation of a backup job, including the
* BackupPlanArn, BackupPlanId, BackupPlanVersion, and
* BackupRuleId of the backup plan that is used to create it.
*/
public RecoveryPointCreator getCreatedBy() {
return this.createdBy;
}
/**
*
* Contains identifying information about the creation of a backup job, including the BackupPlanArn,
* BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that
* is used to create it.
*
*
* @param createdBy
* Contains identifying information about the creation of a backup job, including the
* BackupPlanArn, BackupPlanId, BackupPlanVersion, and
* BackupRuleId of the backup plan that is used to create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withCreatedBy(RecoveryPointCreator createdBy) {
setCreatedBy(createdBy);
return this;
}
/**
*
* The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS)
* volume or an Amazon Relational Database Service (Amazon RDS) database.
*
*
* @param resourceType
* The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store
* (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
public void setResourceType(String resourceType) {
this.resourceType = resourceType;
}
/**
*
* The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS)
* volume or an Amazon Relational Database Service (Amazon RDS) database.
*
*
* @return The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store
* (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
public String getResourceType() {
return this.resourceType;
}
/**
*
* The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS)
* volume or an Amazon Relational Database Service (Amazon RDS) database.
*
*
* @param resourceType
* The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store
* (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withResourceType(String resourceType) {
setResourceType(resourceType);
return this;
}
/**
*
* The size in bytes transferred to a backup vault at the time that the job status was queried.
*
*
* @param bytesTransferred
* The size in bytes transferred to a backup vault at the time that the job status was queried.
*/
public void setBytesTransferred(Long bytesTransferred) {
this.bytesTransferred = bytesTransferred;
}
/**
*
* The size in bytes transferred to a backup vault at the time that the job status was queried.
*
*
* @return The size in bytes transferred to a backup vault at the time that the job status was queried.
*/
public Long getBytesTransferred() {
return this.bytesTransferred;
}
/**
*
* The size in bytes transferred to a backup vault at the time that the job status was queried.
*
*
* @param bytesTransferred
* The size in bytes transferred to a backup vault at the time that the job status was queried.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withBytesTransferred(Long bytesTransferred) {
setBytesTransferred(bytesTransferred);
return this;
}
/**
*
* The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated
* Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example,
* the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param expectedCompletionDate
* The date and time that a job to back up resources is expected to be completed, in Unix format and
* Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setExpectedCompletionDate(java.util.Date expectedCompletionDate) {
this.expectedCompletionDate = expectedCompletionDate;
}
/**
*
* The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated
* Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example,
* the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @return The date and time that a job to back up resources is expected to be completed, in Unix format and
* Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getExpectedCompletionDate() {
return this.expectedCompletionDate;
}
/**
*
* The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated
* Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example,
* the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param expectedCompletionDate
* The date and time that a job to back up resources is expected to be completed, in Unix format and
* Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withExpectedCompletionDate(java.util.Date expectedCompletionDate) {
setExpectedCompletionDate(expectedCompletionDate);
return this;
}
/**
*
* Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before
* it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled
* time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date
* specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param startBy
* Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started
* before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the
* scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00
* PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the
* value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setStartBy(java.util.Date startBy) {
this.startBy = startBy;
}
/**
*
* Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before
* it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled
* time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date
* specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @return Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started
* before it is canceled. The value is calculated by adding the start window to the scheduled time. So if
* the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be
* 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getStartBy() {
return this.startBy;
}
/**
*
* Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before
* it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled
* time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date
* specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param startBy
* Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started
* before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the
* scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00
* PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the
* value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withStartBy(java.util.Date startBy) {
setStartBy(startBy);
return this;
}
/**
*
* Represents the options specified as part of backup plan or on-demand backup job.
*
*
* @return Represents the options specified as part of backup plan or on-demand backup job.
*/
public java.util.Map getBackupOptions() {
return backupOptions;
}
/**
*
* Represents the options specified as part of backup plan or on-demand backup job.
*
*
* @param backupOptions
* Represents the options specified as part of backup plan or on-demand backup job.
*/
public void setBackupOptions(java.util.Map backupOptions) {
this.backupOptions = backupOptions;
}
/**
*
* Represents the options specified as part of backup plan or on-demand backup job.
*
*
* @param backupOptions
* Represents the options specified as part of backup plan or on-demand backup job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withBackupOptions(java.util.Map backupOptions) {
setBackupOptions(backupOptions);
return this;
}
/**
* Add a single BackupOptions entry
*
* @see DescribeBackupJobResult#withBackupOptions
* @returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult addBackupOptionsEntry(String key, String value) {
if (null == this.backupOptions) {
this.backupOptions = new java.util.HashMap();
}
if (this.backupOptions.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.backupOptions.put(key, value);
return this;
}
/**
* Removes all the entries added into BackupOptions.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult clearBackupOptionsEntries() {
this.backupOptions = null;
return this;
}
/**
*
* Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow
* Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If
* BackupType is empty, then the backup type was a regular backup.
*
*
* @param backupType
* Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume
* Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If
* BackupType is empty, then the backup type was a regular backup.
*/
public void setBackupType(String backupType) {
this.backupType = backupType;
}
/**
*
* Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow
* Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If
* BackupType is empty, then the backup type was a regular backup.
*
*
* @return Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume
* Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If
* BackupType is empty, then the backup type was a regular backup.
*/
public String getBackupType() {
return this.backupType;
}
/**
*
* Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow
* Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If
* BackupType is empty, then the backup type was a regular backup.
*
*
* @param backupType
* Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume
* Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If
* BackupType is empty, then the backup type was a regular backup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBackupJobResult withBackupType(String backupType) {
setBackupType(backupType);
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 (getAccountId() != null)
sb.append("AccountId: ").append(getAccountId()).append(",");
if (getBackupJobId() != null)
sb.append("BackupJobId: ").append(getBackupJobId()).append(",");
if (getBackupVaultName() != null)
sb.append("BackupVaultName: ").append(getBackupVaultName()).append(",");
if (getBackupVaultArn() != null)
sb.append("BackupVaultArn: ").append(getBackupVaultArn()).append(",");
if (getRecoveryPointArn() != null)
sb.append("RecoveryPointArn: ").append(getRecoveryPointArn()).append(",");
if (getResourceArn() != null)
sb.append("ResourceArn: ").append(getResourceArn()).append(",");
if (getCreationDate() != null)
sb.append("CreationDate: ").append(getCreationDate()).append(",");
if (getCompletionDate() != null)
sb.append("CompletionDate: ").append(getCompletionDate()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getStatusMessage() != null)
sb.append("StatusMessage: ").append(getStatusMessage()).append(",");
if (getPercentDone() != null)
sb.append("PercentDone: ").append(getPercentDone()).append(",");
if (getBackupSizeInBytes() != null)
sb.append("BackupSizeInBytes: ").append(getBackupSizeInBytes()).append(",");
if (getIamRoleArn() != null)
sb.append("IamRoleArn: ").append(getIamRoleArn()).append(",");
if (getCreatedBy() != null)
sb.append("CreatedBy: ").append(getCreatedBy()).append(",");
if (getResourceType() != null)
sb.append("ResourceType: ").append(getResourceType()).append(",");
if (getBytesTransferred() != null)
sb.append("BytesTransferred: ").append(getBytesTransferred()).append(",");
if (getExpectedCompletionDate() != null)
sb.append("ExpectedCompletionDate: ").append(getExpectedCompletionDate()).append(",");
if (getStartBy() != null)
sb.append("StartBy: ").append(getStartBy()).append(",");
if (getBackupOptions() != null)
sb.append("BackupOptions: ").append(getBackupOptions()).append(",");
if (getBackupType() != null)
sb.append("BackupType: ").append(getBackupType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeBackupJobResult == false)
return false;
DescribeBackupJobResult other = (DescribeBackupJobResult) obj;
if (other.getAccountId() == null ^ this.getAccountId() == null)
return false;
if (other.getAccountId() != null && other.getAccountId().equals(this.getAccountId()) == false)
return false;
if (other.getBackupJobId() == null ^ this.getBackupJobId() == null)
return false;
if (other.getBackupJobId() != null && other.getBackupJobId().equals(this.getBackupJobId()) == false)
return false;
if (other.getBackupVaultName() == null ^ this.getBackupVaultName() == null)
return false;
if (other.getBackupVaultName() != null && other.getBackupVaultName().equals(this.getBackupVaultName()) == false)
return false;
if (other.getBackupVaultArn() == null ^ this.getBackupVaultArn() == null)
return false;
if (other.getBackupVaultArn() != null && other.getBackupVaultArn().equals(this.getBackupVaultArn()) == false)
return false;
if (other.getRecoveryPointArn() == null ^ this.getRecoveryPointArn() == null)
return false;
if (other.getRecoveryPointArn() != null && other.getRecoveryPointArn().equals(this.getRecoveryPointArn()) == false)
return false;
if (other.getResourceArn() == null ^ this.getResourceArn() == null)
return false;
if (other.getResourceArn() != null && other.getResourceArn().equals(this.getResourceArn()) == false)
return false;
if (other.getCreationDate() == null ^ this.getCreationDate() == null)
return false;
if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false)
return false;
if (other.getCompletionDate() == null ^ this.getCompletionDate() == null)
return false;
if (other.getCompletionDate() != null && other.getCompletionDate().equals(this.getCompletionDate()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getStatusMessage() == null ^ this.getStatusMessage() == null)
return false;
if (other.getStatusMessage() != null && other.getStatusMessage().equals(this.getStatusMessage()) == false)
return false;
if (other.getPercentDone() == null ^ this.getPercentDone() == null)
return false;
if (other.getPercentDone() != null && other.getPercentDone().equals(this.getPercentDone()) == false)
return false;
if (other.getBackupSizeInBytes() == null ^ this.getBackupSizeInBytes() == null)
return false;
if (other.getBackupSizeInBytes() != null && other.getBackupSizeInBytes().equals(this.getBackupSizeInBytes()) == false)
return false;
if (other.getIamRoleArn() == null ^ this.getIamRoleArn() == null)
return false;
if (other.getIamRoleArn() != null && other.getIamRoleArn().equals(this.getIamRoleArn()) == false)
return false;
if (other.getCreatedBy() == null ^ this.getCreatedBy() == null)
return false;
if (other.getCreatedBy() != null && other.getCreatedBy().equals(this.getCreatedBy()) == false)
return false;
if (other.getResourceType() == null ^ this.getResourceType() == null)
return false;
if (other.getResourceType() != null && other.getResourceType().equals(this.getResourceType()) == false)
return false;
if (other.getBytesTransferred() == null ^ this.getBytesTransferred() == null)
return false;
if (other.getBytesTransferred() != null && other.getBytesTransferred().equals(this.getBytesTransferred()) == false)
return false;
if (other.getExpectedCompletionDate() == null ^ this.getExpectedCompletionDate() == null)
return false;
if (other.getExpectedCompletionDate() != null && other.getExpectedCompletionDate().equals(this.getExpectedCompletionDate()) == false)
return false;
if (other.getStartBy() == null ^ this.getStartBy() == null)
return false;
if (other.getStartBy() != null && other.getStartBy().equals(this.getStartBy()) == false)
return false;
if (other.getBackupOptions() == null ^ this.getBackupOptions() == null)
return false;
if (other.getBackupOptions() != null && other.getBackupOptions().equals(this.getBackupOptions()) == false)
return false;
if (other.getBackupType() == null ^ this.getBackupType() == null)
return false;
if (other.getBackupType() != null && other.getBackupType().equals(this.getBackupType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccountId() == null) ? 0 : getAccountId().hashCode());
hashCode = prime * hashCode + ((getBackupJobId() == null) ? 0 : getBackupJobId().hashCode());
hashCode = prime * hashCode + ((getBackupVaultName() == null) ? 0 : getBackupVaultName().hashCode());
hashCode = prime * hashCode + ((getBackupVaultArn() == null) ? 0 : getBackupVaultArn().hashCode());
hashCode = prime * hashCode + ((getRecoveryPointArn() == null) ? 0 : getRecoveryPointArn().hashCode());
hashCode = prime * hashCode + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode());
hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode());
hashCode = prime * hashCode + ((getCompletionDate() == null) ? 0 : getCompletionDate().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getStatusMessage() == null) ? 0 : getStatusMessage().hashCode());
hashCode = prime * hashCode + ((getPercentDone() == null) ? 0 : getPercentDone().hashCode());
hashCode = prime * hashCode + ((getBackupSizeInBytes() == null) ? 0 : getBackupSizeInBytes().hashCode());
hashCode = prime * hashCode + ((getIamRoleArn() == null) ? 0 : getIamRoleArn().hashCode());
hashCode = prime * hashCode + ((getCreatedBy() == null) ? 0 : getCreatedBy().hashCode());
hashCode = prime * hashCode + ((getResourceType() == null) ? 0 : getResourceType().hashCode());
hashCode = prime * hashCode + ((getBytesTransferred() == null) ? 0 : getBytesTransferred().hashCode());
hashCode = prime * hashCode + ((getExpectedCompletionDate() == null) ? 0 : getExpectedCompletionDate().hashCode());
hashCode = prime * hashCode + ((getStartBy() == null) ? 0 : getStartBy().hashCode());
hashCode = prime * hashCode + ((getBackupOptions() == null) ? 0 : getBackupOptions().hashCode());
hashCode = prime * hashCode + ((getBackupType() == null) ? 0 : getBackupType().hashCode());
return hashCode;
}
@Override
public DescribeBackupJobResult clone() {
try {
return (DescribeBackupJobResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}