software.amazon.awssdk.services.ssm.model

Class DescribeDocumentPermissionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ssm.model.SsmResponse

software.amazon.awssdk.services.ssm.model.DescribeDocumentPermissionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDocumentPermissionResponse.Builder,DescribeDocumentPermissionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDocumentPermissionResponse
extends SsmResponse
implements ToCopyableBuilder<DescribeDocumentPermissionResponse.Builder,DescribeDocumentPermissionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDocumentPermissionResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	accountIds() The account IDs that have permission to use this document.
List<AccountSharingInfo>	accountSharingInfoList() A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.
static DescribeDocumentPermissionResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccountIds() For responses, this returns true if the service returned a value for the AccountIds property.
boolean	hasAccountSharingInfoList() For responses, this returns true if the service returned a value for the AccountSharingInfoList property.
int	hashCode()
String	nextToken() The token for the next set of items to return.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDocumentPermissionResponse.Builder>	serializableBuilderClass()
DescribeDocumentPermissionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasAccountIds

public final boolean hasAccountIds()

For responses, this returns true if the service returned a value for the AccountIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

accountIds

public final List<String> accountIds()

The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.

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

Returns:

The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.

hasAccountSharingInfoList

public final boolean hasAccountSharingInfoList()

For responses, this returns true if the service returned a value for the AccountSharingInfoList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

accountSharingInfoList

public final List<AccountSharingInfo> accountSharingInfoList()

A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

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

Returns:

A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

nextToken

public final String nextToken()

The token for the next set of items to return. Use this token to get the next set of results.

Returns:

The token for the next set of items to return. Use this token to get the next set of results.

toBuilder

public DescribeDocumentPermissionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDocumentPermissionResponse.Builder,DescribeDocumentPermissionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeDocumentPermissionResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo