com.amazonaws.services.datasync.model

Class UpdateLocationObjectStorageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.UpdateLocationObjectStorageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
UpdateLocationObjectStorageRequest	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	getLocationArn() Specifies the ARN of the object storage system location that you're updating.
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 certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).
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.
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	setLocationArn(String locationArn) Specifies the ARN of the object storage system location that you're updating.
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 certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).
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.
String	toString() Returns a string representation of this object.
UpdateLocationObjectStorageRequest	withAccessKey(String accessKey) Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
UpdateLocationObjectStorageRequest	withAgentArns(Collection<String> agentArns) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
UpdateLocationObjectStorageRequest	withAgentArns(String... agentArns) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
UpdateLocationObjectStorageRequest	withLocationArn(String locationArn) Specifies the ARN of the object storage system location that you're updating.
UpdateLocationObjectStorageRequest	withSecretKey(String secretKey) Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
UpdateLocationObjectStorageRequest	withServerCertificate(ByteBuffer serverCertificate) Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).
UpdateLocationObjectStorageRequest	withServerPort(Integer serverPort) Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
UpdateLocationObjectStorageRequest	withServerProtocol(ObjectStorageServerProtocol serverProtocol) Specifies the protocol that your object storage server uses to communicate.
UpdateLocationObjectStorageRequest	withServerProtocol(String serverProtocol) Specifies the protocol that your object storage server uses to communicate.
UpdateLocationObjectStorageRequest	withSubdirectory(String subdirectory) Specifies the object prefix for your object storage server.

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

UpdateLocationObjectStorageRequest

public UpdateLocationObjectStorageRequest()

Method Detail

setLocationArn

public void setLocationArn(String locationArn)

Specifies the ARN of the object storage system location that you're updating.

Parameters:

locationArn - Specifies the ARN of the object storage system location that you're updating.

getLocationArn

public String getLocationArn()

Specifies the ARN of the object storage system location that you're updating.

Returns:

Specifies the ARN of the object storage system location that you're updating.

withLocationArn

public UpdateLocationObjectStorageRequest withLocationArn(String locationArn)

Specifies the ARN of the object storage system location that you're updating.

Parameters:

locationArn - Specifies the ARN of the object storage system location that you're updating.

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 UpdateLocationObjectStorageRequest 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 UpdateLocationObjectStorageRequest 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 UpdateLocationObjectStorageRequest 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 UpdateLocationObjectStorageRequest 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.

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 UpdateLocationObjectStorageRequest 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 UpdateLocationObjectStorageRequest 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 UpdateLocationObjectStorageRequest 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 UpdateLocationObjectStorageRequest 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.

setServerCertificate

public void setServerCertificate(ByteBuffer serverCertificate)

Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

• The object storage system's certificate

• All intermediate certificates (if there are any)

• The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

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 certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

• The object storage system's certificate

• All intermediate certificates (if there are any)

• The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

getServerCertificate

public ByteBuffer getServerCertificate()

Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

• The object storage system's certificate

• All intermediate certificates (if there are any)

• The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

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 certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

• The object storage system's certificate

• All intermediate certificates (if there are any)

• The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

withServerCertificate

public UpdateLocationObjectStorageRequest withServerCertificate(ByteBuffer serverCertificate)

Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

• The object storage system's certificate

• All intermediate certificates (if there are any)

• The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

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 certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

• The object storage system's certificate

• All intermediate certificates (if there are any)

• The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

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