software.amazon.awssdk.services.applicationdiscovery.model

Class DescribeAgentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.applicationdiscovery.model.ApplicationDiscoveryRequest

software.amazon.awssdk.services.applicationdiscovery.model.DescribeAgentsRequest

All Implemented Interfaces:

ToCopyableBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAgentsRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	agentIds() The agent or the Connector IDs for which you want information.
static DescribeAgentsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters() You can filter the request using various logical operators and a key-value format.
<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 total number of agents/Connectors to return in a single page of output.
String	nextToken() Token to retrieve the next set of results.
static Class<? extends DescribeAgentsRequest.Builder>	serializableBuilderClass()
DescribeAgentsRequest.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

agentIds

public List<String> agentIds()

The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.

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

Returns:

The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.

filters

public List<Filter> filters()

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

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

Returns:

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

maxResults

public Integer maxResults()

The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

Returns:

The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

nextToken

public String nextToken()

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

Returns:

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

toBuilder

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

Specified by:

toBuilder in class ApplicationDiscoveryRequest

Returns:

a builder for type T

builder

public static DescribeAgentsRequest.Builder builder()

serializableBuilderClass

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