@Generated(value="software.amazon.awssdk:codegen") public final class ListSecretVersionIdsRequest extends SecretsManagerRequest implements ToCopyableBuilder<ListSecretVersionIdsRequest.Builder,ListSecretVersionIdsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListSecretVersionIdsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ListSecretVersionIdsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Boolean |
includeDeprecated()
(Optional) Specifies that you want the results to include versions that do not have any staging labels attached
to them.
|
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() |
String |
secretId()
The identifier for the secret containing the versions you want to list.
|
static Class<? extends ListSecretVersionIdsRequest.Builder> |
serializableBuilderClass() |
ListSecretVersionIdsRequest.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.
|
overrideConfiguration
copy
public final String secretId()
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.
If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.
If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.
public 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 includeDeprecated()
(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
public ListSecretVersionIdsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListSecretVersionIdsRequest.Builder,ListSecretVersionIdsRequest>
toBuilder
in class SecretsManagerRequest
public static ListSecretVersionIdsRequest.Builder builder()
public static Class<? extends ListSecretVersionIdsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
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 SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.