software.amazon.awssdk.services.storagegateway.model

Class UpdateNfsFileShareRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateNfsFileShareRequest.Builder,UpdateNfsFileShareRequest>

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

UpdateNFSFileShareInput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateNfsFileShareRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateNfsFileShareRequest.Builder	builder()
List<String>	clientList() The list of clients that are allowed to access the file gateway.
String	defaultStorageClass() The default storage class for objects put into an Amazon S3 bucket by the file gateway.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileShareARN() The Amazon Resource Name (ARN) of the file share to be updated.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Boolean	guessMIMETypeEnabled() A value that enables guessing of the MIME type for uploaded objects based on file extensions.
int	hashCode()
Boolean	kmsEncrypted() True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
String	kmsKey() The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
NFSFileShareDefaults	nfsFileShareDefaults() The default values for the file share.
ObjectACL	objectACL() A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
String	objectACLAsString() A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
Boolean	readOnly() A value that sets the write status of a file share.
Boolean	requesterPays() A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateNfsFileShareRequest.Builder>	serializableBuilderClass()
String	squash() The user mapped to anonymous user.
UpdateNfsFileShareRequest.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

fileShareARN

public String fileShareARN()

The Amazon Resource Name (ARN) of the file share to be updated.

Returns:

The Amazon Resource Name (ARN) of the file share to be updated.

kmsEncrypted

public Boolean kmsEncrypted()

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Returns:

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

kmsKey

public String kmsKey()

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

nfsFileShareDefaults

public NFSFileShareDefaults nfsFileShareDefaults()

The default values for the file share. Optional.

Returns:

The default values for the file share. Optional.

defaultStorageClass

public String defaultStorageClass()

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Returns:

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

objectACL

public ObjectACL objectACL()

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

If the service returns an enum value that is not available in the current SDK version, objectACL will return ObjectACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectACLAsString().

Returns:

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

See Also:

ObjectACL

objectACLAsString

public String objectACLAsString()

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

If the service returns an enum value that is not available in the current SDK version, objectACL will return ObjectACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectACLAsString().

Returns:

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

See Also:

ObjectACL

clientList

public List<String> clientList()

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

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

Returns:

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

squash

public String squash()

The user mapped to anonymous user. Valid options are the following:

• RootSquash - Only root is mapped to anonymous user.

• NoSquash - No one is mapped to anonymous user

• AllSquash - Everyone is mapped to anonymous user.

Returns:

The user mapped to anonymous user. Valid options are the following:

• RootSquash - Only root is mapped to anonymous user.

• NoSquash - No one is mapped to anonymous user

• AllSquash - Everyone is mapped to anonymous user.

readOnly

public Boolean readOnly()

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

Returns:

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

guessMIMETypeEnabled

public Boolean guessMIMETypeEnabled()

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

Returns:

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

requesterPays

public Boolean requesterPays()

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Returns:

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

toBuilder

public UpdateNfsFileShareRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateNfsFileShareRequest.Builder,UpdateNfsFileShareRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static UpdateNfsFileShareRequest.Builder builder()

serializableBuilderClass

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