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

Class CreateServiceInstanceRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateServiceInstanceRequest.Builder,CreateServiceInstanceRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateServiceInstanceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateServiceInstanceRequest.Builder	builder()
String	clientToken()	The client token of the service instance to create.
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 instance to create.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateServiceInstanceRequest.Builder>	serializableBuilderClass()
String	serviceName()	The name of the service the service instance is added to.
String	spec()	The spec for the service instance you want to create.
List<Tag>	tags()	An optional list of metadata items that you can associate with the Proton service instance.
String	templateMajorVersion()	To create a new major and minor version of the service template, exclude major Version.
String	templateMinorVersion()	To create a new minor version of the service template, include a major Version.
CreateServiceInstanceRequest.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()

The client token of the service instance to create.

Returns:

The client token of the service instance to create.

name

public final String name()

The name of the service instance to create.

Returns:

The name of the service instance to create.

serviceName

public final String serviceName()

The name of the service the service instance is added to.

Returns:

The name of the service the service instance is added to.

spec

public final String spec()

The spec for the service instance you want to create.

Returns:

The spec for the service instance you want to create.

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

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

templateMajorVersion

public final String templateMajorVersion()

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

Returns:

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

templateMinorVersion

public final String templateMinorVersion()

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

Returns:

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

toBuilder

public CreateServiceInstanceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateServiceInstanceRequest.Builder,CreateServiceInstanceRequest>

Specified by:

toBuilder in class ProtonRequest

builder

public static CreateServiceInstanceRequest.Builder builder()

serializableBuilderClass

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