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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptionalParameters() For responses, this returns true if the service returned a value for the OptionalParameters property.
boolean	hasQueryParameters() For responses, this returns true if the service returned a value for the QueryParameters property.
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 HttpName name of the namespace.
Map<String,String>	optionalParameters() Opportunistic filters to scope the results based on custom attributes.
Map<String,String>	queryParameters() Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}).
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()
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

namespaceName

public final String namespaceName()

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

Returns:

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

serviceName

public final 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 final 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.

hasQueryParameters

public final boolean hasQueryParameters()

For responses, this returns true if the service returned a value for the QueryParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

queryParameters

public final Map<String,String> queryParameters()

Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryParameters() method.

Returns:

Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

hasOptionalParameters

public final boolean hasOptionalParameters()

For responses, this returns true if the service returned a value for the OptionalParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

optionalParameters

public final Map<String,String> optionalParameters()

Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionalParameters() method.

Returns:

Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

healthStatus

public final HealthStatusFilter healthStatus()

The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

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. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

See Also:

HealthStatusFilter

healthStatusAsString

public final String healthStatusAsString()

The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

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. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

See Also:

HealthStatusFilter

toBuilder

public DiscoverInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DiscoverInstancesRequest.Builder,DiscoverInstancesRequest>

Specified by:

toBuilder in class ServiceDiscoveryRequest

builder

public static DiscoverInstancesRequest.Builder builder()

serializableBuilderClass

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