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)
<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()
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 AWS 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() 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

serviceId

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

instances

public 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, AWS 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.

Returns:

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

If you omit Instances, AWS 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 Integer maxResults()

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

Returns:

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

nextToken

public 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()

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

Specified by:

toBuilder in class ServiceDiscoveryRequest

Returns:

a builder for type T

builder

public static GetInstancesHealthStatusRequest.Builder builder()

serializableBuilderClass

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