Package software.amazon.awssdk.services.secretsmanager.model

Class ListSecretVersionIdsRequest

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.ListSecretVersionIdsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListSecretVersionIdsRequest.Builder,ListSecretVersionIdsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListSecretVersionIdsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListSecretVersionIdsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeDeprecated()	Specifies whether to include versions of secrets that don't have any staging labels attached to them.
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()
String	secretId()	The ARN or name of the secret whose versions you want to list.
static Class<? extends ListSecretVersionIdsRequest.Builder>	serializableBuilderClass()
ListSecretVersionIdsRequest.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

secretId

public final String secretId()

The ARN or name of the secret whose versions you want to list.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Returns:

The ARN or name of the secret whose versions you want to list.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

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 ListSecretVersionIds 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 ListSecretVersionIds 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 ListSecretVersionIds 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 ListSecretVersionIds again with this value.

includeDeprecated

public final Boolean includeDeprecated()

Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager. By default, versions without staging labels aren't included.

Returns:

Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager. By default, versions without staging labels aren't included.

toBuilder

public ListSecretVersionIdsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListSecretVersionIdsRequest.Builder,ListSecretVersionIdsRequest>

Specified by:

toBuilder in class SecretsManagerRequest

builder

public static ListSecretVersionIdsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListSecretVersionIdsRequest.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