com.amazonaws.services.datasync.model

Class CreateLocationObjectStorageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.CreateLocationObjectStorageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

CreateLocationObjectStorageRequest

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateLocationObjectStorageRequest()

Method Summary

Modifier and Type	Method and Description
CreateLocationObjectStorageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccessKey() Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
List<String>	getAgentArns() Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
String	getBucketName() Specifies the name of the object storage bucket involved in the transfer.
String	getSecretKey() Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
ByteBuffer	getServerCertificate() Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem).
String	getServerHostname() Specifies the domain name or IP address of the object storage server.
Integer	getServerPort() Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
String	getServerProtocol() Specifies the protocol that your object storage server uses to communicate.
String	getSubdirectory() Specifies the object prefix for your object storage server.
List<TagListEntry>	getTags() Specifies the key-value pair that represents a tag that you want to add to the resource.
int	hashCode()
void	setAccessKey(String accessKey) Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
void	setAgentArns(Collection<String> agentArns) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
void	setBucketName(String bucketName) Specifies the name of the object storage bucket involved in the transfer.
void	setSecretKey(String secretKey) Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
void	setServerCertificate(ByteBuffer serverCertificate) Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem).
void	setServerHostname(String serverHostname) Specifies the domain name or IP address of the object storage server.
void	setServerPort(Integer serverPort) Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
void	setServerProtocol(String serverProtocol) Specifies the protocol that your object storage server uses to communicate.
void	setSubdirectory(String subdirectory) Specifies the object prefix for your object storage server.
void	setTags(Collection<TagListEntry> tags) Specifies the key-value pair that represents a tag that you want to add to the resource.
String	toString() Returns a string representation of this object.
CreateLocationObjectStorageRequest	withAccessKey(String accessKey) Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
CreateLocationObjectStorageRequest	withAgentArns(Collection<String> agentArns) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
CreateLocationObjectStorageRequest	withAgentArns(String... agentArns) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
CreateLocationObjectStorageRequest	withBucketName(String bucketName) Specifies the name of the object storage bucket involved in the transfer.
CreateLocationObjectStorageRequest	withSecretKey(String secretKey) Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
CreateLocationObjectStorageRequest	withServerCertificate(ByteBuffer serverCertificate) Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem).
CreateLocationObjectStorageRequest	withServerHostname(String serverHostname) Specifies the domain name or IP address of the object storage server.
CreateLocationObjectStorageRequest	withServerPort(Integer serverPort) Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
CreateLocationObjectStorageRequest	withServerProtocol(ObjectStorageServerProtocol serverProtocol) Specifies the protocol that your object storage server uses to communicate.
CreateLocationObjectStorageRequest	withServerProtocol(String serverProtocol) Specifies the protocol that your object storage server uses to communicate.
CreateLocationObjectStorageRequest	withSubdirectory(String subdirectory) Specifies the object prefix for your object storage server.
CreateLocationObjectStorageRequest	withTags(Collection<TagListEntry> tags) Specifies the key-value pair that represents a tag that you want to add to the resource.
CreateLocationObjectStorageRequest	withTags(TagListEntry... tags) Specifies the key-value pair that represents a tag that you want to add to the resource.

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

CreateLocationObjectStorageRequest

public CreateLocationObjectStorageRequest()

Method Detail

setServerHostname

public void setServerHostname(String serverHostname)

Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

Parameters:

serverHostname - Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

getServerHostname

public String getServerHostname()

Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

Returns:

Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

withServerHostname

public CreateLocationObjectStorageRequest withServerHostname(String serverHostname)

Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

Parameters:

serverHostname - Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

Returns:

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

setServerPort

public void setServerPort(Integer serverPort)

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

Parameters:

serverPort - Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

getServerPort

public Integer getServerPort()

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

Returns:

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

withServerPort

public CreateLocationObjectStorageRequest withServerPort(Integer serverPort)

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

Parameters:

serverPort - Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

Returns:

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

setServerProtocol

public void setServerProtocol(String serverProtocol)

Specifies the protocol that your object storage server uses to communicate.

Parameters:

serverProtocol - Specifies the protocol that your object storage server uses to communicate.

See Also:

ObjectStorageServerProtocol

getServerProtocol

public String getServerProtocol()

Specifies the protocol that your object storage server uses to communicate.

Returns:

Specifies the protocol that your object storage server uses to communicate.

See Also:

ObjectStorageServerProtocol

withServerProtocol

public CreateLocationObjectStorageRequest withServerProtocol(String serverProtocol)

Specifies the protocol that your object storage server uses to communicate.

