Class ListConfigurationsRequest
- 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.ListConfigurationsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListConfigurationsRequest.Builder,ListConfigurationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListConfigurationsRequest extends ApplicationDiscoveryRequest implements ToCopyableBuilder<ListConfigurationsRequest.Builder,ListConfigurationsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListConfigurationsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListConfigurationsRequest.Builderbuilder()ConfigurationItemTypeconfigurationType()A valid configuration identified by Application Discovery Service.StringconfigurationTypeAsString()A valid configuration identified by Application Discovery Service.booleanequals(Object obj)booleanequalsBySdkFields(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)booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()booleanhasOrderBy()For responses, this returns true if the service returned a value for the OrderBy property.IntegermaxResults()The total number of items to return.StringnextToken()Token to retrieve the next set of results.List<OrderByElement>orderBy()Certain filter criteria return output that can be sorted in ascending or descending order.List<SdkField<?>>sdkFields()static Class<? extends ListConfigurationsRequest.Builder>serializableBuilderClass()ListConfigurationsRequest.BuildertoBuilder()StringtoString()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
-
configurationType
public final ConfigurationItemType configurationType()
A valid configuration identified by Application Discovery Service.
If the service returns an enum value that is not available in the current SDK version,
configurationTypewill returnConfigurationItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconfigurationTypeAsString().- Returns:
- A valid configuration identified by Application Discovery Service.
- See Also:
ConfigurationItemType
-
configurationTypeAsString
public final String configurationTypeAsString()
A valid configuration identified by Application Discovery Service.
If the service returns an enum value that is not available in the current SDK version,
configurationTypewill returnConfigurationItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconfigurationTypeAsString().- Returns:
- A valid configuration identified by Application Discovery Service.
- See Also:
ConfigurationItemType
-
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<Filter> filters()
You can filter the request using various logical operators and a key-value format. For example:
{"key": "serverType", "value": "webServer"}For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.
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": "serverType", "value": "webServer"}For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.
-
maxResults
public final Integer maxResults()
The total number of items to return. The maximum value is 100.
- Returns:
- The total number of items to return. The maximum value is 100.
-
nextToken
public final String nextToken()
Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set
ListConfigurationsRequest$maxResultsto 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 a previous call to ListConfigurations returned
100 items, but you set
ListConfigurationsRequest$maxResultsto 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.
-
hasOrderBy
public final boolean hasOrderBy()
For responses, this returns true if the service returned a value for the OrderBy 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.
-
orderBy
public final List<OrderByElement> orderBy()
Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.
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
hasOrderBy()method.- Returns:
- Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.
-
toBuilder
public ListConfigurationsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListConfigurationsRequest.Builder,ListConfigurationsRequest>- Specified by:
toBuilderin classApplicationDiscoveryRequest
-
builder
public static ListConfigurationsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListConfigurationsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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:
getValueForFieldin classSdkRequest
-
-