Package software.amazon.awssdk.services.workspaces.model

Class CreateWorkspaceImageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workspaces.model.WorkSpacesRequest

software.amazon.awssdk.services.workspaces.model.CreateWorkspaceImageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorkspaceImageRequest.Builder,CreateWorkspaceImageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWorkspaceImageRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateWorkspaceImageRequest.Builder	builder()
String	description()	The description of the new WorkSpace image.
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 new WorkSpace image.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorkspaceImageRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags that you want to add to the new WorkSpace image.
CreateWorkspaceImageRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workspaceId()	The identifier of the source WorkSpace

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

name

public final String name()

The name of the new WorkSpace image.

Returns:

The name of the new WorkSpace image.

description

public final String description()

The description of the new WorkSpace image.

Returns:

The description of the new WorkSpace image.

workspaceId

public final String workspaceId()

The identifier of the source WorkSpace

Returns:

The identifier of the source WorkSpace

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()

The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.

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 tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.

toBuilder

public CreateWorkspaceImageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorkspaceImageRequest.Builder,CreateWorkspaceImageRequest>

Specified by:

toBuilder in class WorkSpacesRequest

builder

public static CreateWorkspaceImageRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo