Package software.amazon.awssdk.services.amp.model

Class CreateWorkspaceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.amp.model.AmpRequest

software.amazon.awssdk.services.amp.model.CreateWorkspaceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>

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

Represents the input of a CreateWorkspace operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWorkspaceRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	alias()	An alias that you assign to this workspace to help you identify it.
static CreateWorkspaceRequest.Builder	builder()
String	clientToken()	A unique identifier that you can provide to ensure the idempotency of the request.
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	kmsKeyArn()	(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorkspaceRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The list of tag keys and values to associate with the workspace.
CreateWorkspaceRequest.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

alias

public final String alias()

An alias that you assign to this workspace to help you identify it. It does not need to be unique.

Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.

Returns:

An alias that you assign to this workspace to help you identify it. It does not need to be unique.

Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.

clientToken

public final String clientToken()

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

Returns:

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

kmsKeyArn

public final String kmsKeyArn()

(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

Returns:

(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus 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 Map<String,String> tags()

The list of tag keys and values to associate with the workspace.

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:

The list of tag keys and values to associate with the workspace.

toBuilder

public CreateWorkspaceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>

Specified by:

toBuilder in class AmpRequest

builder

public static CreateWorkspaceRequest.Builder builder()

serializableBuilderClass

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