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

Class DescribeWorkspaceImagesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeWorkspaceImagesRequest.Builder,DescribeWorkspaceImagesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeWorkspaceImagesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeWorkspaceImagesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasImageIds()	For responses, this returns true if the service returned a value for the ImageIds property.
List<String>	imageIds()	The identifier of the image.
ImageType	imageType()	The type (owned or shared) of the image.
String	imageTypeAsString()	The type (owned or shared) of the image.
Integer	maxResults()	The maximum number of items to return.
String	nextToken()	If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeWorkspaceImagesRequest.Builder>	serializableBuilderClass()
DescribeWorkspaceImagesRequest.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

hasImageIds

public final boolean hasImageIds()

For responses, this returns true if the service returned a value for the ImageIds 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.

imageIds

public final List<String> imageIds()

The identifier of the image.

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 hasImageIds() method.

Returns:

The identifier of the image.

imageType

public final ImageType imageType()

The type (owned or shared) of the image.

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

Returns:

The type (owned or shared) of the image.

See Also:

ImageType

imageTypeAsString

public final String imageTypeAsString()

The type (owned or shared) of the image.

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

Returns:

The type (owned or shared) of the image.

See Also:

ImageType

nextToken

public final String nextToken()

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

maxResults

public final Integer maxResults()

The maximum number of items to return.

Returns:

The maximum number of items to return.

toBuilder

public DescribeWorkspaceImagesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeWorkspaceImagesRequest.Builder,DescribeWorkspaceImagesRequest>

Specified by:

toBuilder in class WorkSpacesRequest

builder

public static DescribeWorkspaceImagesRequest.Builder builder()

serializableBuilderClass

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