Class GetParametersRequest
- 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.GetParametersRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetParametersRequest.Builder,GetParametersRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetParametersRequest extends SsmRequest implements ToCopyableBuilder<GetParametersRequest.Builder,GetParametersRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetParametersRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetParametersRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasNames()
For responses, this returns true if the service returned a value for the Names property.List<String>
names()
Names of the parameters for which you want to query information.List<SdkField<?>>
sdkFields()
static Class<? extends GetParametersRequest.Builder>
serializableBuilderClass()
GetParametersRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.Boolean
withDecryption()
Return decrypted secure string value.-
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
-
hasNames
public final boolean hasNames()
For responses, this returns true if the service returned a value for the Names 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.
-
names
public final List<String> names()
Names of the parameters for which you want to query information.
To query by parameter label, use
"Name": "name:label"
. To query by parameter version, use"Name": "name:version"
.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
hasNames()
method.- Returns:
- Names of the parameters for which you want to query information.
To query by parameter label, use
"Name": "name:label"
. To query by parameter version, use"Name": "name:version"
.
-
withDecryption
public final Boolean withDecryption()
Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for
String
andStringList
parameter types.- Returns:
- Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is
ignored for
String
andStringList
parameter types.
-
toBuilder
public GetParametersRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetParametersRequest.Builder,GetParametersRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static GetParametersRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetParametersRequest.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
-
-