software.amazon.awssdk.services.servicediscovery.model

Class ListServicesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.servicediscovery.model.ServiceDiscoveryRequest

software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListServicesRequest.Builder,ListServicesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListServicesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListServicesRequest.Builder	builder()
boolean	equals(Object obj)
List<ServiceFilter>	filters() A complex type that contains specifications for the namespaces that you want to list services for.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices request.
String	nextToken() For the first ListServices request, omit this value.
List<SdkField<?>>	sdkFields()
static Class<? extends ListServicesRequest.Builder>	serializableBuilderClass()
ListServicesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

nextToken

public String nextToken()

For the first ListServices request, omit this value.

If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

Returns:

For the first ListServices request, omit this value.

If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

maxResults

public Integer maxResults()

The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services.

Returns:

The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services.

filters

public List<ServiceFilter> filters()

A complex type that contains specifications for the namespaces that you want to list services for.

If you specify more than one filter, an operation must match all filters to be returned by ListServices.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A complex type that contains specifications for the namespaces that you want to list services for.

If you specify more than one filter, an operation must match all filters to be returned by ListServices.

toBuilder

public ListServicesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListServicesRequest.Builder,ListServicesRequest>

Specified by:

toBuilder in class ServiceDiscoveryRequest

Returns:

a builder for type T

builder

public static ListServicesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListServicesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.