software.amazon.awssdk.services.servicediscovery.model

Class DiscoverInstancesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DiscoverInstancesRequest.Builder,DiscoverInstancesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DiscoverInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DiscoverInstancesRequest.Builder	builder()
boolean	equals(Object obj)
<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()
HealthStatusFilter	healthStatus() The health status of the instances that you want to discover.
String	healthStatusAsString() The health status of the instances that you want to discover.
Integer	maxResults() The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request.
String	namespaceName() The name of the namespace that you specified when you registered the instance.
Map<String,String>	queryParameters() A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance.
List<SdkField<?>>	sdkFields()
static Class<? extends DiscoverInstancesRequest.Builder>	serializableBuilderClass()
String	serviceName() The name of the service that you specified when you registered the instance.
DiscoverInstancesRequest.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

namespaceName

public String namespaceName()

The name of the namespace that you specified when you registered the instance.

Returns:

The name of the namespace that you specified when you registered the instance.

serviceName

public String serviceName()

The name of the service that you specified when you registered the instance.

Returns:

The name of the service that you specified when you registered the instance.

maxResults

public Integer maxResults()

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

Returns:

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

queryParameters

public Map<String,String> queryParameters()

A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all the specified key/value pairs will be returned.

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

Returns:

A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all the specified key/value pairs will be returned.

healthStatus

public HealthStatusFilter healthStatus()

The health status of the instances that you want to discover.

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

Returns:

The health status of the instances that you want to discover.

See Also:

HealthStatusFilter

healthStatusAsString

public String healthStatusAsString()

The health status of the instances that you want to discover.

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

Returns:

The health status of the instances that you want to discover.

See Also:

HealthStatusFilter

toBuilder

public DiscoverInstancesRequest.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<DiscoverInstancesRequest.Builder,DiscoverInstancesRequest>

Specified by:

toBuilder in class ServiceDiscoveryRequest

Returns:

a builder for type T

builder

public static DiscoverInstancesRequest.Builder builder()

serializableBuilderClass

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