Class DescribeAgentsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeAgentsRequest.Builder,
DescribeAgentsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionagentIds()
The agent or the collector IDs for which you want information.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
You can filter the request using various logical operators and a key-value format.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AgentIds property.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final Integer
The total number of agents/collectors to return in a single page of output.final String
Token to retrieve the next set of results.static Class
<? extends DescribeAgentsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.
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 collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.
-
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 theisEmpty()
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
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
The total number of agents/collectors to return in a single page of output. The maximum value is 100.
- Returns:
- The total number of agents/collectors to return in a single page of output. The maximum value is 100.
-
nextToken
Token to retrieve the next set of results. For example, if you previously specified 100 IDs for
DescribeAgentsRequest$agentIds
but setDescribeAgentsRequest$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 setDescribeAgentsRequest$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
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 interfaceToCopyableBuilder<DescribeAgentsRequest.Builder,
DescribeAgentsRequest> - Specified by:
toBuilder
in classApplicationDiscoveryRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-