Class UpdateGeneratedTemplateRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateGeneratedTemplateRequest.Builder,
UpdateGeneratedTemplateRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<ResourceDefinition> An optional list of resources to be added to the generated template.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name or Amazon Resource Name (ARN) of a generated template.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AddResources property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RemoveResources property.final String
An optional new name to assign to the generated template.final Boolean
Iftrue
, update the resource properties in the generated template with their current live state.A list of logical ids for resources to remove from the generated template.static Class
<? extends UpdateGeneratedTemplateRequest.Builder> final TemplateConfiguration
The configuration details of the generated template, including theDeletionPolicy
andUpdateReplacePolicy
.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
-
generatedTemplateName
The name or Amazon Resource Name (ARN) of a generated template.
- Returns:
- The name or Amazon Resource Name (ARN) of a generated template.
-
newGeneratedTemplateName
An optional new name to assign to the generated template.
- Returns:
- An optional new name to assign to the generated template.
-
hasAddResources
public final boolean hasAddResources()For responses, this returns true if the service returned a value for the AddResources 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. -
addResources
An optional list of resources to be added to the generated template.
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
hasAddResources()
method.- Returns:
- An optional list of resources to be added to the generated template.
-
hasRemoveResources
public final boolean hasRemoveResources()For responses, this returns true if the service returned a value for the RemoveResources 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. -
removeResources
A list of logical ids for resources to remove from the generated template.
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
hasRemoveResources()
method.- Returns:
- A list of logical ids for resources to remove from the generated template.
-
refreshAllResources
If
true
, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.- Returns:
- If
true
, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.
-
templateConfiguration
The configuration details of the generated template, including the
DeletionPolicy
andUpdateReplacePolicy
.- Returns:
- The configuration details of the generated template, including the
DeletionPolicy
andUpdateReplacePolicy
.
-
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<UpdateGeneratedTemplateRequest.Builder,
UpdateGeneratedTemplateRequest> - Specified by:
toBuilder
in classCloudFormationRequest
- 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
-