Package 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("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	Description
static interface	DescribeLocationObjectStorageResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	accessKey()	The access key (for example, a user name) required to authenticate with the object storage system.
List<String>	agentArns()	The ARNs of the DataSync agents that can connect with your object storage system.
static DescribeLocationObjectStorageResponse.Builder	builder()
Instant	creationTime()	The time that the location was created.
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 ARN of the object storage system location.
String	locationUri()	The URI of the object storage system location.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeLocationObjectStorageResponse.Builder>	serializableBuilderClass()
SdkBytes	serverCertificate()	The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).
Integer	serverPort()	The port that your object storage server accepts inbound network traffic on (for example, port 443).
ObjectStorageServerProtocol	serverProtocol()	The protocol that your object storage system uses to communicate.
String	serverProtocolAsString()	The protocol that your object storage system uses to communicate.
DescribeLocationObjectStorageResponse.Builder	toBuilder()
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

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 ARN of the object storage system location.

Returns:

The ARN of the object storage system location.

locationUri

public final String locationUri()

The URI of the object storage system location.

Returns:

The URI of the object storage system location.

accessKey

public final String accessKey()

The access key (for example, a user name) required to authenticate with the object storage system.

Returns:

The access key (for example, a user name) required to authenticate with the object storage system.

serverPort

public final Integer serverPort()

The port that your object storage server accepts inbound network traffic on (for example, port 443).

Returns:

The port that your object storage server accepts inbound network traffic on (for example, port 443).

serverProtocol

public final ObjectStorageServerProtocol serverProtocol()

The protocol that your object storage system 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:

The protocol that your object storage system uses to communicate.

See Also:

ObjectStorageServerProtocol

serverProtocolAsString

public final String serverProtocolAsString()

The protocol that your object storage system 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:

The protocol that your object storage system uses to communicate.

See Also:

ObjectStorageServerProtocol

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 ARNs of the DataSync agents that can connect with your object storage system.

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 ARNs of the DataSync agents that can connect with your object storage system.

creationTime

public final Instant creationTime()

The time that the location was created.

Returns:

The time that the location was created.

serverCertificate

public final SdkBytes serverCertificate()

The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

Returns:

The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

toBuilder

public DescribeLocationObjectStorageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeLocationObjectStorageResponse.Builder,DescribeLocationObjectStorageResponse>

Specified by:

toBuilder in class AwsResponse

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)

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo