Package software.amazon.awssdk.services.secretsmanager.model

Class TagResourceRequest

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

  • Method Details

    • secretId

      public final String secretId()

      The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

      Returns:
      The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • 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()

      The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.

      For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

      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:
      The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.

      For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

    • toBuilder

      public TagResourceRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>
      Specified by:
      toBuilder in class SecretsManagerRequest

    • builder

      public static TagResourceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TagResourceRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo