com.amazonaws.services.workdocs.model

Class DeleteCustomMetadataRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workdocs.model.DeleteCustomMetadataRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeleteCustomMetadataRequest
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
DeleteCustomMetadataRequest()

Method Summary

Modifier and Type	Method and Description
DeleteCustomMetadataRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAuthenticationToken() Amazon WorkDocs authentication token.
Boolean	getDeleteAll() Flag to indicate removal of all custom metadata properties from the specified resource.
List<String>	getKeys() List of properties to remove.
String	getResourceId() The ID of the resource, either a document or folder.
String	getVersionId() The ID of the version, if the custom metadata is being deleted from a document version.
int	hashCode()
Boolean	isDeleteAll() Flag to indicate removal of all custom metadata properties from the specified resource.
void	setAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
void	setDeleteAll(Boolean deleteAll) Flag to indicate removal of all custom metadata properties from the specified resource.
void	setKeys(Collection<String> keys) List of properties to remove.
void	setResourceId(String resourceId) The ID of the resource, either a document or folder.
void	setVersionId(String versionId) The ID of the version, if the custom metadata is being deleted from a document version.
String	toString() Returns a string representation of this object.
DeleteCustomMetadataRequest	withAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
DeleteCustomMetadataRequest	withDeleteAll(Boolean deleteAll) Flag to indicate removal of all custom metadata properties from the specified resource.
DeleteCustomMetadataRequest	withKeys(Collection<String> keys) List of properties to remove.
DeleteCustomMetadataRequest	withKeys(String... keys) List of properties to remove.
DeleteCustomMetadataRequest	withResourceId(String resourceId) The ID of the resource, either a document or folder.
DeleteCustomMetadataRequest	withVersionId(String versionId) The ID of the version, if the custom metadata is being deleted from a document version.

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

DeleteCustomMetadataRequest

public DeleteCustomMetadataRequest()

Method Detail

setAuthenticationToken

public void setAuthenticationToken(String authenticationToken)

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Parameters:

authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

getAuthenticationToken

public String getAuthenticationToken()

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Returns:

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

withAuthenticationToken

public DeleteCustomMetadataRequest withAuthenticationToken(String authenticationToken)

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Parameters:

authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Returns:

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

setResourceId

public void setResourceId(String resourceId)

The ID of the resource, either a document or folder.

Parameters:

resourceId - The ID of the resource, either a document or folder.

getResourceId

public String getResourceId()

The ID of the resource, either a document or folder.

Returns:

The ID of the resource, either a document or folder.

withResourceId

public DeleteCustomMetadataRequest withResourceId(String resourceId)

The ID of the resource, either a document or folder.

Parameters:

resourceId - The ID of the resource, either a document or folder.

Returns:

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

setVersionId

public void setVersionId(String versionId)

The ID of the version, if the custom metadata is being deleted from a document version.

Parameters:

versionId - The ID of the version, if the custom metadata is being deleted from a document version.

getVersionId

public String getVersionId()

The ID of the version, if the custom metadata is being deleted from a document version.

Returns:

The ID of the version, if the custom metadata is being deleted from a document version.

withVersionId

public DeleteCustomMetadataRequest withVersionId(String versionId)

The ID of the version, if the custom metadata is being deleted from a document version.

Parameters:

versionId - The ID of the version, if the custom metadata is being deleted from a document version.

Returns:

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

getKeys

public List<String> getKeys()

List of properties to remove.

Returns:

List of properties to remove.

setKeys

public void setKeys(Collection<String> keys)

List of properties to remove.

Parameters:

keys - List of properties to remove.

withKeys

public DeleteCustomMetadataRequest withKeys(String... keys)

List of properties to remove.

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

Parameters:

keys - List of properties to remove.

Returns:

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

withKeys

public DeleteCustomMetadataRequest withKeys(Collection<String> keys)

List of properties to remove.

Parameters:

keys - List of properties to remove.

Returns:

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

setDeleteAll

public void setDeleteAll(Boolean deleteAll)

Flag to indicate removal of all custom metadata properties from the specified resource.

Parameters:

deleteAll - Flag to indicate removal of all custom metadata properties from the specified resource.

getDeleteAll

public Boolean getDeleteAll()

Flag to indicate removal of all custom metadata properties from the specified resource.

Returns:

Flag to indicate removal of all custom metadata properties from the specified resource.

withDeleteAll

public DeleteCustomMetadataRequest withDeleteAll(Boolean deleteAll)

Flag to indicate removal of all custom metadata properties from the specified resource.

Parameters:

deleteAll - Flag to indicate removal of all custom metadata properties from the specified resource.

Returns:

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

isDeleteAll

public Boolean isDeleteAll()

Flag to indicate removal of all custom metadata properties from the specified resource.

Returns:

Flag to indicate removal of all custom metadata properties from the specified resource.

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