Class ListRestoreJobSummariesRequest

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

  • Method Details

    • accountId

      public final String accountId()

      Returns the job count for the specified account.

      If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

      Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

      AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

      Returns:
      Returns the job count for the specified account.

      If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

      Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

      AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

    • state

      public final RestoreJobState state()

      This parameter returns the job count for jobs with the specified state.

      The the value ANY returns count of all states.

      AGGREGATE_ALL aggregates job counts for all states and returns the sum.

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

      Returns:
      This parameter returns the job count for jobs with the specified state.

      The the value ANY returns count of all states.

      AGGREGATE_ALL aggregates job counts for all states and returns the sum.

      See Also:

    • stateAsString

      public final String stateAsString()

      This parameter returns the job count for jobs with the specified state.

      The the value ANY returns count of all states.

      AGGREGATE_ALL aggregates job counts for all states and returns the sum.

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

      Returns:
      This parameter returns the job count for jobs with the specified state.

      The the value ANY returns count of all states.

      AGGREGATE_ALL aggregates job counts for all states and returns the sum.

      See Also:

    • resourceType

      public final String resourceType()

      Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

      The the value ANY returns count of all resource types.

      AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

      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:
      Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

      The the value ANY returns count of all resource types.

      AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

      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.

    • aggregationPeriod

      public final AggregationPeriod aggregationPeriod()

      The period for the returned results.

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

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

      • FOURTEEN_DAYS - The aggregated job count for prior 14 days.

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

      Returns:
      The period for the returned results.

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

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

      • FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      See Also:

    • aggregationPeriodAsString

      public final String aggregationPeriodAsString()

      The period for the returned results.

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

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

      • FOURTEEN_DAYS - The aggregated job count for prior 14 days.

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

      Returns:
      The period for the returned results.

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

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

      • FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      See Also:

    • maxResults

      public final Integer maxResults()

      This parameter sets the maximum number of items to be returned.

      The value is an integer. Range of accepted values is from 1 to 500.

      Returns:
      This parameter sets the maximum number of items to be returned.

      The value is an integer. Range of accepted values is from 1 to 500.

    • 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 ListRestoreJobSummariesRequest.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<ListRestoreJobSummariesRequest.Builder,ListRestoreJobSummariesRequest>
      Specified by:
      toBuilder in class BackupRequest
      Returns:
      a builder for type T

    • builder

      public static ListRestoreJobSummariesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.