Package software.amazon.awssdk.services.storagegateway.model

Class CreateTapePoolRequest

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

  • Method Details

    • poolName

      public final String poolName()

      The name of the new custom tape pool.

      Returns:
      The name of the new custom tape pool.

    • storageClass

      public final TapeStorageClass storageClass()

      The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

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

      Returns:
      The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
      See Also:

    • storageClassAsString

      public final String storageClassAsString()

      The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

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

      Returns:
      The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
      See Also:

    • retentionLockType

      public final RetentionLockType retentionLockType()

      Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

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

      Returns:
      Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
      See Also:

    • retentionLockTypeAsString

      public final String retentionLockTypeAsString()

      Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

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

      Returns:
      Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
      See Also:

    • retentionLockTimeInDays

      public final Integer retentionLockTimeInDays()

      Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

      Returns:
      Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

    • 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 List<Tag> tags()

      A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

      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:
      A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    • toBuilder

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

    • builder

      public static CreateTapePoolRequest.Builder builder()

    • serializableBuilderClass

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