com.amazonaws.services.simplesystemsmanagement.model

Class ModifyDocumentPermissionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.ModifyDocumentPermissionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyDocumentPermissionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyDocumentPermissionRequest()

Method Summary

Modifier and Type	Method and Description
ModifyDocumentPermissionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAccountIdsToAdd() The Amazon Web Services users that should have access to the document.
List<String>	getAccountIdsToRemove() The Amazon Web Services users that should no longer have access to the document.
String	getName() The name of the document that you want to share.
String	getPermissionType() The permission type for the document.
String	getSharedDocumentVersion() (Optional) The version of the document to share.
int	hashCode()
void	setAccountIdsToAdd(Collection<String> accountIdsToAdd) The Amazon Web Services users that should have access to the document.
void	setAccountIdsToRemove(Collection<String> accountIdsToRemove) The Amazon Web Services users that should no longer have access to the document.
void	setName(String name) The name of the document that you want to share.
void	setPermissionType(DocumentPermissionType permissionType) The permission type for the document.
void	setPermissionType(String permissionType) The permission type for the document.
void	setSharedDocumentVersion(String sharedDocumentVersion) (Optional) The version of the document to share.
String	toString() Returns a string representation of this object.
ModifyDocumentPermissionRequest	withAccountIdsToAdd(Collection<String> accountIdsToAdd) The Amazon Web Services users that should have access to the document.
ModifyDocumentPermissionRequest	withAccountIdsToAdd(String... accountIdsToAdd) The Amazon Web Services users that should have access to the document.
ModifyDocumentPermissionRequest	withAccountIdsToRemove(Collection<String> accountIdsToRemove) The Amazon Web Services users that should no longer have access to the document.
ModifyDocumentPermissionRequest	withAccountIdsToRemove(String... accountIdsToRemove) The Amazon Web Services users that should no longer have access to the document.
ModifyDocumentPermissionRequest	withName(String name) The name of the document that you want to share.
ModifyDocumentPermissionRequest	withPermissionType(DocumentPermissionType permissionType) The permission type for the document.
ModifyDocumentPermissionRequest	withPermissionType(String permissionType) The permission type for the document.
ModifyDocumentPermissionRequest	withSharedDocumentVersion(String sharedDocumentVersion) (Optional) The version of the document to share.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyDocumentPermissionRequest

public ModifyDocumentPermissionRequest()

Method Detail

setName

public void setName(String name)

The name of the document that you want to share.

Parameters:

name - The name of the document that you want to share.

getName

public String getName()

The name of the document that you want to share.

Returns:

The name of the document that you want to share.

withName

public ModifyDocumentPermissionRequest withName(String name)

The name of the document that you want to share.

Parameters:

name - The name of the document that you want to share.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPermissionType

public void setPermissionType(String permissionType)

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

Parameters:

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

See Also:

DocumentPermissionType

getPermissionType

public String getPermissionType()

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

Returns:

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

See Also:

DocumentPermissionType

withPermissionType

public ModifyDocumentPermissionRequest withPermissionType(String permissionType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentPermissionType

setPermissionType

public void setPermissionType(DocumentPermissionType permissionType)

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

Parameters:

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

See Also:

DocumentPermissionType

withPermissionType

public ModifyDocumentPermissionRequest withPermissionType(DocumentPermissionType permissionType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentPermissionType

getAccountIdsToAdd

public List<String> getAccountIdsToAdd()

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

Returns:

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

setAccountIdsToAdd

public void setAccountIdsToAdd(Collection<String> accountIdsToAdd)

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

Parameters:

accountIdsToAdd - The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

withAccountIdsToAdd

public ModifyDocumentPermissionRequest withAccountIdsToAdd(String... accountIdsToAdd)

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

NOTE: This method appends the values to the existing list (if any). Use setAccountIdsToAdd(java.util.Collection) or withAccountIdsToAdd(java.util.Collection) if you want to override the existing values.

Parameters:

accountIdsToAdd - The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAccountIdsToAdd

public ModifyDocumentPermissionRequest withAccountIdsToAdd(Collection<String> accountIdsToAdd)

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

Parameters:

accountIdsToAdd - The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAccountIdsToRemove

public List<String> getAccountIdsToRemove()

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

Returns:

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

setAccountIdsToRemove

public void setAccountIdsToRemove(Collection<String> accountIdsToRemove)

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

Parameters:

accountIdsToRemove - The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

withAccountIdsToRemove

public ModifyDocumentPermissionRequest withAccountIdsToRemove(String... accountIdsToRemove)

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

NOTE: This method appends the values to the existing list (if any). Use setAccountIdsToRemove(java.util.Collection) or withAccountIdsToRemove(java.util.Collection) if you want to override the existing values.

Parameters:

accountIdsToRemove - The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAccountIdsToRemove

public ModifyDocumentPermissionRequest withAccountIdsToRemove(Collection<String> accountIdsToRemove)

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

Parameters:

accountIdsToRemove - The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSharedDocumentVersion

public void setSharedDocumentVersion(String sharedDocumentVersion)

(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

Parameters:

sharedDocumentVersion - (Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

getSharedDocumentVersion

public String getSharedDocumentVersion()

(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

Returns:

(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

withSharedDocumentVersion

public ModifyDocumentPermissionRequest withSharedDocumentVersion(String sharedDocumentVersion)

(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

Parameters:

sharedDocumentVersion - (Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ModifyDocumentPermissionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()