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

All Superinterfaces:

Buildable, CopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>, SdkBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>, SdkPojo

Enclosing class:

SMBFileShareInfo
```
public static interface SMBFileShareInfo.Builder
extends SdkPojo, CopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`SMBFileShareInfo.Builder`	`adminUserList(Collection<String> adminUserList)` A list of users or groups in the Active Directory that have administrator rights to the file share.
`SMBFileShareInfo.Builder`	`adminUserList(String... adminUserList)` A list of users or groups in the Active Directory that have administrator rights to the file share.
`SMBFileShareInfo.Builder`	`auditDestinationARN(String auditDestinationARN)` The Amazon Resource Name (ARN) of the storage used for the audit logs.
`SMBFileShareInfo.Builder`	`authentication(String authentication)` Sets the value of the Authentication property for this object.
`SMBFileShareInfo.Builder`	`cacheAttributes(CacheAttributes cacheAttributes)` Refresh cache information.
`default SMBFileShareInfo.Builder`	`cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)` Refresh cache information.
`SMBFileShareInfo.Builder`	`caseSensitivity(CaseSensitivity caseSensitivity)` The case of an object name in an Amazon S3 bucket.
`SMBFileShareInfo.Builder`	`caseSensitivity(String caseSensitivity)` The case of an object name in an Amazon S3 bucket.
`SMBFileShareInfo.Builder`	`defaultStorageClass(String defaultStorageClass)` The default storage class for objects put into an Amazon S3 bucket by the file gateway.
`SMBFileShareInfo.Builder`	`fileShareARN(String fileShareARN)` Sets the value of the FileShareARN property for this object.
`SMBFileShareInfo.Builder`	`fileShareId(String fileShareId)` Sets the value of the FileShareId property for this object.
`SMBFileShareInfo.Builder`	`fileShareName(String fileShareName)` The name of the file share.
`SMBFileShareInfo.Builder`	`fileShareStatus(String fileShareStatus)` Sets the value of the FileShareStatus property for this object.
`SMBFileShareInfo.Builder`	`gatewayARN(String gatewayARN)` Sets the value of the GatewayARN property for this object.
`SMBFileShareInfo.Builder`	`guessMIMETypeEnabled(Boolean guessMIMETypeEnabled)` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`SMBFileShareInfo.Builder`	`invalidUserList(Collection<String> invalidUserList)` A list of users or groups in the Active Directory that are not allowed to access the file share.
`SMBFileShareInfo.Builder`	`invalidUserList(String... invalidUserList)` A list of users or groups in the Active Directory that are not allowed to access the file share.
`SMBFileShareInfo.Builder`	`kmsEncrypted(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.
`SMBFileShareInfo.Builder`	`kmsKey(String kmsKey)` Sets the value of the KMSKey property for this object.
`SMBFileShareInfo.Builder`	`locationARN(String locationARN)` Sets the value of the LocationARN property for this object.
`SMBFileShareInfo.Builder`	`objectACL(ObjectACL objectACL)` Sets the value of the ObjectACL property for this object.
`SMBFileShareInfo.Builder`	`objectACL(String objectACL)` Sets the value of the ObjectACL property for this object.
`SMBFileShareInfo.Builder`	`path(String path)` The file share path used by the SMB client to identify the mount point.
`SMBFileShareInfo.Builder`	`readOnly(Boolean readOnly)` A value that sets the write status of a file share.
`SMBFileShareInfo.Builder`	`requesterPays(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.Builder`	`role(String role)` Sets the value of the Role property for this object.
`SMBFileShareInfo.Builder`	`smbaclEnabled(Boolean smbaclEnabled)` If this value is set to `true`, it indicates that access control list (ACL) is enabled on the SMB file share.
`SMBFileShareInfo.Builder`	`tags(Collection<Tag> tags)` A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
`SMBFileShareInfo.Builder`	`tags(Consumer<Tag.Builder>... tags)` A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
`SMBFileShareInfo.Builder`	`tags(Tag... tags)` A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
`SMBFileShareInfo.Builder`	`validUserList(Collection<String> validUserList)` A list of users or groups in the Active Directory that are allowed to access the file share.
`SMBFileShareInfo.Builder`	`validUserList(String... validUserList)` A list of users or groups in the Active Directory that are allowed to access the file share.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - fileShareARN
```
SMBFileShareInfo.Builder fileShareARN(String fileShareARN)
```
    Sets the value of the FileShareARN property for this object.
    
    Parameters:
    
    fileShareARN - The new value for the FileShareARN property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - fileShareId
```
SMBFileShareInfo.Builder fileShareId(String fileShareId)
```
    Sets the value of the FileShareId property for this object.
    
    Parameters:
    
    fileShareId - The new value for the FileShareId property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - fileShareStatus
```
SMBFileShareInfo.Builder fileShareStatus(String fileShareStatus)
```
    Sets the value of the FileShareStatus property for this object.
    
    Parameters:
    
    fileShareStatus - The new value for the FileShareStatus property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - gatewayARN
```
SMBFileShareInfo.Builder gatewayARN(String gatewayARN)
```
    Sets the value of the GatewayARN property for this object.
    
    Parameters:
    
    gatewayARN - The new value for the GatewayARN property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - kmsEncrypted
```
SMBFileShareInfo.Builder kmsEncrypted(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - kmsKey
```
SMBFileShareInfo.Builder kmsKey(String kmsKey)
```
    Sets the value of the KMSKey property for this object.
    
    Parameters:
    
    kmsKey - The new value for the KMSKey property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - path
```
SMBFileShareInfo.Builder path(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.
  - role
```
SMBFileShareInfo.Builder role(String role)
```
    Sets the value of the Role property for this object.
    
    Parameters:
    
    role - The new value for the Role property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - locationARN
```
SMBFileShareInfo.Builder locationARN(String locationARN)
```
    Sets the value of the LocationARN property for this object.
    
    Parameters:
    
    locationARN - The new value for the LocationARN property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - defaultStorageClass
```
SMBFileShareInfo.Builder defaultStorageClass(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - objectACL
```
SMBFileShareInfo.Builder objectACL(String objectACL)
```
    Sets the value of the ObjectACL property for this object.
    
    Parameters:
    
    objectACL - The new value for the ObjectACL property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectACL, ObjectACL
  - objectACL
```
SMBFileShareInfo.Builder objectACL(ObjectACL objectACL)
```
    Sets the value of the ObjectACL property for this object.
    
    Parameters:
    
    objectACL - The new value for the ObjectACL property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectACL, ObjectACL
  - readOnly
```
SMBFileShareInfo.Builder readOnly(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - guessMIMETypeEnabled
```
SMBFileShareInfo.Builder guessMIMETypeEnabled(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
    
    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, otherwise set to false. The default value is true.
    
    Valid Values: true | false
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - requesterPays
```
SMBFileShareInfo.Builder requesterPays(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
    
    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.
    
    Valid Values: true | false
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - smbaclEnabled
```
SMBFileShareInfo.Builder smbaclEnabled(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - adminUserList
```
SMBFileShareInfo.Builder adminUserList(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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.
  - adminUserList
```
SMBFileShareInfo.Builder adminUserList(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.
    
    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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.
  - validUserList
```
SMBFileShareInfo.Builder validUserList(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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.
  - validUserList
```
SMBFileShareInfo.Builder validUserList(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.
    
    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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.
  - invalidUserList
```
SMBFileShareInfo.Builder invalidUserList(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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.
  - invalidUserList
```
SMBFileShareInfo.Builder invalidUserList(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.
    
    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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.
  - auditDestinationARN
```
SMBFileShareInfo.Builder auditDestinationARN(String auditDestinationARN)
```
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    
    Parameters:
    
    auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for the audit logs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - authentication
```
SMBFileShareInfo.Builder authentication(String authentication)
```
    Sets the value of the Authentication property for this object.
    
    Parameters:
    
    authentication - The new value for the Authentication property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - caseSensitivity
```
SMBFileShareInfo.Builder caseSensitivity(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CaseSensitivity, CaseSensitivity
  - caseSensitivity
```
SMBFileShareInfo.Builder caseSensitivity(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CaseSensitivity, CaseSensitivity
  - tags
```
SMBFileShareInfo.Builder tags(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.
  - tags
```
SMBFileShareInfo.Builder tags(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.
  - tags
```
SMBFileShareInfo.Builder tags(Consumer<Tag.Builder>... 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.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(List)
  - fileShareName
```
SMBFileShareInfo.Builder fileShareName(String fileShareName)
```
    The name of the file share. Optional.
    
    FileShareName must be set if an S3 prefix name is set in LocationARN.
    
    Parameters:
    
    fileShareName - The name of the file share. Optional.
    
    FileShareName must be set if an S3 prefix name is set in LocationARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cacheAttributes
```
SMBFileShareInfo.Builder cacheAttributes(CacheAttributes cacheAttributes)
```
    Refresh cache information.
    
    Parameters:
    
    cacheAttributes - Refresh cache information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cacheAttributes
```
default SMBFileShareInfo.Builder cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)
```
    Refresh cache information.
    This is a convenience that creates an instance of the CacheAttributes.Builder avoiding the need to create one manually via CacheAttributes.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cacheAttributes(CacheAttributes).
    
    Parameters:
    
    cacheAttributes - a consumer that will call methods on CacheAttributes.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    cacheAttributes(CacheAttributes)

Interface SMBFileShareInfo.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

fileShareARN

fileShareId

fileShareStatus

gatewayARN

kmsEncrypted

kmsKey

path

role

locationARN

defaultStorageClass

objectACL

objectACL

readOnly

guessMIMETypeEnabled

requesterPays

smbaclEnabled

adminUserList

adminUserList

validUserList

validUserList

invalidUserList

invalidUserList

auditDestinationARN

authentication

caseSensitivity

caseSensitivity

tags

tags

tags

fileShareName

cacheAttributes

cacheAttributes