SMBFileShareInfo (AWS Java SDK :: Services :: AWS Storage Gateway 2.14.3 API)

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>
```
@Generated(value="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 file gateway discovers them in S3 buckets. This operation is only supported for file gateways.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SMBFileShareInfo.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`adminUserList()` A list of users or groups in the Active Directory that have administrator rights to the file share.
`String`	`auditDestinationARN()` The Amazon Resource Name (ARN) of the storage used for the audit logs.
`String`	`authentication()` Returns the value of the Authentication property for this object.
`static SMBFileShareInfo.Builder`	`builder()`
`CacheAttributes`	`cacheAttributes()` Refresh cache information.
`CaseSensitivity`	`caseSensitivity()` The case of an object name in an Amazon S3 bucket.
`String`	`caseSensitivityAsString()` The case of an object name in an Amazon S3 bucket.
`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()` 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`	`hasAdminUserList()` Returns true if the AdminUserList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasInvalidUserList()` Returns true if the InvalidUserList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasValidUserList()` Returns true if the ValidUserList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`invalidUserList()` A list of users or groups in the Active Directory that are not allowed to access the file share.
`Boolean`	`kmsEncrypted()` Set to `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()` Returns the value of the KMSKey property for this object.
`String`	`locationARN()` Returns the value of the LocationARN property for this object.
`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()` The file share path used by the SMB client to identify the mount point.
`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 SMBFileShareInfo.Builder>`	`serializableBuilderClass()`
`Boolean`	`smbaclEnabled()` If this value is set to `true`, it indicates that access control list (ACL) is enabled on the SMB file share.
`List<Tag>`	`tags()` A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
`SMBFileShareInfo.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`validUserList()` A list of users or groups in the Active Directory that are allowed to access the file share.

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()
```
    Returns the value of the FileShareARN property for this object.
    
    Returns:
    
    The value of the FileShareARN property for this object.
  - fileShareId
```
public String fileShareId()
```
    Returns the value of the FileShareId property for this object.
    
    Returns:
    
    The value of the FileShareId property for this object.
  - fileShareStatus
```
public String fileShareStatus()
```
    Returns the value of the FileShareStatus property for this object.
    
    Returns:
    
    The value of the FileShareStatus property for this object.
  - gatewayARN
```
public String gatewayARN()
```
    Returns the value of the GatewayARN property for this object.
    
    Returns:
    
    The value of the GatewayARN property for this object.
  - kmsEncrypted
```
public Boolean kmsEncrypted()
```
    Set to 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.
    
    Valid Values: true | false
    
    Returns:
    
    Set to 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.
    
    Valid Values: true | false
  - kmsKey
```
public String kmsKey()
```
    Returns the value of the KMSKey property for this object.
    
    Returns:
    
    The value of the KMSKey property for this object.
  - path
```
public 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 String role()
```
    Returns the value of the Role property for this object.
    
    Returns:
    
    The value of the Role property for this object.
  - locationARN
```
public String locationARN()
```
    Returns the value of the LocationARN property for this object.
    
    Returns:
    
    The value of the LocationARN property for this object.
  - defaultStorageClass
```
public String defaultStorageClass()
```
    The default storage class for objects put into an Amazon S3 bucket by the 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 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 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 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
  - readOnly
```
public 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 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 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 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 AWS 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 AWS Storage Gateway User Guide.
  - hasAdminUserList
```
public boolean hasAdminUserList()
```
    Returns true if the AdminUserList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - adminUserList
```
public 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.
    
    You can use hasAdminUserList() to see if a value was sent in this field.
    
    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 boolean hasValidUserList()
```
    Returns true if the ValidUserList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - validUserList
```
public 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.
    
    You can use hasValidUserList() to see if a value was sent in this field.
    
    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 boolean hasInvalidUserList()
```
    Returns true if the InvalidUserList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - invalidUserList
```
public 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.
    
    You can use hasInvalidUserList() to see if a value was sent in this field.
    
    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 String auditDestinationARN()
```
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
  - authentication
```
public String authentication()
```
    Returns the value of the Authentication property for this object.
    
    Returns:
    
    The value of the Authentication property for this object.
  - caseSensitivity
```
public 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:
    
    CaseSensitivity
  - caseSensitivityAsString
```
public 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:
    
    CaseSensitivity
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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 String fileShareName()
```
    The name of the file share. Optional.
    
    FileShareName must be set if an S3 prefix name is set in LocationARN.
    
    Returns:
    
    The name of the file share. Optional.
    
    FileShareName must be set if an S3 prefix name is set in LocationARN.
  - cacheAttributes
```
public CacheAttributes cacheAttributes()
```
    Refresh cache information.
    
    Returns:
    
    Refresh cache information.
  - toBuilder
```
public SMBFileShareInfo.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>
  - builder
```
public static SMBFileShareInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SMBFileShareInfo.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SMBFileShareInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

fileShareARN

fileShareId

fileShareStatus

gatewayARN

kmsEncrypted

kmsKey

path

role

locationARN

defaultStorageClass

objectACL

objectACLAsString

readOnly

guessMIMETypeEnabled

requesterPays

smbaclEnabled

hasAdminUserList

adminUserList

hasValidUserList

validUserList

hasInvalidUserList

invalidUserList

auditDestinationARN

authentication

caseSensitivity

caseSensitivityAsString

hasTags

tags

fileShareName

cacheAttributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields