Package software.amazon.awssdk.services.storagegateway.model

Class SMBFileShareInfo

java.lang.Object
software.amazon.awssdk.services.storagegateway.model.SMBFileShareInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>
@Generated("software.amazon.awssdk:codegen") public final class SMBFileShareInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>

The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.

See Also:

  • Method Details

    • 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()

      The file share path used by the SMB client to identify the mount point.

      Returns:
      The file share path used by the SMB client to identify the mount point.

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

    • 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

    • smbaclEnabled

      public final Boolean smbaclEnabled()

      If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission.

      For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

      Returns:
      If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission.

      For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

    • accessBasedEnumeration

      public final Boolean accessBasedEnumeration()

      Indicates whether AccessBasedEnumeration is enabled.

      Returns:
      Indicates whether AccessBasedEnumeration is enabled.

    • hasAdminUserList

      public final boolean hasAdminUserList()
      For responses, this returns true if the service returned a value for the AdminUserList 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.

    • adminUserList

      public final List<String> adminUserList()

      A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

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

      Returns:
      A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

    • hasValidUserList

      public final boolean hasValidUserList()
      For responses, this returns true if the service returned a value for the ValidUserList 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.

    • validUserList

      public final List<String> validUserList()

      A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

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

      Returns:
      A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

    • hasInvalidUserList

      public final boolean hasInvalidUserList()
      For responses, this returns true if the service returned a value for the InvalidUserList 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.

    • invalidUserList

      public final List<String> invalidUserList()

      A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

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

      Returns:
      A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

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

    • authentication

      public final String authentication()
      Returns the value of the Authentication property for this object.
      Returns:
      The value of the Authentication property for this object.

    • caseSensitivity

      public final CaseSensitivity caseSensitivity()

      The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

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

      Returns:
      The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
      See Also:

    • caseSensitivityAsString

      public final String caseSensitivityAsString()

      The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

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

      Returns:
      The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
      See Also:

    • 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 SMB 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 SMB 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 SMB file share uses to connect to Amazon S3.

      This parameter is required for SMB 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 SMB file share uses to connect to Amazon S3.

      This parameter is required for SMB 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 SMB file share stores files.

      This parameter is required for SMB 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 SMB file share stores files.

      This parameter is required for SMB 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.

    • oplocksEnabled

      public final Boolean oplocksEnabled()

      Specifies whether opportunistic locking is enabled for the SMB file share.

      Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

      Valid Values: true | false

      Returns:
      Specifies whether opportunistic locking is enabled for the SMB file share.

      Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

      Valid Values: true | false

    • toBuilder

      public SMBFileShareInfo.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<SMBFileShareInfo.Builder,SMBFileShareInfo>
      Returns:
      a builder for type T

    • builder

      public static SMBFileShareInfo.Builder builder()

    • serializableBuilderClass

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