Class UpdateServiceTemplateVersionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateServiceTemplateVersionRequest.Builder,
UpdateServiceTemplateVersionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
An array of environment template objects that are compatible with this service template version.final String
A description of a service template version to update.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 boolean
For responses, this returns true if the service returned a value for the CompatibleEnvironmentTemplates property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedComponentSources property.final String
To update a major version of a service template, includemajor Version
.final String
To update a minor version of a service template, includeminorVersion
.static Class
<? extends UpdateServiceTemplateVersionRequest.Builder> final TemplateVersionStatus
status()
The status of the service template minor version to update.final String
The status of the service template minor version to update.An array of supported component sources.An array of supported component sources.final String
The name of the service template.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
-
hasCompatibleEnvironmentTemplates
public final boolean hasCompatibleEnvironmentTemplates()For responses, this returns true if the service returned a value for the CompatibleEnvironmentTemplates 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. -
compatibleEnvironmentTemplates
An array of environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.
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
hasCompatibleEnvironmentTemplates()
method.- Returns:
- An array of environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.
-
description
A description of a service template version to update.
- Returns:
- A description of a service template version to update.
-
majorVersion
To update a major version of a service template, include
major Version
.- Returns:
- To update a major version of a service template, include
major Version
.
-
minorVersion
To update a minor version of a service template, include
minorVersion
.- Returns:
- To update a minor version of a service template, include
minorVersion
.
-
status
The status of the service template minor version to update.
If the service returns an enum value that is not available in the current SDK version,
status
will returnTemplateVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the service template minor version to update.
- See Also:
-
statusAsString
The status of the service template minor version to update.
If the service returns an enum value that is not available in the current SDK version,
status
will returnTemplateVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the service template minor version to update.
- See Also:
-
supportedComponentSources
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
A change to
supportedComponentSources
doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.For more information about components, see Proton components in the Proton User Guide.
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
hasSupportedComponentSources()
method.- Returns:
- An array of supported component sources. Components with supported sources can be attached to service
instances based on this service template version.
A change to
supportedComponentSources
doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.For more information about components, see Proton components in the Proton User Guide.
-
hasSupportedComponentSources
public final boolean hasSupportedComponentSources()For responses, this returns true if the service returned a value for the SupportedComponentSources 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. -
supportedComponentSourcesAsStrings
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
A change to
supportedComponentSources
doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.For more information about components, see Proton components in the Proton User Guide.
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
hasSupportedComponentSources()
method.- Returns:
- An array of supported component sources. Components with supported sources can be attached to service
instances based on this service template version.
A change to
supportedComponentSources
doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.For more information about components, see Proton components in the Proton User Guide.
-
templateName
The name of the service template.
- Returns:
- The name of the service template.
-
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<UpdateServiceTemplateVersionRequest.Builder,
UpdateServiceTemplateVersionRequest> - Specified by:
toBuilder
in classProtonRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends UpdateServiceTemplateVersionRequest.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
-