@Generated(value="software.amazon.awssdk:codegen") public final class GetSecretValueRequest extends SecretsManagerRequest implements ToCopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetSecretValueRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetSecretValueRequest.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() |
List<SdkField<?>> |
sdkFields() |
String |
secretId()
Specifies the secret containing the version that you want to retrieve.
|
static Class<? extends GetSecretValueRequest.Builder> |
serializableBuilderClass() |
GetSecretValueRequest.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.
|
String |
versionId()
Specifies the unique identifier of the version of the secret that you want to retrieve.
|
String |
versionStage()
Specifies the secret version that you want to retrieve by the staging label attached to the version.
|
overrideConfigurationcopypublic final String secretId()
Specifies the secret containing the version that you want to retrieve. 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 String versionId()
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this
parameter and VersionStage, the two parameters must refer to the same secret version. If you don't
specify either a VersionStage or VersionId then the default is to perform the operation
on the version with the VersionStage value of AWSCURRENT.
This value is typically a UUID-type value with 32 hexadecimal digits.
VersionStage, the two parameters must refer to the same secret
version. If you don't specify either a VersionStage or VersionId then the
default is to perform the operation on the version with the VersionStage value of
AWSCURRENT.
This value is typically a UUID-type value with 32 hexadecimal digits.
public final String versionStage()
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this
parameter and VersionId, the two parameters must refer to the same secret version . If you don't
specify either a VersionStage or VersionId, then the default is to perform the
operation on the version with the VersionStage value of AWSCURRENT.
Staging labels are used to keep track of different versions during the rotation process. If you specify
both this parameter and VersionId, the two parameters must refer to the same secret version
. If you don't specify either a VersionStage or VersionId, then the default is
to perform the operation on the version with the VersionStage value of
AWSCURRENT.
public GetSecretValueRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>toBuilder in class SecretsManagerRequestpublic static GetSecretValueRequest.Builder builder()
public static Class<? extends GetSecretValueRequest.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.