software.amazon.awssdk.services.datasync.model

Class UpdateLocationObjectStorageRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateLocationObjectStorageRequest.Builder,UpdateLocationObjectStorageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateLocationObjectStorageRequest.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.
static UpdateLocationObjectStorageRequest.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()
String	locationArn() The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.
List<SdkField<?>>	sdkFields()
String	secretKey() Optional.
static Class<? extends UpdateLocationObjectStorageRequest.Builder>	serializableBuilderClass()
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.
UpdateLocationObjectStorageRequest.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

locationArn

public final String locationArn()

The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.

Returns:

The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.

serverPort

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

accessKey

public final String accessKey()

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

Returns:

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

secretKey

public final String secretKey()

Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

Returns:

Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

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

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.

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:

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

toBuilder

public UpdateLocationObjectStorageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateLocationObjectStorageRequest.Builder,UpdateLocationObjectStorageRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static UpdateLocationObjectStorageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateLocationObjectStorageRequest.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