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() Optional.
List<String>	agentArns() The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
String	bucketName() The bucket on the self-managed object storage server that is used to read data from.
static CreateLocationObjectStorageRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentArns() Returns true if the AgentArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
String	secretKey() Optional.
static Class<? extends CreateLocationObjectStorageRequest.Builder>	serializableBuilderClass()
String	serverHostname() The name of the self-managed object storage server.
Integer	serverPort() The port that your self-managed object storage server accepts inbound network traffic on.
ObjectStorageServerProtocol	serverProtocol() The protocol that the object storage server uses to communicate.
String	serverProtocolAsString() The protocol that the object storage server uses to communicate.
String	subdirectory() The subdirectory in the self-managed object storage server that is used to read data from.
List<TagListEntry>	tags() The key-value pair that represents the tag that you want to add to the location.
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 String serverHostname()

The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.

Returns:

The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.

serverPort

public Integer serverPort()

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

Returns:

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

serverProtocol

public ObjectStorageServerProtocol serverProtocol()

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

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:

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

See Also:

ObjectStorageServerProtocol

serverProtocolAsString

public String serverProtocolAsString()

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

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:

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

See Also:

ObjectStorageServerProtocol

subdirectory

public String subdirectory()

The subdirectory in the self-managed object storage server that is used to read data from.

Returns:

The subdirectory in the self-managed object storage server that is used to read data from.

bucketName

public String bucketName()

The bucket on the self-managed object storage server that is used to read data from.

Returns:

The bucket on the self-managed object storage server that is used to read data from.

accessKey

public String accessKey()

Optional. The access key is used if credentials are required to access the self-managed object storage server.

Returns:

Optional. The access key is used if credentials are required to access the self-managed object storage server.

secretKey

public String secretKey()

Optional. The secret key is used if credentials are required to access the self-managed object storage server.

Returns:

Optional. The secret key is used if credentials are required to access the self-managed object storage server.

hasAgentArns

public boolean hasAgentArns()

Returns true if the AgentArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

agentArns

public List<String> agentArns()

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

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

You can use hasAgentArns() to see if a value was sent in this field.

Returns:

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public List<TagListEntry> tags()

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo