Class AddTagsToResourceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AddTagsToResourceRequest.Builder,
AddTagsToResourceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The resource ID you want to tag.final ResourceTypeForTagging
Specifies the type of resource you are tagging.final String
Specifies the type of resource you are tagging.static Class
<? extends AddTagsToResourceRequest.Builder> tags()
One or more tags.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resourceType
Specifies the type of resource you are tagging.
The
ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node 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 returnResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- Specifies the type of resource you are tagging.
The
ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format:mi-ID_number
. For example,mi-1a2b3c4d5e6f
. - See Also:
-
resourceTypeAsString
Specifies the type of resource you are tagging.
The
ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node 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 returnResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- Specifies the type of resource you are tagging.
The
ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format:mi-ID_number
. For example,mi-1a2b3c4d5e6f
. - See Also:
-
resourceId
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow
:mw-012345abcde
PatchBaseline
:pb-012345abcde
Automation
:example-c160-4567-8519-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 wordopsmetadata
in the ARN. For example, an OpsMetadata object with an ARN ofarn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has aResourceID
of eitheraws/ssm/MyGroup/appmanager
or/aws/ssm/MyGroup/appmanager
.For the
Document
andParameter
values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document.ManagedInstance
:mi-012345abcde
The
ManagedInstance
type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format:mi-ID_number
. For example,mi-1a2b3c4d5e6f
.- Returns:
- The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow
:mw-012345abcde
PatchBaseline
:pb-012345abcde
Automation
:example-c160-4567-8519-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 wordopsmetadata
in the ARN. For example, an OpsMetadata object with an ARN ofarn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has aResourceID
of eitheraws/ssm/MyGroup/appmanager
or/aws/ssm/MyGroup/appmanager
.For the
Document
andParameter
values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document.ManagedInstance
:mi-012345abcde
The
ManagedInstance
type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format:mi-ID_number
. For example,mi-1a2b3c4d5e6f
.
-
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 theisEmpty()
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
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.- Returns:
- One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
-
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 interfaceToCopyableBuilder<AddTagsToResourceRequest.Builder,
AddTagsToResourceRequest> - Specified by:
toBuilder
in classSsmRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-