Class DescribeDocumentRequest
- 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.DescribeDocumentRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeDocumentRequest.Builder,DescribeDocumentRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDocumentRequest extends SsmRequest implements ToCopyableBuilder<DescribeDocumentRequest.Builder,DescribeDocumentRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeDocumentRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeDocumentRequest.Builder
builder()
String
documentVersion()
The document version for which you want information.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
name()
The name of the SSM document.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeDocumentRequest.Builder>
serializableBuilderClass()
DescribeDocumentRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
versionName()
An optional field specifying the version of the artifact associated with the document.-
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 of the SSM document.
- Returns:
- The name of the SSM document.
-
documentVersion
public final String documentVersion()
The document version for which you want information. Can be a specific version or the default version.
- Returns:
- The document version for which you want information. Can be a specific version or the default version.
-
versionName
public final String versionName()
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
- Returns:
- An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
-
toBuilder
public DescribeDocumentRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeDocumentRequest.Builder,DescribeDocumentRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static DescribeDocumentRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeDocumentRequest.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
-
-