Class GetInventoryRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ssm.model.SsmRequest
-
- software.amazon.awssdk.services.ssm.model.GetInventoryRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetInventoryRequest.Builder,GetInventoryRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetInventoryRequest extends SsmRequest implements ToCopyableBuilder<GetInventoryRequest.Builder,GetInventoryRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetInventoryRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<InventoryAggregator>
aggregators()
Returns counts of inventory types based on one or more expressions.static GetInventoryRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<InventoryFilter>
filters()
One or more filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAggregators()
For responses, this returns true if the service returned a value for the Aggregators property.boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasResultAttributes()
For responses, this returns true if the service returned a value for the ResultAttributes property.Integer
maxResults()
The maximum number of items to return for this call.String
nextToken()
The token for the next set of items to return.List<ResultAttribute>
resultAttributes()
The list of inventory item types to return.List<SdkField<?>>
sdkFields()
static Class<? extends GetInventoryRequest.Builder>
serializableBuilderClass()
GetInventoryRequest.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
-
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
public final List<InventoryFilter> filters()
One or more filters. Use a filter to return a more specific list of results.
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:
- One or more filters. Use a filter to return a more specific list of results.
-
hasAggregators
public final boolean hasAggregators()
For responses, this returns true if the service returned a value for the Aggregators 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.
-
aggregators
public final List<InventoryAggregator> aggregators()
Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the
AWS:InstanceInformation.PlatformType
type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet.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
hasAggregators()
method.- Returns:
- Returns counts of inventory types based on one or more expressions. For example, if you aggregate by
using an expression that uses the
AWS:InstanceInformation.PlatformType
type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet.
-
hasResultAttributes
public final boolean hasResultAttributes()
For responses, this returns true if the service returned a value for the ResultAttributes 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.
-
resultAttributes
public final List<ResultAttribute> resultAttributes()
The list of inventory item types to return.
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
hasResultAttributes()
method.- Returns:
- The list of inventory item types to return.
-
nextToken
public final String nextToken()
The token for the next set of items to return. (You received this token from a previous call.)
- Returns:
- The token for the next set of items to return. (You received this token from a previous call.)
-
maxResults
public final Integer maxResults()
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
- Returns:
- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
-
toBuilder
public GetInventoryRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetInventoryRequest.Builder,GetInventoryRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static GetInventoryRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetInventoryRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-