software.amazon.awssdk.services.servicediscovery.model

Class GetInstancesHealthStatusRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetInstancesHealthStatusRequest.Builder,GetInstancesHealthStatusRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetInstancesHealthStatusRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetInstancesHealthStatusRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstances() For responses, this returns true if the service returned a value for the Instances property.
List<String>	instances() An array that contains the IDs of all the instances that you want to get the health status for.
Integer	maxResults() The maximum number of instances that you want Cloud Map to return in the response to a GetInstancesHealthStatus request.
String	nextToken() For the first GetInstancesHealthStatus request, omit this value.
List<SdkField<?>>	sdkFields()
static Class<? extends GetInstancesHealthStatusRequest.Builder>	serializableBuilderClass()
String	serviceId() The ID of the service that the instance is associated with.
GetInstancesHealthStatusRequest.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

serviceId

public final String serviceId()

The ID of the service that the instance is associated with.

Returns:

The ID of the service that the instance is associated with.

hasInstances

public final boolean hasInstances()

For responses, this returns true if the service returned a value for the Instances 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.

instances

public final List<String> instances()

An array that contains the IDs of all the instances that you want to get the health status for.

If you omit Instances, Cloud Map returns the health status for all the instances that are associated with the specified service.

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

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 hasInstances() method.

Returns:

An array that contains the IDs of all the instances that you want to get the health status for.

If you omit Instances, Cloud Map returns the health status for all the instances that are associated with the specified service.

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

maxResults

public final Integer maxResults()

The maximum number of instances that you want Cloud Map to return in the response to a GetInstancesHealthStatus 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 GetInstancesHealthStatus request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

nextToken

public final String nextToken()

For the first GetInstancesHealthStatus request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Returns:

For the first GetInstancesHealthStatus request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

toBuilder

public GetInstancesHealthStatusRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetInstancesHealthStatusRequest.Builder,GetInstancesHealthStatusRequest>

Specified by:

toBuilder in class ServiceDiscoveryRequest

builder

public static GetInstancesHealthStatusRequest.Builder builder()

serializableBuilderClass

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