SMBFileShareInfo (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.storagegateway.model.SMBFileShareInfo

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SMBFileShareInfo
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SMBFileShareInfo()

Constructors
Constructor and Description
`SMBFileShareInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SMBFileShareInfo`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAdminUserList()` A list of users or groups in the Active Directory that have administrator rights to the file share.
`String`	`getAuthentication()`
`String`	`getDefaultStorageClass()` The default storage class for objects put into an Amazon S3 bucket by the file gateway.
`String`	`getFileShareARN()`
`String`	`getFileShareId()`
`String`	`getFileShareStatus()`
`String`	`getGatewayARN()`
`Boolean`	`getGuessMIMETypeEnabled()` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`List<String>`	`getInvalidUserList()` A list of users or groups in the Active Directory that are not allowed to access the file share.
`Boolean`	`getKMSEncrypted()` 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`	`getKMSKey()`
`String`	`getLocationARN()`
`String`	`getObjectACL()`
`String`	`getPath()` The file share path used by the SMB client to identify the mount point.
`Boolean`	`getReadOnly()` A value that sets the write status of a file share.
`Boolean`	`getRequesterPays()` A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
`String`	`getRole()`
`Boolean`	`getSMBACLEnabled()` If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share.
`List<Tag>`	`getTags()` A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
`List<String>`	`getValidUserList()` A list of users or groups in the Active Directory that are allowed to access the file share.
`int`	`hashCode()`
`Boolean`	`isGuessMIMETypeEnabled()` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`Boolean`	`isKMSEncrypted()` True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`Boolean`	`isReadOnly()` A value that sets the write status of a file share.
`Boolean`	`isRequesterPays()` A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
`Boolean`	`isSMBACLEnabled()` If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdminUserList(Collection<String> adminUserList)` A list of users or groups in the Active Directory that have administrator rights to the file share.
`void`	`setAuthentication(String authentication)`
`void`	`setDefaultStorageClass(String defaultStorageClass)` The default storage class for objects put into an Amazon S3 bucket by the file gateway.
`void`	`setFileShareARN(String fileShareARN)`
`void`	`setFileShareId(String fileShareId)`
`void`	`setFileShareStatus(String fileShareStatus)`
`void`	`setGatewayARN(String gatewayARN)`
`void`	`setGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`void`	`setInvalidUserList(Collection<String> invalidUserList)` A list of users or groups in the Active Directory that are not allowed to access the file share.
`void`	`setKMSEncrypted(Boolean kMSEncrypted)` True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`void`	`setKMSKey(String kMSKey)`
`void`	`setLocationARN(String locationARN)`
`void`	`setObjectACL(String objectACL)`
`void`	`setPath(String path)` The file share path used by the SMB client to identify the mount point.
`void`	`setReadOnly(Boolean readOnly)` A value that sets the write status of a file share.
`void`	`setRequesterPays(Boolean requesterPays)` A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
`void`	`setRole(String role)`
`void`	`setSMBACLEnabled(Boolean sMBACLEnabled)` If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share.
`void`	`setTags(Collection<Tag> tags)` A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
`void`	`setValidUserList(Collection<String> validUserList)` A list of users or groups in the Active Directory that are allowed to access the file share.
`String`	`toString()` Returns a string representation of this object.
`SMBFileShareInfo`	`withAdminUserList(Collection<String> adminUserList)` A list of users or groups in the Active Directory that have administrator rights to the file share.
`SMBFileShareInfo`	`withAdminUserList(String... adminUserList)` A list of users or groups in the Active Directory that have administrator rights to the file share.
`SMBFileShareInfo`	`withAuthentication(String authentication)`
`SMBFileShareInfo`	`withDefaultStorageClass(String defaultStorageClass)` The default storage class for objects put into an Amazon S3 bucket by the file gateway.
`SMBFileShareInfo`	`withFileShareARN(String fileShareARN)`
`SMBFileShareInfo`	`withFileShareId(String fileShareId)`
`SMBFileShareInfo`	`withFileShareStatus(String fileShareStatus)`
`SMBFileShareInfo`	`withGatewayARN(String gatewayARN)`
`SMBFileShareInfo`	`withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`SMBFileShareInfo`	`withInvalidUserList(Collection<String> invalidUserList)` A list of users or groups in the Active Directory that are not allowed to access the file share.
`SMBFileShareInfo`	`withInvalidUserList(String... invalidUserList)` A list of users or groups in the Active Directory that are not allowed to access the file share.
`SMBFileShareInfo`	`withKMSEncrypted(Boolean kMSEncrypted)` True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`SMBFileShareInfo`	`withKMSKey(String kMSKey)`
`SMBFileShareInfo`	`withLocationARN(String locationARN)`
`SMBFileShareInfo`	`withObjectACL(ObjectACL objectACL)`
`SMBFileShareInfo`	`withObjectACL(String objectACL)`
`SMBFileShareInfo`	`withPath(String path)` The file share path used by the SMB client to identify the mount point.
`SMBFileShareInfo`	`withReadOnly(Boolean readOnly)` A value that sets the write status of a file share.
`SMBFileShareInfo`	`withRequesterPays(Boolean requesterPays)` A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
`SMBFileShareInfo`	`withRole(String role)`
`SMBFileShareInfo`	`withSMBACLEnabled(Boolean sMBACLEnabled)` If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share.
`SMBFileShareInfo`	`withTags(Collection<Tag> tags)` A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
`SMBFileShareInfo`	`withTags(Tag... tags)` A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
`SMBFileShareInfo`	`withValidUserList(Collection<String> validUserList)` A list of users or groups in the Active Directory that are allowed to access the file share.
`SMBFileShareInfo`	`withValidUserList(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SMBFileShareInfo
```
public SMBFileShareInfo()
```
- Method Detail
  - setFileShareARN
```
public void setFileShareARN(String fileShareARN)
```
    Parameters:
    
    fileShareARN -
  - getFileShareARN
```
public String getFileShareARN()
```
    Returns:
  - withFileShareARN
```
public SMBFileShareInfo withFileShareARN(String fileShareARN)
```
    Parameters:
    
    fileShareARN -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileShareId
```
public void setFileShareId(String fileShareId)
```
    Parameters:
    
    fileShareId -
  - getFileShareId
```
public String getFileShareId()
```
    Returns:
  - withFileShareId
```
public SMBFileShareInfo withFileShareId(String fileShareId)
```
    Parameters:
    
    fileShareId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileShareStatus
```
public void setFileShareStatus(String fileShareStatus)
```
    Parameters:
    
    fileShareStatus -
  - getFileShareStatus
```
public String getFileShareStatus()
```
    Returns:
  - withFileShareStatus
```
public SMBFileShareInfo withFileShareStatus(String fileShareStatus)
```
    Parameters:
    
    fileShareStatus -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGatewayARN
```
public void setGatewayARN(String gatewayARN)
```
    Parameters:
    
    gatewayARN -
  - getGatewayARN
```
public String getGatewayARN()
```
    Returns:
  - withGatewayARN
```
public SMBFileShareInfo withGatewayARN(String gatewayARN)
```
    Parameters:
    
    gatewayARN -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKMSEncrypted
```
public void setKMSEncrypted(Boolean kMSEncrypted)
```
    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.
    
    Parameters:
    
    kMSEncrypted - 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.
  - getKMSEncrypted
```
public Boolean getKMSEncrypted()
```
    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.
    
    Returns:
    
    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.
  - withKMSEncrypted
```
public SMBFileShareInfo withKMSEncrypted(Boolean kMSEncrypted)
```
    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.
    
    Parameters:
    
    kMSEncrypted - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isKMSEncrypted
```
public Boolean isKMSEncrypted()
```
    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.
    
    Returns:
    
    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.
  - setKMSKey
```
public void setKMSKey(String kMSKey)
```
    Parameters:
    
    kMSKey -
  - getKMSKey
```
public String getKMSKey()
```
    Returns:
  - withKMSKey
```
public SMBFileShareInfo withKMSKey(String kMSKey)
```
    Parameters:
    
    kMSKey -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPath
```
public void setPath(String path)
```
    The file share path used by the SMB client to identify the mount point.
    
    Parameters:
    
    path - The file share path used by the SMB client to identify the mount point.
  - getPath
```
public String getPath()
```
    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.
  - withPath
```
public SMBFileShareInfo withPath(String path)
```
    The file share path used by the SMB client to identify the mount point.
    
    Parameters:
    
    path - The file share path used by the SMB client to identify the mount point.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRole
```
public void setRole(String role)
```
    Parameters:
    
    role -
  - getRole
```
public String getRole()
```
    Returns:
  - withRole
```
public SMBFileShareInfo withRole(String role)
```
    Parameters:
    
    role -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocationARN
```
public void setLocationARN(String locationARN)
```
    Parameters:
    
    locationARN -
  - getLocationARN
```
public String getLocationARN()
```
    Returns:
  - withLocationARN
```
public SMBFileShareInfo withLocationARN(String locationARN)
```
    Parameters:
    
    locationARN -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultStorageClass
```
public void setDefaultStorageClass(String defaultStorageClass)
```
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
    
    Parameters:
    
    defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
  - getDefaultStorageClass
```
public String getDefaultStorageClass()
```
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
    
    Returns:
    
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
  - withDefaultStorageClass
```
public SMBFileShareInfo withDefaultStorageClass(String defaultStorageClass)
```
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
    
    Parameters:
    
    defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObjectACL
```
public void setObjectACL(String objectACL)
```
    Parameters:
    
    objectACL -
    
    See Also:
    
    ObjectACL
  - getObjectACL
```
public String getObjectACL()
```
    Returns:
    
    See Also:
    
    ObjectACL
  - withObjectACL
```
public SMBFileShareInfo withObjectACL(String objectACL)
```
    Parameters:
    
    objectACL -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectACL
  - withObjectACL
```
public SMBFileShareInfo withObjectACL(ObjectACL objectACL)
```
    Parameters:
    
    objectACL -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectACL
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Parameters:
    
    readOnly - A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
  - getReadOnly
```
public Boolean getReadOnly()
```
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Returns:
    
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
  - withReadOnly
```
public SMBFileShareInfo withReadOnly(Boolean readOnly)
```
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Parameters:
    
    readOnly - A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReadOnly
```
public Boolean isReadOnly()
```
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Returns:
    
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
  - setGuessMIMETypeEnabled
```
public void setGuessMIMETypeEnabled(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, and otherwise to false. The default value is true.
    
    Parameters:
    
    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, and otherwise to false. The default value is true.
  - getGuessMIMETypeEnabled
```
public Boolean getGuessMIMETypeEnabled()
```
    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, and otherwise to false. The default value is true.
    
    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, and otherwise to false. The default value is true.
  - withGuessMIMETypeEnabled
```
public SMBFileShareInfo withGuessMIMETypeEnabled(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, and otherwise to false. The default value is true.
    
    Parameters:
    
    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, and otherwise to false. The default value is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isGuessMIMETypeEnabled
```
public Boolean isGuessMIMETypeEnabled()
```
    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, and otherwise to false. The default value is true.
    
    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, and otherwise to false. The default value is true.
  - setRequesterPays
```
public void setRequesterPays(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.
    
    Parameters:
    
    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.
  - getRequesterPays
```
public Boolean getRequesterPays()
```
    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.
    
    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.
  - withRequesterPays
```
public SMBFileShareInfo withRequesterPays(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRequesterPays
```
public Boolean isRequesterPays()
```
    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.
    
    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.
  - setSMBACLEnabled
```
public void setSMBACLEnabled(Boolean sMBACLEnabled)
```
    If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Parameters:
    
    sMBACLEnabled - If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
  - getSMBACLEnabled
```
public Boolean getSMBACLEnabled()
```
    If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Returns:
    
    If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
  - withSMBACLEnabled
```
public SMBFileShareInfo withSMBACLEnabled(Boolean sMBACLEnabled)
```
    If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Parameters:
    
    sMBACLEnabled - If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSMBACLEnabled
```
public Boolean isSMBACLEnabled()
```
    If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Returns:
    
    If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
  - getAdminUserList
```
public List<String> getAdminUserList()
```
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - setAdminUserList
```
public void setAdminUserList(Collection<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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - withAdminUserList
```
public SMBFileShareInfo withAdminUserList(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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdminUserList(java.util.Collection) or withAdminUserList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdminUserList
```
public SMBFileShareInfo withAdminUserList(Collection<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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getValidUserList
```
public List<String> getValidUserList()
```
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - setValidUserList
```
public void setValidUserList(Collection<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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - withValidUserList
```
public SMBFileShareInfo withValidUserList(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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    NOTE: This method appends the values to the existing list (if any). Use setValidUserList(java.util.Collection) or withValidUserList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValidUserList
```
public SMBFileShareInfo withValidUserList(Collection<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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInvalidUserList
```
public List<String> getInvalidUserList()
```
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - setInvalidUserList
```
public void setInvalidUserList(Collection<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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - withInvalidUserList
```
public SMBFileShareInfo withInvalidUserList(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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    NOTE: This method appends the values to the existing list (if any). Use setInvalidUserList(java.util.Collection) or withInvalidUserList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInvalidUserList
```
public SMBFileShareInfo withInvalidUserList(Collection<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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthentication
```
public void setAuthentication(String authentication)
```
    Parameters:
    
    authentication -
  - getAuthentication
```
public String getAuthentication()
```
    Returns:
  - withAuthentication
```
public SMBFileShareInfo withAuthentication(String authentication)
```
    Parameters:
    
    authentication -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    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.
    
    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.
  - setTags
```
public void setTags(Collection<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.
    
    Parameters:
    
    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.
  - withTags
```
public SMBFileShareInfo withTags(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public SMBFileShareInfo withTags(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SMBFileShareInfo clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class SMBFileShareInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SMBFileShareInfo

Method Detail

setFileShareARN

getFileShareARN

withFileShareARN

setFileShareId

getFileShareId

withFileShareId

setFileShareStatus

getFileShareStatus

withFileShareStatus

setGatewayARN

getGatewayARN

withGatewayARN

setKMSEncrypted

getKMSEncrypted

withKMSEncrypted

isKMSEncrypted

setKMSKey

getKMSKey

withKMSKey

setPath

getPath

withPath

setRole

getRole

withRole

setLocationARN

getLocationARN

withLocationARN

setDefaultStorageClass

getDefaultStorageClass

withDefaultStorageClass

setObjectACL

getObjectACL

withObjectACL

withObjectACL

setReadOnly

getReadOnly

withReadOnly

isReadOnly

setGuessMIMETypeEnabled

getGuessMIMETypeEnabled

withGuessMIMETypeEnabled

isGuessMIMETypeEnabled

setRequesterPays

getRequesterPays

withRequesterPays

isRequesterPays

setSMBACLEnabled

getSMBACLEnabled

withSMBACLEnabled

isSMBACLEnabled

getAdminUserList

setAdminUserList

withAdminUserList

withAdminUserList

getValidUserList

setValidUserList

withValidUserList

withValidUserList

getInvalidUserList

setInvalidUserList

withInvalidUserList

withInvalidUserList

setAuthentication

getAuthentication

withAuthentication

getTags

setTags

withTags

withTags

toString

equals