Package software.amazon.awssdk.services.evidently.model

Class ListExperimentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.evidently.model.EvidentlyRequest

software.amazon.awssdk.services.evidently.model.ListExperimentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListExperimentsRequest.Builder,ListExperimentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListExperimentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListExperimentsRequest.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 results to include in the response.
String	nextToken()	The token to use when requesting the next set of results.
String	project()	The name or ARN of the project to return the experiment list from.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListExperimentsRequest.Builder>	serializableBuilderClass()
ExperimentStatus	status()	Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.
String	statusAsString()	Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.
ListExperimentsRequest.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

maxResults

public final Integer maxResults()

The maximum number of results to include in the response.

Returns:

The maximum number of results to include in the response.

nextToken

public final String nextToken()

The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.

Returns:

The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.

project

public final String project()

The name or ARN of the project to return the experiment list from.

Returns:

The name or ARN of the project to return the experiment list from.

status

public final ExperimentStatus status()

Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

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

Returns:

Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

See Also:

ExperimentStatus

statusAsString

public final String statusAsString()

Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

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

Returns:

Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

See Also:

ExperimentStatus

toBuilder

public ListExperimentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListExperimentsRequest.Builder,ListExperimentsRequest>

Specified by:

toBuilder in class EvidentlyRequest

builder

public static ListExperimentsRequest.Builder builder()

serializableBuilderClass

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