Package software.amazon.awssdk.services.proton.model

Class CreateServiceTemplateRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateServiceTemplateRequest.Builder,CreateServiceTemplateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateServiceTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateServiceTemplateRequest.Builder	builder()
String	description()	A description of the service template.
String	displayName()	The name of the service template as displayed in the developer interface.
String	encryptionKey()	A customer provided encryption key that's used to encrypt data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the service template.
Provisioning	pipelineProvisioning()	By default, Proton provides a service pipeline for your service.
String	pipelineProvisioningAsString()	By default, Proton provides a service pipeline for your service.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateServiceTemplateRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	An optional list of metadata items that you can associate with the Proton service template.
CreateServiceTemplateRequest.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

description

public final String description()

A description of the service template.

Returns:

A description of the service template.

displayName

public final String displayName()

The name of the service template as displayed in the developer interface.

Returns:

The name of the service template as displayed in the developer interface.

encryptionKey

public final String encryptionKey()

A customer provided encryption key that's used to encrypt data.

Returns:

A customer provided encryption key that's used to encrypt data.

name

public final String name()

The name of the service template.

Returns:

The name of the service template.

pipelineProvisioning

public final Provisioning pipelineProvisioning()

By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.

If the service returns an enum value that is not available in the current SDK version, pipelineProvisioning will return Provisioning.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pipelineProvisioningAsString().

Returns:

By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.

See Also:

Provisioning

pipelineProvisioningAsString

public final String pipelineProvisioningAsString()

By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.

If the service returns an enum value that is not available in the current SDK version, pipelineProvisioning will return Provisioning.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pipelineProvisioningAsString().

Returns:

By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.

See Also:

Provisioning

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. 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. A tag is a key-value pair.

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

toBuilder

public CreateServiceTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateServiceTemplateRequest.Builder,CreateServiceTemplateRequest>

Specified by:

toBuilder in class ProtonRequest

builder

public static CreateServiceTemplateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateServiceTemplateRequest.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