Package software.amazon.awssdk.services.backup.model

Class DescribeBackupJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.backup.model.BackupResponse
software.amazon.awssdk.services.backup.model.DescribeBackupJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeBackupJobResponse.Builder,DescribeBackupJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeBackupJobResponse extends BackupResponse implements ToCopyableBuilder<DescribeBackupJobResponse.Builder,DescribeBackupJobResponse>

  • Method Details

    • accountId

      public final String accountId()

      Returns the account ID that owns the backup job.

      Returns:
      Returns the account ID that owns the backup job.

    • backupJobId

      public final String backupJobId()

      Uniquely identifies a request to Backup to back up a resource.

      Returns:
      Uniquely identifies a request to Backup to back up a resource.

    • backupVaultName

      public final String 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.

      Returns:
      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.

    • backupVaultArn

      public final String backupVaultArn()

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    • recoveryPointArn

      public final String 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.

      Returns:
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • resourceArn

      public final String resourceArn()

      An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

      Returns:
      An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

    • creationDate

      public final Instant 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.

      Returns:
      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.

    • completionDate

      public final Instant 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.

      Returns:
      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.

    • state

      public final BackupJobState state()

      The current state of a backup job.

      If the service returns an enum value that is not available in the current SDK version, state will return BackupJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of a backup job.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of a backup job.

      If the service returns an enum value that is not available in the current SDK version, state will return BackupJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of a backup job.
      See Also:

    • statusMessage

      public final String statusMessage()

      A detailed message explaining the status of the job to back up a resource.

      Returns:
      A detailed message explaining the status of the job to back up a resource.

    • percentDone

      public final String percentDone()

      Contains an estimated percentage that is complete of a job at the time the job status was queried.

      Returns:
      Contains an estimated percentage that is complete of a job at the time the job status was queried.

    • backupSizeInBytes

      public final Long backupSizeInBytes()

      The size, in bytes, of a backup.

      Returns:
      The size, in bytes, of a backup.

    • iamRoleArn

      public final String iamRoleArn()

      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      Returns:
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • createdBy

      public final RecoveryPointCreator 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.

      Returns:
      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.

    • resourceType

      public final String 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.

      Returns:
      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.

    • bytesTransferred

      public final Long bytesTransferred()

      The size in bytes transferred to a backup vault at the time that the job status was queried.

      Returns:
      The size in bytes transferred to a backup vault at the time that the job status was queried.

    • expectedCompletionDate

      public final Instant 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.

      Returns:
      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.

    • startBy

      public final Instant 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.

      Returns:
      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.

    • hasBackupOptions

      public final boolean hasBackupOptions()
      For responses, this returns true if the service returned a value for the BackupOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • backupOptions

      public final Map<String,String> backupOptions()

      Represents the options specified as part of backup plan or on-demand backup job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBackupOptions() method.

      Returns:
      Represents the options specified as part of backup plan or on-demand backup job.

    • backupType

      public final String 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.

      Returns:
      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.

    • parentJobId

      public final String parentJobId()

      This returns the parent (composite) resource backup job ID.

      Returns:
      This returns the parent (composite) resource backup job ID.

    • isParent

      public final Boolean isParent()

      This returns the boolean value that a backup job is a parent (composite) job.

      Returns:
      This returns the boolean value that a backup job is a parent (composite) job.

    • numberOfChildJobs

      public final Long numberOfChildJobs()

      This returns the number of child (nested) backup jobs.

      Returns:
      This returns the number of child (nested) backup jobs.

    • childJobsInState

      public final Map<BackupJobState,Long> childJobsInState()

      This returns the statistics of the included child (nested) backup jobs.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChildJobsInState() method.

      Returns:
      This returns the statistics of the included child (nested) backup jobs.

    • hasChildJobsInState

      public final boolean hasChildJobsInState()
      For responses, this returns true if the service returned a value for the ChildJobsInState property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • childJobsInStateAsStrings

      public final Map<String,Long> childJobsInStateAsStrings()

      This returns the statistics of the included child (nested) backup jobs.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChildJobsInState() method.

      Returns:
      This returns the statistics of the included child (nested) backup jobs.

    • resourceName

      public final String resourceName()

      This is the non-unique name of the resource that belongs to the specified backup.

      Returns:
      This is the non-unique name of the resource that belongs to the specified backup.

    • initiationDate

      public final Instant initiationDate()

      This is the date a backup job was initiated.

      Returns:
      This is the date a backup job was initiated.

    • messageCategory

      public final String messageCategory()

      This is the job count for the specified message category.

      Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.

      Returns:
      This is the job count for the specified message category.

      Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.

    • toBuilder

      public DescribeBackupJobResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeBackupJobResponse.Builder,DescribeBackupJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeBackupJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeBackupJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.