Class NFSFileShareInfo

java.lang.Object
software.amazon.awssdk.services.storagegateway.model.NFSFileShareInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NFSFileShareInfo.Builder,NFSFileShareInfo>
@Generated("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:

  • Method Details

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

    • encryptionType

      public final EncryptionType encryptionType()

      A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

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

      Returns:
      A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      See Also:

    • encryptionTypeAsString

      public final String encryptionTypeAsString()

      A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

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

      Returns:
      A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      See Also:

    • kmsEncrypted

      @Deprecated public final Boolean kmsEncrypted()
      Deprecated.
      KMSEncrypted is deprecated, use EncryptionType instead.

      Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      Valid Values: true | false

      Returns:
      Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      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_STANDARD. 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_STANDARD. 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:

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

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

      This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.

      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.

      This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.

      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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NFSFileShareInfo.Builder,NFSFileShareInfo>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.