Class BackupJobSummary

java.lang.Object
software.amazon.awssdk.services.backup.model.BackupJobSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BackupJobSummary.Builder,BackupJobSummary>
@Generated("software.amazon.awssdk:codegen") public final class BackupJobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BackupJobSummary.Builder,BackupJobSummary>

This is a summary of jobs created or running within the most recent 30 days.

The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

See Also:

  • Method Details

    • region

      public final String region()

      The Amazon Web Services Regions within the job summary.

      Returns:
      The Amazon Web Services Regions within the job summary.

    • accountId

      public final String accountId()

      The account ID that owns the jobs within the summary.

      Returns:
      The account ID that owns the jobs within the summary.

    • state

      public final BackupJobStatus state()

      This value is job count for jobs with the specified state.

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

      Returns:
      This value is job count for jobs with the specified state.
      See Also:

    • stateAsString

      public final String stateAsString()

      This value is job count for jobs with the specified state.

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

      Returns:
      This value is job count for jobs with the specified state.
      See Also:

    • resourceType

      public final String resourceType()

      This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

      Returns:
      This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

    • messageCategory

      public final String messageCategory()

      This parameter is the job count for the specified message category.

      Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

      The the value ANY returns count of all message categories.

      AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

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

      Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

      The the value ANY returns count of all message categories.

      AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

    • count

      public final Integer count()

      The value as a number of jobs in a job summary.

      Returns:
      The value as a number of jobs in a job summary.

    • startTime

      public final Instant startTime()

      The value of time in number format of a job start time.

      This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The value of time in number format of a job start time.

      This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • endTime

      public final Instant endTime()

      The value of time in number format of a job end time.

      This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The value of time in number format of a job end time.

      This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • toBuilder

      public BackupJobSummary.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<BackupJobSummary.Builder,BackupJobSummary>
      Returns:
      a builder for type T

    • builder

      public static BackupJobSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.