software.amazon.awssdk.services.datasync.model

Class CreateLocationObjectStorageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.CreateLocationObjectStorageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,CreateLocationObjectStorageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateLocationObjectStorageRequest
extends DataSyncRequest
implements ToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,CreateLocationObjectStorageRequest>

CreateLocationObjectStorageRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLocationObjectStorageRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accessKey() Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
List<String>	agentArns() Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
String	bucketName() Specifies the name of the object storage bucket involved in the transfer.
static CreateLocationObjectStorageRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentArns() For responses, this returns true if the service returned a value for the AgentArns property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
String	secretKey() Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
static Class<? extends CreateLocationObjectStorageRequest.Builder>	serializableBuilderClass()
SdkBytes	serverCertificate() Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA).
String	serverHostname() Specifies the domain name or IP address of the object storage server.
Integer	serverPort() Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
ObjectStorageServerProtocol	serverProtocol() Specifies the protocol that your object storage server uses to communicate.
String	serverProtocolAsString() Specifies the protocol that your object storage server uses to communicate.
String	subdirectory() Specifies the object prefix for your object storage server.
List<TagListEntry>	tags() Specifies the key-value pair that represents a tag that you want to add to the resource.
CreateLocationObjectStorageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

serverHostname

public final 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.

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.

serverPort

public final Integer serverPort()

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

serverProtocol

public final ObjectStorageServerProtocol serverProtocol()

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

If the service returns an enum value that is not available in the current SDK version, serverProtocol will return ObjectStorageServerProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverProtocolAsString().

Returns:

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

See Also:

ObjectStorageServerProtocol

serverProtocolAsString

public final String serverProtocolAsString()

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

If the service returns an enum value that is not available in the current SDK version, serverProtocol will return ObjectStorageServerProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverProtocolAsString().

Returns:

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

See Also:

ObjectStorageServerProtocol

subdirectory

public final 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.

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.

bucketName

public final String bucketName()

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.

accessKey

public final String accessKey()

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.

secretKey

public final String secretKey()

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.

hasAgentArns

public final boolean hasAgentArns()

For responses, this returns true if the service returned a value for the AgentArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

agentArns

public final List<String> agentArns()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAgentArns() method.

Returns:

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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.

serverCertificate

public final SdkBytes serverCertificate()

Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

Returns:

Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).

To use this parameter, configure ServerProtocol to HTTPS.

toBuilder

public CreateLocationObjectStorageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,CreateLocationObjectStorageRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static CreateLocationObjectStorageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateLocationObjectStorageRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo