software.amazon.awssdk.services.storagegateway.model

Class AssociateFileSystemRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.AssociateFileSystemRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociateFileSystemRequest.Builder,AssociateFileSystemRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssociateFileSystemRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	auditDestinationARN() The Amazon Resource Name (ARN) of the storage used for the audit logs.
static AssociateFileSystemRequest.Builder	builder()
CacheAttributes	cacheAttributes() Returns the value of the CacheAttributes property for this object.
String	clientToken() A unique string value that you supply that is used by the file gateway to ensure idempotent file system association creation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayARN() Returns the value of the GatewayARN property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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).
String	locationARN() The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the Amazon FSx file gateway.
String	password() The password of the user credential.
List<SdkField<?>>	sdkFields()
static Class<? extends AssociateFileSystemRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of up to 50 tags that can be assigned to the file system association.
AssociateFileSystemRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userName() The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system.

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

userName

public final String userName()

The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

Returns:

The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

password

public final String password()

The password of the user credential.

Returns:

The password of the user credential.

clientToken

public final String clientToken()

A unique string value that you supply that is used by the file gateway to ensure idempotent file system association creation.

Returns:

A unique string value that you supply that is used by the file gateway to ensure idempotent file system association creation.

gatewayARN

public final String gatewayARN()

Returns the value of the GatewayARN property for this object.

Returns:

The value of the GatewayARN property for this object.

locationARN

public final String locationARN()

The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the Amazon FSx file gateway.

Returns:

The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the Amazon FSx file gateway.

hasTags

public final 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 final List<Tag> tags()

A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

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:

A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

auditDestinationARN

public final String auditDestinationARN()

The Amazon Resource Name (ARN) of the storage used for the audit logs.

Returns:

The Amazon Resource Name (ARN) of the storage used for the audit logs.

cacheAttributes

public final CacheAttributes cacheAttributes()

Returns the value of the CacheAttributes property for this object.

Returns:

The value of the CacheAttributes property for this object.

toBuilder

public AssociateFileSystemRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociateFileSystemRequest.Builder,AssociateFileSystemRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static AssociateFileSystemRequest.Builder builder()

serializableBuilderClass

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