Package software.amazon.awssdk.services.ecs.model

Class ListServicesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

software.amazon.awssdk.services.ecs.model.ListServicesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListServicesRequest.Builder,ListServicesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListServicesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListServicesRequest.Builder	builder()
String	cluster()	The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LaunchType	launchType()	The launch type to use when filtering the ListServices results.
String	launchTypeAsString()	The launch type to use when filtering the ListServices results.
Integer	maxResults()	The maximum number of service results that ListServices returned in paginated output.
String	nextToken()	The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed.
SchedulingStrategy	schedulingStrategy()	The scheduling strategy to use when filtering the ListServices results.
String	schedulingStrategyAsString()	The scheduling strategy to use when filtering the ListServices results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListServicesRequest.Builder>	serializableBuilderClass()
ListServicesRequest.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

cluster

public final String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

nextToken

public final String nextToken()

The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

maxResults

public final Integer maxResults()

The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.

Returns:

The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.

launchType

public final LaunchType launchType()

The launch type to use when filtering the ListServices results.

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

Returns:

The launch type to use when filtering the ListServices results.

See Also:

LaunchType

launchTypeAsString

public final String launchTypeAsString()

The launch type to use when filtering the ListServices results.

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

Returns:

The launch type to use when filtering the ListServices results.

See Also:

LaunchType

schedulingStrategy

public final SchedulingStrategy schedulingStrategy()

The scheduling strategy to use when filtering the ListServices results.

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

Returns:

The scheduling strategy to use when filtering the ListServices results.

See Also:

SchedulingStrategy

schedulingStrategyAsString

public final String schedulingStrategyAsString()

The scheduling strategy to use when filtering the ListServices results.

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

Returns:

The scheduling strategy to use when filtering the ListServices results.

See Also:

SchedulingStrategy

toBuilder

public ListServicesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListServicesRequest.Builder,ListServicesRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static ListServicesRequest.Builder builder()

serializableBuilderClass

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