UpdateSmbFileShareRequest (AWS Java SDK :: Services :: AWS Storage Gateway 2.17.129 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
`Boolean`	`accessBasedEnumeration()` The files and folders on this share will only be visible to users with read access.
`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 audit logs.
`static UpdateSmbFileShareRequest.Builder`	`builder()`
`CacheAttributes`	`cacheAttributes()` Specifies refresh cache information for the file share.
`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 S3 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.
`String`	`fileShareName()` The name of the file share.
`<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()` For responses, this returns true if the service returned a value for the AdminUserList property.
`int`	`hashCode()`
`boolean`	`hasInvalidUserList()` For responses, this returns true if the service returned a value for the InvalidUserList property.
`boolean`	`hasValidUserList()` For responses, this returns true if the service returned a value for the ValidUserList property.
`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 KMS key, or `false` to use a key managed by Amazon S3.
`String`	`kmsKey()` The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
`String`	`notificationPolicy()` The notification policy of the file share.
`ObjectACL`	`objectACL()` A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into.
`String`	`objectACLAsString()` A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into.
`Boolean`	`oplocksEnabled()` Specifies whether opportunistic locking is enabled for the SMB file share.
`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 access control list (ACL) 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 final 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 final Boolean kmsEncrypted()
```
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Valid Values: true | false
    
    Returns:
    
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Valid Values: true | false
  - kmsKey
```
public final String kmsKey()
```
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
  - defaultStorageClass
```
public final String defaultStorageClass()
```
    The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_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 S3 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 final ObjectACL objectACL()
```
    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 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 (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.
    
    See Also:
    
    ObjectACL
  - objectACLAsString
```
public final String objectACLAsString()
```
    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 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 (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.
    
    See Also:
    
    ObjectACL
  - readOnly
```
public final Boolean readOnly()
```
    A value that sets the write status of a file share. Set this value to true to set 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 write status to read-only, otherwise set to false.
    
    Valid Values: true | false
  - guessMIMETypeEnabled
```
public final Boolean guessMIMETypeEnabled()
```
    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.
    
    Valid Values: true | false
    
    Returns:
    
    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.
    
    Valid Values: true | false
  - requesterPays
```
public final Boolean requesterPays()
```
    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    
    Valid Values: true | false
    
    Returns:
    
    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    
    Valid Values: true | false
  - smbaclEnabled
```
public final Boolean smbaclEnabled()
```
    Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.
    
    For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
    
    Valid Values: true | false
    
    Returns:
    
    Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.
    
    For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
    
    Valid Values: true | false
  - accessBasedEnumeration
```
public final Boolean accessBasedEnumeration()
```
    The files and folders on this share will only be visible to users with read access.
    
    Returns:
    
    The files and folders on this share will only be visible to users with read access.
  - hasAdminUserList
```
public final boolean hasAdminUserList()
```
    For responses, this returns true if the service returned a value for the AdminUserList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - adminUserList
```
public final List<String> adminUserList()
```
    A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdminUserList() method.
    
    Returns:
    
    A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
  - hasValidUserList
```
public final boolean hasValidUserList()
```
    For responses, this returns true if the service returned a value for the ValidUserList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - validUserList
```
public final List<String> validUserList()
```
    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValidUserList() method.
    
    Returns:
    
    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
  - hasInvalidUserList
```
public final boolean hasInvalidUserList()
```
    For responses, this returns true if the service returned a value for the InvalidUserList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - invalidUserList
```
public final List<String> invalidUserList()
```
    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInvalidUserList() method.
    
    Returns:
    
    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
  - auditDestinationARN
```
public final String auditDestinationARN()
```
    The Amazon Resource Name (ARN) of the storage used for audit logs.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the storage used for audit logs.
  - caseSensitivity
```
public final CaseSensitivity caseSensitivity()
```
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    
    If the service returns an enum value that is not available in the current SDK version, caseSensitivity will return CaseSensitivity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from caseSensitivityAsString().
    
    Returns:
    
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    
    See Also:
    
    CaseSensitivity
  - caseSensitivityAsString
```
public final String caseSensitivityAsString()
```
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    
    If the service returns an enum value that is not available in the current SDK version, caseSensitivity will return CaseSensitivity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from caseSensitivityAsString().
    
    Returns:
    
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    
    See Also:
    
    CaseSensitivity
  - fileShareName
```
public final String fileShareName()
```
    The name of the file share. Optional.
    
    FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.
    
    Returns:
    
    The name of the file share. Optional.
    
    FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.
  - cacheAttributes
```
public final CacheAttributes cacheAttributes()
```
    Specifies refresh cache information for the file share.
    
    Returns:
    
    Specifies refresh cache information for the file share.
  - notificationPolicy
```
public final String notificationPolicy()
```
    The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
    
    SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
    
    The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
    
    {\"Upload\": {\"SettlingTimeInSeconds\": 60}}
    
    The following example sets NotificationPolicy off.
    
    {}
    
    Returns:
    
    The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
    
    SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
    
    The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
    
    {\"Upload\": {\"SettlingTimeInSeconds\": 60}}
    
    The following example sets NotificationPolicy off.
    
    {}
  - oplocksEnabled
```
public final Boolean oplocksEnabled()
```
    Specifies whether opportunistic locking is enabled for the SMB file share.
    
    Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
    
    Valid Values: true | false
    
    Returns:
    
    Specifies whether opportunistic locking is enabled for the SMB file share.
    
    Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
    
    Valid Values: true | false
  - toBuilder
```
public 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final 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

accessBasedEnumeration

hasAdminUserList

adminUserList

hasValidUserList

validUserList

hasInvalidUserList

invalidUserList

auditDestinationARN

caseSensitivity

caseSensitivityAsString

fileShareName

cacheAttributes

notificationPolicy

oplocksEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields