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

Class ListCopyJobSummariesResponse

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.ListCopyJobSummariesResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListCopyJobSummariesResponse.Builder,ListCopyJobSummariesResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListCopyJobSummariesResponse extends BackupResponse implements ToCopyableBuilder<ListCopyJobSummariesResponse.Builder,ListCopyJobSummariesResponse>

  • Method Details

    • hasCopyJobSummaries

      public final boolean hasCopyJobSummaries()
      For responses, this returns true if the service returned a value for the CopyJobSummaries 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.

    • copyJobSummaries

      public final List<CopyJobSummary> copyJobSummaries()

      This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included 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 hasCopyJobSummaries() method.

      Returns:
      This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

    • aggregationPeriod

      public final String aggregationPeriod()

      This is the period that sets the boundaries for returned results.

      • ONE_DAY for daily job count for the prior 14 days.

      • SEVEN_DAYS for the aggregated job count for the prior 7 days.

      • FOURTEEN_DAYS for aggregated job count for prior 14 days.

      Returns:
      This is the period that sets the boundaries for returned results.

      • ONE_DAY for daily job count for the prior 14 days.

      • SEVEN_DAYS for the aggregated job count for the prior 7 days.

      • FOURTEEN_DAYS for aggregated job count for prior 14 days.

    • nextToken

      public final String nextToken()

      The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      Returns:
      The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • toBuilder

      public ListCopyJobSummariesResponse.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<ListCopyJobSummariesResponse.Builder,ListCopyJobSummariesResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static ListCopyJobSummariesResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListCopyJobSummariesResponse.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.