@Generated(value="software.amazon.awssdk:codegen") public final class DescribeDocumentPermissionRequest extends SsmRequest implements ToCopyableBuilder<DescribeDocumentPermissionRequest.Builder,DescribeDocumentPermissionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeDocumentPermissionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeDocumentPermissionRequest.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() |
Integer |
maxResults()
The maximum number of items to return for this call.
|
String |
name()
The name of the document for which you are the owner.
|
String |
nextToken()
The token for the next set of items to return.
|
DocumentPermissionType |
permissionType()
The permission type for the document.
|
String |
permissionTypeAsString()
The permission type for the document.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeDocumentPermissionRequest.Builder> |
serializableBuilderClass() |
DescribeDocumentPermissionRequest.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.
|
overrideConfiguration
copy
public final String name()
The name of the document for which you are the owner.
public final DocumentPermissionType permissionType()
The permission type for the document. The permission type can be Share.
If the service returns an enum value that is not available in the current SDK version, permissionType
will return DocumentPermissionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from permissionTypeAsString()
.
DocumentPermissionType
public final String permissionTypeAsString()
The permission type for the document. The permission type can be Share.
If the service returns an enum value that is not available in the current SDK version, permissionType
will return DocumentPermissionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from permissionTypeAsString()
.
DocumentPermissionType
public final Integer maxResults()
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
public final String nextToken()
The token for the next set of items to return. (You received this token from a previous call.)
public DescribeDocumentPermissionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeDocumentPermissionRequest.Builder,DescribeDocumentPermissionRequest>
toBuilder
in class SsmRequest
public static DescribeDocumentPermissionRequest.Builder builder()
public static Class<? extends DescribeDocumentPermissionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
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 SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.