Package software.amazon.awssdk.services.nimble.model

Class ListStudioComponentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.nimble.model.NimbleRequest

software.amazon.awssdk.services.nimble.model.ListStudioComponentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListStudioComponentsRequest.Builder,ListStudioComponentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListStudioComponentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListStudioComponentsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStates()	For responses, this returns true if the service returned a value for the States property.
boolean	hasTypes()	For responses, this returns true if the service returned a value for the Types property.
Integer	maxResults()	The max number of results to return in the response.
String	nextToken()	The token for the next set of results, or null if there are no more results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListStudioComponentsRequest.Builder>	serializableBuilderClass()
List<StudioComponentState>	states()	Filters the request to studio components that are in one of the given states.
List<String>	statesAsStrings()	Filters the request to studio components that are in one of the given states.
String	studioId()	The studio ID.
ListStudioComponentsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<StudioComponentType>	types()	Filters the request to studio components that are of one of the given types.
List<String>	typesAsStrings()	Filters the request to studio components that are of one of the given types.

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

maxResults

public final Integer maxResults()

The max number of results to return in the response.

Returns:

The max number of results to return in the response.

nextToken

public final String nextToken()

The token for the next set of results, or null if there are no more results.

Returns:

The token for the next set of results, or null if there are no more results.

states

public final List<StudioComponentState> states()

Filters the request to studio components that are in one of the given states.

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

Returns:

Filters the request to studio components that are in one of the given states.

hasStates

public final boolean hasStates()

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

statesAsStrings

public final List<String> statesAsStrings()

Filters the request to studio components that are in one of the given states.

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

Returns:

Filters the request to studio components that are in one of the given states.

studioId

public final String studioId()

The studio ID.

Returns:

The studio ID.

types

public final List<StudioComponentType> types()

Filters the request to studio components that are of one of the given types.

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

Returns:

Filters the request to studio components that are of one of the given types.

hasTypes

public final boolean hasTypes()

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

typesAsStrings

public final List<String> typesAsStrings()

Filters the request to studio components that are of one of the given types.

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

Returns:

Filters the request to studio components that are of one of the given types.

toBuilder

public ListStudioComponentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListStudioComponentsRequest.Builder,ListStudioComponentsRequest>

Specified by:

toBuilder in class NimbleRequest

builder

public static ListStudioComponentsRequest.Builder builder()

serializableBuilderClass

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