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

Class ListWorkspacesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListWorkspacesRequest.Builder,ListWorkspacesRequest>

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

Represents the input of a ListWorkspaces operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListWorkspacesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	alias()	If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.
static ListWorkspacesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of workspaces to return per request.
String	nextToken()	The token for the next set of items to return.
List<SdkField<?>>	sdkFields()
static Class<? extends ListWorkspacesRequest.Builder>	serializableBuilderClass()
ListWorkspacesRequest.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()

If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

Returns:

If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

maxResults

public final Integer maxResults()

The maximum number of workspaces to return per request. The default is 100.

Returns:

The maximum number of workspaces to return per request. The default is 100.

nextToken

public final String nextToken()

The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

Returns:

The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

toBuilder

public ListWorkspacesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListWorkspacesRequest.Builder,ListWorkspacesRequest>

Specified by:

toBuilder in class AmpRequest

builder

public static ListWorkspacesRequest.Builder builder()

serializableBuilderClass

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