Class GetParameterRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ssm.model.SsmRequest
-
- software.amazon.awssdk.services.ssm.model.GetParameterRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetParameterRequest.Builder,GetParameterRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetParameterRequest extends SsmRequest implements ToCopyableBuilder<GetParameterRequest.Builder,GetParameterRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetParameterRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetParameterRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
name()
The name or Amazon Resource Name (ARN) of the parameter that you want to query.List<SdkField<?>>
sdkFields()
static Class<? extends GetParameterRequest.Builder>
serializableBuilderClass()
GetParameterRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.Boolean
withDecryption()
Return decrypted values for secure string parameters.-
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
-
name
public final String name()
The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.
To query by parameter label, use
"Name": "name:label"
. To query by parameter version, use"Name": "name:version"
.For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
- Returns:
- The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared
with you from another account, you must use the full ARN.
To query by parameter label, use
"Name": "name:label"
. To query by parameter version, use"Name": "name:version"
.For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
-
withDecryption
public final Boolean withDecryption()
Return decrypted values for secure string parameters. This flag is ignored for
String
andStringList
parameter types.- Returns:
- Return decrypted values for secure string parameters. This flag is ignored for
String
andStringList
parameter types.
-
toBuilder
public GetParameterRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetParameterRequest.Builder,GetParameterRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static GetParameterRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetParameterRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-