Class GetSecretValueResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetSecretValueResponse.Builder,
GetSecretValueResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the secret.builder()
final Instant
The date and time that this version of the secret was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the VersionStages property.final String
name()
The friendly name of the secret.final SdkBytes
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array.final String
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.static Class
<? extends GetSecretValueResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The unique identifier of this version of the secret.A list of all of the staging labels currently attached to this version of the secret.Methods inherited from class software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The ARN of the secret.
- Returns:
- The ARN of the secret.
-
name
The friendly name of the secret.
- Returns:
- The friendly name of the secret.
-
versionId
The unique identifier of this version of the secret.
- Returns:
- The unique identifier of this version of the secret.
-
secretBinary
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a
SecretBinary
using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in
SecretString
instead.- Returns:
- The decrypted secret value, if the secret value was originally provided as binary data in the form of a
byte array. When you retrieve a
SecretBinary
using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in
SecretString
instead.
-
secretString
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
- Returns:
- The decrypted secret value, if the secret value was originally provided as a string or through the
Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
-
hasVersionStages
public final boolean hasVersionStages()For responses, this returns true if the service returned a value for the VersionStages property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
versionStages
A list of all of the staging labels currently attached to this version of the secret.
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
hasVersionStages()
method.- Returns:
- A list of all of the staging labels currently attached to this version of the secret.
-
createdDate
The date and time that this version of the secret was created. If you don't specify which version in
VersionId
orVersionStage
, then Secrets Manager uses theAWSCURRENT
version.- Returns:
- The date and time that this version of the secret was created. If you don't specify which version in
VersionId
orVersionStage
, then Secrets Manager uses theAWSCURRENT
version.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetSecretValueResponse.Builder,
GetSecretValueResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-