@Generated(value="software.amazon.awssdk:codegen") public final class ListSecretsRequest extends SecretsManagerRequest implements ToCopyableBuilder<ListSecretsRequest.Builder,ListSecretsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListSecretsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListSecretsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<Filter> |
filters()
Lists the secret request filters.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
boolean |
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.
|
int |
hashCode() |
Integer |
maxResults()
(Optional) Limits the number of results you want to include in the response.
|
String |
nextToken()
(Optional) Use this parameter in a request if you receive a
NextToken response in a previous request
indicating there's more output available. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListSecretsRequest.Builder> |
serializableBuilderClass() |
SortOrderType |
sortOrder()
Lists secrets in the requested order.
|
String |
sortOrderAsString()
Lists secrets in the requested order.
|
ListSecretsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final Integer maxResults()
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
specify, the NextToken response element is present and has a value (isn't null). Include that value
as the NextToken request parameter in the next call to the operation to get the next part of the
results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
available. You should check NextToken after every operation to ensure that you receive all of the
results.
NextToken response element is present and has a value (isn't null).
Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
even when there are more results available. You should check NextToken after every operation
to ensure that you receive all of the results.public final String nextToken()
(Optional) Use this parameter in a request if you receive a NextToken response in a previous request
indicating there's more output available. In a subsequent call, set it to the value of the previous call
NextToken response to indicate where the output should continue from.
NextToken response in a previous
request indicating there's more output available. In a subsequent call, set it to the value of the
previous call NextToken response to indicate where the output should continue from.public final boolean hasFilters()
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.public final List<Filter> filters()
Lists the secret request filters.
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.
public final SortOrderType sortOrder()
Lists secrets in the requested order.
If the service returns an enum value that is not available in the current SDK version, sortOrder will
return SortOrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
sortOrderAsString().
SortOrderTypepublic final String sortOrderAsString()
Lists secrets in the requested order.
If the service returns an enum value that is not available in the current SDK version, sortOrder will
return SortOrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
sortOrderAsString().
SortOrderTypepublic ListSecretsRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ListSecretsRequest.Builder,ListSecretsRequest>toBuilder in class SecretsManagerRequestpublic static ListSecretsRequest.Builder builder()
public static Class<? extends ListSecretsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.