@Generated(value="software.amazon.awssdk:codegen") public final class TagResourceRequest extends SecretsManagerRequest implements ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
TagResourceRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static TagResourceRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
List<SdkField<?>> |
sdkFields() |
String |
secretId()
The identifier for the secret that you want to attach tags to.
|
static Class<? extends TagResourceRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The tags to attach to the secret.
|
TagResourceRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String secretId()
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.
If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.
If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.
public final boolean hasTags()
public final List<Tag> tags()
The tags to attach to the secret. Each element in the list consists of a Key and a
Value.
This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter
for the various command line tool environments, see Using JSON for
Parameters in the AWS CLI User Guide. For the AWS CLI, you can also use the syntax:
--Tags Key="Key1",Value="Value1" Key="Key2",Value="Value2"[,…]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags() to see if a value was sent in this field.
Key and a
Value.
This parameter to the API requires a JSON text string argument. For information on how to format a JSON
parameter for the various command line tool environments, see Using
JSON for Parameters in the AWS CLI User Guide. For the AWS CLI, you can also use the syntax:
--Tags Key="Key1",Value="Value1" Key="Key2",Value="Value2"[,…]
public TagResourceRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>toBuilder in class SecretsManagerRequestpublic static TagResourceRequest.Builder builder()
public static Class<? extends TagResourceRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.