@Generated(value="software.amazon.awssdk:codegen") public final class AddTagsToResourceRequest extends SsmRequest implements ToCopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
AddTagsToResourceRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static AddTagsToResourceRequest.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()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
resourceId()
The resource ID you want to tag.
|
ResourceTypeForTagging |
resourceType()
Specifies the type of resource you are tagging.
|
String |
resourceTypeAsString()
Specifies the type of resource you are tagging.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AddTagsToResourceRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
One or more tags.
|
AddTagsToResourceRequest.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 ResourceTypeForTagging resourceType()
Specifies the type of resource you are tagging.
The ManagedInstance type for this API operation is for on-premises managed instances. You must
specify the name of the managed instance in the following format: mi-ID_number . For example,
mi-1a2b3c4d5e6f.
If the service returns an enum value that is not available in the current SDK version, resourceType will
return ResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from resourceTypeAsString().
The ManagedInstance type for this API operation is for on-premises managed instances. You
must specify the name of the managed instance in the following format: mi-ID_number .
For example, mi-1a2b3c4d5e6f.
ResourceTypeForTaggingpublic final String resourceTypeAsString()
Specifies the type of resource you are tagging.
The ManagedInstance type for this API operation is for on-premises managed instances. You must
specify the name of the managed instance in the following format: mi-ID_number . For example,
mi-1a2b3c4d5e6f.
If the service returns an enum value that is not available in the current SDK version, resourceType will
return ResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from resourceTypeAsString().
The ManagedInstance type for this API operation is for on-premises managed instances. You
must specify the name of the managed instance in the following format: mi-ID_number .
For example, mi-1a2b3c4d5e6f.
ResourceTypeForTaggingpublic final String resourceId()
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name
(ARN) for the object. Specifically, ResourceID is created from the strings that come after the word
opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of
arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a
ResourceID of either aws/ssm/MyGroup/appmanager or
/aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
ManagedInstance: mi-012345abcde
The ManagedInstance type for this API operation is only for on-premises managed instances. You must
specify the name of the managed instance in the following format: mi-ID_number . For example,
mi-1a2b3c4d5e6f.
Use the ID of the resource. Here are some examples:
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource
Name (ARN) for the object. Specifically, ResourceID is created from the strings that come
after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of
arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a
ResourceID of either aws/ssm/MyGroup/appmanager or
/aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
ManagedInstance: mi-012345abcde
The ManagedInstance type for this API operation is only for on-premises managed instances.
You must specify the name of the managed instance in the following format:
mi-ID_number . For example, mi-1a2b3c4d5e6f.
public final boolean hasTags()
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.public final List<Tag> tags()
One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
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.
Don't enter personally identifiable information in this field.
public AddTagsToResourceRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<AddTagsToResourceRequest.Builder,AddTagsToResourceRequest>toBuilder in class SsmRequestpublic static AddTagsToResourceRequest.Builder builder()
public static Class<? extends AddTagsToResourceRequest.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.