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:

SdkPojo, 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)
boolean	equalsBySdkFields(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)
boolean	hasAgentIds() For responses, this returns true if the service returned a value for the AgentIds property.
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAgentsRequest.Builder>	serializableBuilderClass()
DescribeAgentsRequest.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

hasAgentIds

public final boolean hasAgentIds()

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

agentIds

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

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

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.

hasFilters

public final boolean hasFilters()

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

filters

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

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

Returns:

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

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

maxResults

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>

Specified by:

toBuilder in class ApplicationDiscoveryRequest

builder

public static DescribeAgentsRequest.Builder builder()

serializableBuilderClass

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