java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest
    - - software.amazon.awssdk.services.secretsmanager.model.ListSecretsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListSecretsRequest.Builder,ListSecretsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListSecretsRequest
extends SecretsManagerRequest
implements ToCopyableBuilder<ListSecretsRequest.Builder,ListSecretsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListSecretsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListSecretsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()`	The filters to apply to the list of secrets.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`Boolean`	`includePlannedDeletion()`	Specifies whether to include secrets scheduled for deletion.
`Integer`	`maxResults()`	The number of results to include in the response.
`String`	`nextToken()`	A token that indicates where the output should continue from, if a previous call did not show all results.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListSecretsRequest.Builder>`	`serializableBuilderClass()`
`SortByType`	`sortBy()`	If not specified, secrets are listed by `CreatedDate`.
`String`	`sortByAsString()`	If not specified, secrets are listed by `CreatedDate`.
`SortOrderType`	`sortOrder()`	Secrets are listed by `CreatedDate`.
`String`	`sortOrderAsString()`	Secrets are listed by `CreatedDate`.
`ListSecretsRequest.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
  - includePlannedDeletion
```
public final Boolean includePlannedDeletion()
```
    Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.
    
    Returns:
    
    Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.
  - maxResults
```
public final Integer maxResults()
```
    The number of results to include in the response.
    
    If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.
    
    Returns:
    
    The number of results to include in the response.
    
    If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.
  - nextToken
```
public final String nextToken()
```
    A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.
    
    Returns:
    
    A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.
  - 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()
```
    The filters to apply to the list of secrets.
    
    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:
    
    The filters to apply to the list of secrets.
  - sortOrder
```
public final SortOrderType sortOrder()
```
    Secrets are listed by CreatedDate.
    
    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().
    
    Returns:
    
    Secrets are listed by CreatedDate.
    
    See Also:
    
    SortOrderType
  - sortOrderAsString
```
public final String sortOrderAsString()
```
    Secrets are listed by CreatedDate.
    
    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().
    
    Returns:
    
    Secrets are listed by CreatedDate.
    
    See Also:
    
    SortOrderType
  - sortBy
```
public final SortByType sortBy()
```
    If not specified, secrets are listed by CreatedDate.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return SortByType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    If not specified, secrets are listed by CreatedDate.
    
    See Also:
    
    SortByType
  - sortByAsString
```
public final String sortByAsString()
```
    If not specified, secrets are listed by CreatedDate.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return SortByType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    If not specified, secrets are listed by CreatedDate.
    
    See Also:
    
    SortByType
  - toBuilder
```
public ListSecretsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListSecretsRequest.Builder,ListSecretsRequest>
    
    Specified by:
    
    toBuilder in class SecretsManagerRequest
  - builder
```
public static ListSecretsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListSecretsRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListSecretsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

includePlannedDeletion

maxResults

nextToken

hasFilters

filters

sortOrder

sortOrderAsString

sortBy

sortByAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField