com.amazonaws.services.workdocs.model

Class CreateCustomMetadataRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workdocs.model.CreateCustomMetadataRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateCustomMetadataRequest	addCustomMetadataEntry(String key, String value) Add a single CustomMetadata entry
CreateCustomMetadataRequest	clearCustomMetadataEntries() Removes all the entries added into CustomMetadata.
CreateCustomMetadataRequest	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.
Map<String,String>	getCustomMetadata() Custom metadata in the form of name-value pairs.
String	getResourceId() The ID of the resource.
String	getVersionId() The ID of the version, if the custom metadata is being added to a document version.
int	hashCode()
void	setAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
void	setCustomMetadata(Map<String,String> customMetadata) Custom metadata in the form of name-value pairs.
void	setResourceId(String resourceId) The ID of the resource.
void	setVersionId(String versionId) The ID of the version, if the custom metadata is being added to a document version.
String	toString() Returns a string representation of this object.
CreateCustomMetadataRequest	withAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
CreateCustomMetadataRequest	withCustomMetadata(Map<String,String> customMetadata) Custom metadata in the form of name-value pairs.
CreateCustomMetadataRequest	withResourceId(String resourceId) The ID of the resource.
CreateCustomMetadataRequest	withVersionId(String versionId) The ID of the version, if the custom metadata is being added to 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

CreateCustomMetadataRequest

public CreateCustomMetadataRequest()

Method Detail

setAuthenticationToken

public void setAuthenticationToken(String authenticationToken)

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

Parameters:

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

getAuthenticationToken

public String getAuthenticationToken()

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

Returns:

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

withAuthenticationToken

public CreateCustomMetadataRequest withAuthenticationToken(String authenticationToken)

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

Parameters:

authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services 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.

Parameters:

resourceId - The ID of the resource.

getResourceId

public String getResourceId()

The ID of the resource.

Returns:

The ID of the resource.

withResourceId

public CreateCustomMetadataRequest withResourceId(String resourceId)

The ID of the resource.

Parameters:

resourceId - The ID of the resource.

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 added to a document version.

Parameters:

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

getVersionId

public String getVersionId()

The ID of the version, if the custom metadata is being added to a document version.

Returns:

The ID of the version, if the custom metadata is being added to a document version.

withVersionId

public CreateCustomMetadataRequest withVersionId(String versionId)

The ID of the version, if the custom metadata is being added to a document version.

Parameters:

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

Returns:

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

getCustomMetadata

public Map<String,String> getCustomMetadata()

Custom metadata in the form of name-value pairs.

Returns:

Custom metadata in the form of name-value pairs.

setCustomMetadata

public void setCustomMetadata(Map<String,String> customMetadata)

Custom metadata in the form of name-value pairs.

Parameters:

customMetadata - Custom metadata in the form of name-value pairs.

withCustomMetadata

public CreateCustomMetadataRequest withCustomMetadata(Map<String,String> customMetadata)

Custom metadata in the form of name-value pairs.

Parameters:

customMetadata - Custom metadata in the form of name-value pairs.

Returns:

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

addCustomMetadataEntry

public CreateCustomMetadataRequest addCustomMetadataEntry(String key,
                                                          String value)

Add a single CustomMetadata entry

See Also:

withCustomMetadata(java.util.Map<java.lang.String, java.lang.String>)

clearCustomMetadataEntries

public CreateCustomMetadataRequest clearCustomMetadataEntries()

Removes all the entries added into CustomMetadata.

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