Parameters:

serverProtocol - Specifies the protocol that your object storage server uses to communicate.

Returns:

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

See Also:

ObjectStorageServerProtocol

withServerProtocol

public CreateLocationObjectStorageRequest withServerProtocol(ObjectStorageServerProtocol serverProtocol)

Specifies the protocol that your object storage server uses to communicate.

Parameters:

serverProtocol - Specifies the protocol that your object storage server uses to communicate.

Returns:

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

See Also:

ObjectStorageServerProtocol

setSubdirectory

public void setSubdirectory(String subdirectory)

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

Parameters:

subdirectory - Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

getSubdirectory

public String getSubdirectory()

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

Returns:

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

withSubdirectory

public CreateLocationObjectStorageRequest withSubdirectory(String subdirectory)

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

Parameters:

subdirectory - Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

Returns:

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

setBucketName

public void setBucketName(String bucketName)

Specifies the name of the object storage bucket involved in the transfer.

Parameters:

bucketName - Specifies the name of the object storage bucket involved in the transfer.

getBucketName

public String getBucketName()

Specifies the name of the object storage bucket involved in the transfer.

Returns:

Specifies the name of the object storage bucket involved in the transfer.

withBucketName

public CreateLocationObjectStorageRequest withBucketName(String bucketName)

Specifies the name of the object storage bucket involved in the transfer.

Parameters:

bucketName - Specifies the name of the object storage bucket involved in the transfer.

Returns:

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

setAccessKey

public void setAccessKey(String accessKey)

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

Parameters:

accessKey - Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

getAccessKey

public String getAccessKey()

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

Returns:

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

withAccessKey

public CreateLocationObjectStorageRequest withAccessKey(String accessKey)

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

Parameters:

accessKey - Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

Returns:

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

setSecretKey

public void setSecretKey(String secretKey)

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

Parameters:

secretKey - Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

getSecretKey

public String getSecretKey()

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

Returns:

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

withSecretKey

public CreateLocationObjectStorageRequest withSecretKey(String secretKey)

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

Parameters:

secretKey - Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

Returns:

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

getAgentArns

public List<String> getAgentArns()

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

Returns:

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

setAgentArns

public void setAgentArns(Collection<String> agentArns)

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

Parameters:

agentArns - Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

withAgentArns

public CreateLocationObjectStorageRequest withAgentArns(String... agentArns)

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

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

Parameters:

agentArns - Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

Returns:

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

withAgentArns

public CreateLocationObjectStorageRequest withAgentArns(Collection<String> agentArns)

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

Parameters:

agentArns - Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

Returns:

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

getTags

public List<TagListEntry> getTags()

Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

Returns:

Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

setTags

public void setTags(Collection<TagListEntry> tags)

Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

Parameters:

tags - Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

withTags

public CreateLocationObjectStorageRequest withTags(TagListEntry... tags)

Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

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

Parameters:

tags - Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

Returns:

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

withTags

public CreateLocationObjectStorageRequest withTags(Collection<TagListEntry> tags)

Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

Parameters:

tags - Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

Returns:

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

setServerCertificate

public void setServerCertificate(ByteBuffer serverCertificate)

Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The file you specify must include the following:

• The certificate of the signing certificate authority (CA)

• Any intermediate certificates

• base64 encoding

• A .pem extension

The file can be up to 32768 bytes (before base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

serverCertificate - Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The file you specify must include the following:

• The certificate of the signing certificate authority (CA)

• Any intermediate certificates

• base64 encoding

• A .pem extension

The file can be up to 32768 bytes (before base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

getServerCertificate

public ByteBuffer getServerCertificate()

Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The file you specify must include the following:

• The certificate of the signing certificate authority (CA)

• Any intermediate certificates

• base64 encoding

• A .pem extension

The file can be up to 32768 bytes (before base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The file you specify must include the following:

• The certificate of the signing certificate authority (CA)

• Any intermediate certificates

• base64 encoding

• A .pem extension

The file can be up to 32768 bytes (before base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

withServerCertificate

public CreateLocationObjectStorageRequest withServerCertificate(ByteBuffer serverCertificate)

Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The file you specify must include the following:

• The certificate of the signing certificate authority (CA)

• Any intermediate certificates

• base64 encoding

• A .pem extension

The file can be up to 32768 bytes (before base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

serverCertificate - Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The file you specify must include the following:

• The certificate of the signing certificate authority (CA)

• Any intermediate certificates

• base64 encoding

• A .pem extension

The file can be up to 32768 bytes (before base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

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