Class PropagateTags
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PropagateTags.Builder,PropagateTags>
Configuration for tag propagation to managed resources launched by the capacity provider.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic PropagateTags.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) A list of tags to apply to managed resources whenModeis set toExplicit.final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the ExplicitTags property.final inthashCode()final PropagateTagsModemode()The tag propagation mode.final StringThe tag propagation mode.static Class<? extends PropagateTags.Builder>final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
mode
The tag propagation mode. Set to
Explicitto propagate the tags specified inExplicitTagsto managed resources. Set toNoneto disable tag propagation.If the service returns an enum value that is not available in the current SDK version,
modewill returnPropagateTagsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommodeAsString().- Returns:
- The tag propagation mode. Set to
Explicitto propagate the tags specified inExplicitTagsto managed resources. Set toNoneto disable tag propagation. - See Also:
-
modeAsString
The tag propagation mode. Set to
Explicitto propagate the tags specified inExplicitTagsto managed resources. Set toNoneto disable tag propagation.If the service returns an enum value that is not available in the current SDK version,
modewill returnPropagateTagsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommodeAsString().- Returns:
- The tag propagation mode. Set to
Explicitto propagate the tags specified inExplicitTagsto managed resources. Set toNoneto disable tag propagation. - See Also:
-
hasExplicitTags
public final boolean hasExplicitTags()For responses, this returns true if the service returned a value for the ExplicitTags 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. -
explicitTags
A list of tags to apply to managed resources when
Modeis set toExplicit. You can specify up to 40 tags.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
hasExplicitTags()method.- Returns:
- A list of tags to apply to managed resources when
Modeis set toExplicit. You can specify up to 40 tags.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<PropagateTags.Builder,PropagateTags>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-