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
String	auditDestinationARN() The Amazon Resource Name (ARN) of the storage used for audit logs.
static UpdateNfsFileShareRequest.Builder	builder()
CacheAttributes	cacheAttributes() Specifies refresh cache information for the file share.
List<String>	clientList() The list of clients that are allowed to access the S3 File Gateway.
String	defaultStorageClass() The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileShareARN() The Amazon Resource Name (ARN) of the file share to be updated.
String	fileShareName() The name of the file share.
<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.
boolean	hasClientList() For responses, this returns true if the service returned a value for the ClientList property.
int	hashCode()
Boolean	kmsEncrypted() Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
String	kmsKey() The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
NFSFileShareDefaults	nfsFileShareDefaults() The default values for the file share.
String	notificationPolicy() The notification policy of the file share.
ObjectACL	objectACL() A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into.
String	objectACLAsString() A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 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 final 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 final Boolean kmsEncrypted()

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

Valid Values: true | false

Returns:

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

Valid Values: true | false

kmsKey

public final String kmsKey()

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Returns:

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

nfsFileShareDefaults

public final NFSFileShareDefaults nfsFileShareDefaults()

The default values for the file share. Optional.

Returns:

The default values for the file share. Optional.

defaultStorageClass

public final String defaultStorageClass()

The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Returns:

The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

objectACL

public final ObjectACL objectACL()

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 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 (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.

See Also:

ObjectACL

objectACLAsString

public final String objectACLAsString()

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 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 (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.

See Also:

ObjectACL

hasClientList

public final boolean hasClientList()

For responses, this returns true if the service returned a value for the ClientList 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.

clientList

public final List<String> clientList()

The list of clients that are allowed to access the S3 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.

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 hasClientList() method.

Returns:

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

squash

public final String squash()

The user mapped to anonymous user.

Valid values 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 values 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 final Boolean readOnly()

A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

Valid Values: true | false

Returns:

A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

Valid Values: true | false

guessMIMETypeEnabled

public final 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, otherwise set to false. The default value is true.

Valid Values: true | false

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, otherwise set to false. The default value is true.

Valid Values: true | false

requesterPays

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

Valid Values: true | false

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.

Valid Values: true | false

fileShareName

public final String fileShareName()

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

Returns:

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

cacheAttributes

public final CacheAttributes cacheAttributes()

Specifies refresh cache information for the file share.

Returns:

Specifies refresh cache information for the file share.

notificationPolicy

public final String notificationPolicy()

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{\"Upload\": {\"SettlingTimeInSeconds\": 60}}

The following example sets NotificationPolicy off.

{}

Returns:

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{\"Upload\": {\"SettlingTimeInSeconds\": 60}}

The following example sets NotificationPolicy off.

{}

auditDestinationARN

public final String auditDestinationARN()

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

Returns:

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

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