NFSFileShareInfo (AWS Java SDK :: Services :: AWS Storage Gateway 2.17.129 API)

java.lang.Object
- software.amazon.awssdk.services.storagegateway.model.NFSFileShareInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NFSFileShareInfo.Builder,NFSFileShareInfo>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class NFSFileShareInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NFSFileShareInfo.Builder,NFSFileShareInfo>
```
The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets. This operation is only supported in S3 File Gateways.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface NFSFileShareInfo.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`NFSFileShareInfo.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`auditDestinationARN()` The Amazon Resource Name (ARN) of the storage used for audit logs.
`String`	`bucketRegion()` Specifies the Region of the S3 bucket where the NFS file share stores files.
`static NFSFileShareInfo.Builder`	`builder()`
`CacheAttributes`	`cacheAttributes()` Refresh cache information for the file share.
`List<String>`	`clientList()` Returns the value of the ClientList property for this object.
`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()` Returns the value of the FileShareARN property for this object.
`String`	`fileShareId()` Returns the value of the FileShareId property for this object.
`String`	`fileShareName()` The name of the file share.
`String`	`fileShareStatus()` Returns the value of the FileShareStatus property for this object.
`String`	`gatewayARN()` Returns the value of the GatewayARN property for this object.
`<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`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`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()` Returns the value of the KMSKey property for this object.
`String`	`locationARN()` Returns the value of the LocationARN property for this object.
`NFSFileShareDefaults`	`nfsFileShareDefaults()` Returns the value of the NFSFileShareDefaults property for this object.
`String`	`notificationPolicy()` The notification policy of the file share.
`ObjectACL`	`objectACL()` Returns the value of the ObjectACL property for this object.
`String`	`objectACLAsString()` Returns the value of the ObjectACL property for this object.
`String`	`path()` Returns the value of the Path property for this object.
`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.
`String`	`role()` Returns the value of the Role property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends NFSFileShareInfo.Builder>`	`serializableBuilderClass()`
`String`	`squash()` Returns the value of the Squash property for this object.
`List<Tag>`	`tags()` A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name.
`NFSFileShareInfo.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcEndpointDNSName()` Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

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
  - nfsFileShareDefaults
```
public final NFSFileShareDefaults nfsFileShareDefaults()
```
    Returns the value of the NFSFileShareDefaults property for this object.
    
    Returns:
    
    The value of the NFSFileShareDefaults property for this object.
  - fileShareARN
```
public final String fileShareARN()
```
    Returns the value of the FileShareARN property for this object.
    
    Returns:
    
    The value of the FileShareARN property for this object.
  - fileShareId
```
public final String fileShareId()
```
    Returns the value of the FileShareId property for this object.
    
    Returns:
    
    The value of the FileShareId property for this object.
  - fileShareStatus
```
public final String fileShareStatus()
```
    Returns the value of the FileShareStatus property for this object.
    
    Returns:
    
    The value of the FileShareStatus property for this object.
  - 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.
  - 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()
```
    Returns the value of the KMSKey property for this object.
    
    Returns:
    
    The value of the KMSKey property for this object.
  - path
```
public final String path()
```
    Returns the value of the Path property for this object.
    
    Returns:
    
    The value of the Path property for this object.
  - role
```
public final String role()
```
    Returns the value of the Role property for this object.
    
    Returns:
    
    The value of the Role property for this object.
  - locationARN
```
public final String locationARN()
```
    Returns the value of the LocationARN property for this object.
    
    Returns:
    
    The value of the LocationARN property for this object.
  - 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()
```
    Returns the value of the ObjectACL property for this object.
    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:
    
    The value of the ObjectACL property for this object.
    
    See Also:
    
    ObjectACL
  - objectACLAsString
```
public final String objectACLAsString()
```
    Returns the value of the ObjectACL property for this object.
    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:
    
    The value of the ObjectACL property for this object.
    
    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()
```
    Returns the value of the ClientList property for this object.
    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 value of the ClientList property for this object.
  - squash
```
public final String squash()
```
    Returns the value of the Squash property for this object.
    
    Returns:
    
    The value of the Squash property for this object.
  - 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
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
    
    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 hasTags() method.
    
    Returns:
    
    A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
  - 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()
```
    Refresh cache information for the file share.
    
    Returns:
    
    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.
    
    {}
  - vpcEndpointDNSName
```
public final String vpcEndpointDNSName()
```
    Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
    
    This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
    
    Returns:
    
    Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
    
    This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
  - bucketRegion
```
public final String bucketRegion()
```
    Specifies the Region of the S3 bucket where the NFS file share stores files.
    
    This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
    
    Returns:
    
    Specifies the Region of the S3 bucket where the NFS file share stores files.
    
    This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
  - 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 NFSFileShareInfo.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<NFSFileShareInfo.Builder,NFSFileShareInfo>
  - builder
```
public static NFSFileShareInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends NFSFileShareInfo.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class NFSFileShareInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

nfsFileShareDefaults

fileShareARN

fileShareId

fileShareStatus

gatewayARN

kmsEncrypted

kmsKey

path

role

locationARN

defaultStorageClass

objectACL

objectACLAsString

hasClientList

clientList

squash

readOnly

guessMIMETypeEnabled

requesterPays

hasTags

tags

fileShareName

cacheAttributes

notificationPolicy

vpcEndpointDNSName

bucketRegion

auditDestinationARN

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields