software.amazon.awssdk.services.datasync.model

Class DescribeLocationObjectStorageResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.datasync.model.DataSyncResponse

software.amazon.awssdk.services.datasync.model.DescribeLocationObjectStorageResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeLocationObjectStorageResponse.Builder,DescribeLocationObjectStorageResponse>

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

DescribeLocationObjectStorageResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeLocationObjectStorageResponse.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 DescribeLocationObjectStorageResponse.Builder	builder()
Instant	creationTime() The time that the self-managed object storage server agent was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
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()
String	locationArn() The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.
String	locationUri() The URL of the source self-managed object storage server location that was described.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeLocationObjectStorageResponse.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.
DescribeLocationObjectStorageResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.datasync.model.DataSyncResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

Returns:

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

locationUri

public final String locationUri()

The URL of the source self-managed object storage server location that was described.

Returns:

The URL of the source self-managed object storage server location that was described.

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.

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

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

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

hasAgentArns

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

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.

creationTime

public final Instant creationTime()

The time that the self-managed object storage server agent was created.

Returns:

The time that the self-managed object storage server agent was created.

toBuilder

public DescribeLocationObjectStorageResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeLocationObjectStorageResponse.Builder,DescribeLocationObjectStorageResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeLocationObjectStorageResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.