software.amazon.awssdk.services.proton.model

Class CreateServiceTemplateVersionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.proton.model.ProtonRequest

software.amazon.awssdk.services.proton.model.CreateServiceTemplateVersionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateServiceTemplateVersionRequest.Builder,CreateServiceTemplateVersionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateServiceTemplateVersionRequest
extends ProtonRequest
implements ToCopyableBuilder<CreateServiceTemplateVersionRequest.Builder,CreateServiceTemplateVersionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateServiceTemplateVersionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateServiceTemplateVersionRequest.Builder	builder()
String	clientToken() When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.
List<CompatibleEnvironmentTemplateInput>	compatibleEnvironmentTemplates() An array of environment template objects that are compatible with the new service template version.
String	description() A description of the new version of a service template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCompatibleEnvironmentTemplates() For responses, this returns true if the service returned a value for the CompatibleEnvironmentTemplates property.
int	hashCode()
boolean	hasSupportedComponentSources() For responses, this returns true if the service returned a value for the SupportedComponentSources property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	majorVersion() To create a new minor version of the service template, include a major Version.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateServiceTemplateVersionRequest.Builder>	serializableBuilderClass()
TemplateVersionSourceInput	source() An object that includes the template bundle S3 bucket path and name for the new version of a service template.
List<ServiceTemplateSupportedComponentSourceType>	supportedComponentSources() An array of supported component sources.
List<String>	supportedComponentSourcesAsStrings() An array of supported component sources.
List<Tag>	tags() An optional list of metadata items that you can associate with the Proton service template version.
String	templateName() The name of the service template.
CreateServiceTemplateVersionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientToken

public final String clientToken()

When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.

Returns:

When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.

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 the 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.

compatibleEnvironmentTemplates

public final List<CompatibleEnvironmentTemplateInput> compatibleEnvironmentTemplates()

An array of environment template objects that are compatible with the new 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 the new service template version. A service instance based on this service template version can run in environments based on compatible templates.

description

public final String description()

A description of the new version of a service template.

Returns:

A description of the new version of a service template.

majorVersion

public final String majorVersion()

To create a new minor version of the service template, include a major Version.

To create a new major and minor version of the service template, exclude major Version.

Returns:

To create a new minor version of the service template, include a major Version.

To create a new major and minor version of the service template, exclude major Version.

source

public final TemplateVersionSourceInput source()

An object that includes the template bundle S3 bucket path and name for the new version of a service template.

Returns:

An object that includes the template bundle S3 bucket path and name for the new version of a service template.

supportedComponentSources

public final List<ServiceTemplateSupportedComponentSourceType> supportedComponentSources()

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

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.

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 the 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.

supportedComponentSourcesAsStrings

public final List<String> supportedComponentSourcesAsStrings()

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

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.

For more information about components, see Proton components in the Proton User Guide.

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 the 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.

tags

public final List<Tag> tags()

An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.

For more information, see Proton resources and tagging 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 hasTags() method.

Returns:

An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

templateName

public final String templateName()

The name of the service template.

Returns:

The name of the service template.

toBuilder

public CreateServiceTemplateVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateServiceTemplateVersionRequest.Builder,CreateServiceTemplateVersionRequest>

Specified by:

toBuilder in class ProtonRequest

builder

public static CreateServiceTemplateVersionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateServiceTemplateVersionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo