UpdateSmbFileShareRequest (AWS Java SDK :: Services :: AWS Storage Gateway 2.10.21 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest
    - - software.amazon.awssdk.services.storagegateway.model.UpdateSmbFileShareRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateSmbFileShareRequest.Builder,UpdateSmbFileShareRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateSmbFileShareRequest
extends StorageGatewayRequest
implements ToCopyableBuilder<UpdateSmbFileShareRequest.Builder,UpdateSmbFileShareRequest>

UpdateSMBFileShareInput

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateSmbFileShareRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`adminUserList()` A list of users in the Active Directory that have administrator rights to the file share.
`static UpdateSmbFileShareRequest.Builder`	`builder()`
`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()` The Amazon Resource Name (ARN) of the SMB file share that you want to update.
`<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.
`int`	`hashCode()`
`List<String>`	`invalidUserList()` A list of users or groups in the Active Directory that are not allowed to access the file share.
`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.
`String`	`kmsKey()` The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
`ObjectACL`	`objectACL()` A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
`String`	`objectACLAsString()` A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateSmbFileShareRequest.Builder>`	`serializableBuilderClass()`
`Boolean`	`smbaclEnabled()` Set this value to "true to enable ACL (access control list) on the SMB file share.
`UpdateSmbFileShareRequest.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 software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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()
```
    The Amazon Resource Name (ARN) of the SMB file share that you want to update.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the SMB file share that you want to update.
  - kmsEncrypted
```
public 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.
    
    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.
  - kmsKey
```
public String kmsKey()
```
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
  - defaultStorageClass
```
public 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.
    
    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.
  - objectACL
```
public ObjectACL objectACL()
```
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    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:
    
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    See Also:
    
    ObjectACL
  - objectACLAsString
```
public String objectACLAsString()
```
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    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:
    
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    See Also:
    
    ObjectACL
  - readOnly
```
public 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.
    
    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.
  - 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, 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.
  - 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.
    
    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.
  - smbaclEnabled
```
public Boolean smbaclEnabled()
```
    Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.
    
    Returns:
    
    Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.
  - adminUserList
```
public List<String> adminUserList()
```
    A list of users 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of users 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.
  - 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. For example @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.
    
    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.
  - 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. For example @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.
    
    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.
  - toBuilder
```
public UpdateSmbFileShareRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateSmbFileShareRequest.Builder,UpdateSmbFileShareRequest>
    
    Specified by:
    
    toBuilder in class StorageGatewayRequest
  - builder
```
public static UpdateSmbFileShareRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateSmbFileShareRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateSmbFileShareRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

fileShareARN

kmsEncrypted

kmsKey

defaultStorageClass

objectACL

objectACLAsString

readOnly

guessMIMETypeEnabled

requesterPays

smbaclEnabled

adminUserList

validUserList

invalidUserList

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields