Class ListSearchResultExportJobsRequest

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

  • Method Details

    • status

      public final ExportJobStatus status()

      The search jobs to be included in the export job can be filtered by including this parameter.

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

      Returns:
      The search jobs to be included in the export job can be filtered by including this parameter.
      See Also:

    • statusAsString

      public final String statusAsString()

      The search jobs to be included in the export job can be filtered by including this parameter.

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

      Returns:
      The search jobs to be included in the export job can be filtered by including this parameter.
      See Also:

    • searchJobIdentifier

      public final String searchJobIdentifier()

      The unique string that specifies the search job.

      Returns:
      The unique string that specifies the search job.

    • nextToken

      public final String nextToken()

      The next item following a partial list of returned backups included in a search job.

      For example, if a request is made to return MaxResults number of backups, 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 backups included in a search job.

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

    • maxResults

      public final Integer maxResults()

      The maximum number of resource list items to be returned.

      Returns:
      The maximum number of resource list items to be returned.

    • toBuilder

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

    • builder

      public static ListSearchResultExportJobsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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