Class StartSearchJobRequest

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

  • Method Details

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      List of tags returned by the operation.

      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 hasTags() method.

      Returns:
      List of tags returned by the operation.

    • name

      public final String name()

      Include alphanumeric characters to create a name for this search job.

      Returns:
      Include alphanumeric characters to create a name for this search job.

    • encryptionKeyArn

      public final String encryptionKeyArn()

      The encryption key for the specified search job.

      Returns:
      The encryption key for the specified search job.

    • clientToken

      public final String clientToken()

      Include this parameter to allow multiple identical calls for idempotency.

      A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

      Returns:
      Include this parameter to allow multiple identical calls for idempotency.

      A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

    • searchScope

      public final SearchScope searchScope()

      This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.

      Returns:
      This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.

    • itemFilters

      public final ItemFilters itemFilters()

      Item Filters represent all input item properties specified when the search was created.

      Contains either EBSItemFilters or S3ItemFilters

      Returns:
      Item Filters represent all input item properties specified when the search was created.

      Contains either EBSItemFilters or S3ItemFilters

    • toBuilder

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

    • builder

      public static StartSearchJobRequest.Builder builder()

    • serializableBuilderClass

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