Package software.amazon.awssdk.services.ssm.model

Class DescribeDocumentPermissionRequest

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.DescribeDocumentPermissionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDocumentPermissionRequest.Builder,DescribeDocumentPermissionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeDocumentPermissionRequest
extends SsmRequest
implements ToCopyableBuilder<DescribeDocumentPermissionRequest.Builder,DescribeDocumentPermissionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDocumentPermissionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDocumentPermissionRequest.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Integer	maxResults()	The maximum number of items to return for this call.
final String	name()	The name of the document for which you are the owner.
final String	nextToken()	The token for the next set of items to return.
final DocumentPermissionType	permissionType()	The permission type for the document.
final String	permissionTypeAsString()	The permission type for the document.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDocumentPermissionRequest.Builder>	serializableBuilderClass()
DescribeDocumentPermissionRequest.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

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 Details

name

public final String name()

The name of the document for which you are the owner.

Returns:

The name of the document for which you are the owner.

permissionType

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().

Returns:

The permission type for the document. The permission type can be Share.

See Also:

• DocumentPermissionType

permissionTypeAsString

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().

Returns:

The permission type for the document. The permission type can be Share.

See Also:

• DocumentPermissionType

maxResults

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.

Returns:

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.

nextToken

public final String nextToken()

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

toBuilder

public DescribeDocumentPermissionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDocumentPermissionRequest.Builder,DescribeDocumentPermissionRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static DescribeDocumentPermissionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDocumentPermissionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo