Class SearchScope

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

The search scope is all backup properties input into a search.

See Also:

  • Method Details

    • backupResourceTypes

      public final List<ResourceType> backupResourceTypes()

      The resource types included in a search.

      Eligible resource types include S3 and EBS.

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

      Returns:
      The resource types included in a search.

      Eligible resource types include S3 and EBS.

    • hasBackupResourceTypes

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

    • backupResourceTypesAsStrings

      public final List<String> backupResourceTypesAsStrings()

      The resource types included in a search.

      Eligible resource types include S3 and EBS.

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

      Returns:
      The resource types included in a search.

      Eligible resource types include S3 and EBS.

    • backupResourceCreationTime

      public final BackupCreationTimeFilter backupResourceCreationTime()

      This is the time a backup resource was created.

      Returns:
      This is the time a backup resource was created.

    • hasSourceResourceArns

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

    • sourceResourceArns

      public final List<String> sourceResourceArns()

      The Amazon Resource Name (ARN) that uniquely identifies the source resources.

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

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the source resources.

    • hasBackupResourceArns

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

    • backupResourceArns

      public final List<String> backupResourceArns()

      The Amazon Resource Name (ARN) that uniquely identifies the backup resources.

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

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the backup resources.

    • hasBackupResourceTags

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

    • backupResourceTags

      public final Map<String,String> backupResourceTags()

      These are one or more tags on the backup (recovery point).

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

      Returns:
      These are one or more tags on the backup (recovery point).

    • toBuilder

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

    • builder

      public static SearchScope.Builder builder()

    • serializableBuilderClass

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