com.amazonaws.services.storagegateway.model.UpdateSMBFileShareRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-storagegateway Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.storagegateway.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* UpdateSMBFileShareInput
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateSMBFileShareRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the SMB file share that you want to update.
*
*/
private String fileShareARN;
/**
*
* 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
*
*/
private Boolean kMSEncrypted;
/**
*
* 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.
*
*/
private String kMSKey;
/**
*
* The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
* S3_STANDARD. Optional.
*
*
* Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
* S3_ONEZONE_IA
*
*/
private String defaultStorageClass;
/**
*
* 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.
*
*/
private String objectACL;
/**
*
* 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
*
*/
private Boolean readOnly;
/**
*
* 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
*
*/
private Boolean guessMIMETypeEnabled;
/**
*
* 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
*
*/
private Boolean requesterPays;
/**
*
* 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
*
*/
private Boolean sMBACLEnabled;
/**
*
* The files and folders on this share will only be visible to users with read access.
*
*/
private Boolean accessBasedEnumeration;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList adminUserList;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList validUserList;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList invalidUserList;
/**
*
* The Amazon Resource Name (ARN) of the storage used for audit logs.
*
*/
private String auditDestinationARN;
/**
*
* 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.
*
*/
private String caseSensitivity;
/**
*
* 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.
*
*
*/
private String fileShareName;
/**
*
* Specifies refresh cache information for the file share.
*
*/
private CacheAttributes cacheAttributes;
/**
*
* 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.
*
*
* {}
*
*/
private String notificationPolicy;
/**
*
* 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
*
*/
private Boolean oplocksEnabled;
/**
*
* The Amazon Resource Name (ARN) of the SMB file share that you want to update.
*
*
* @param fileShareARN
* The Amazon Resource Name (ARN) of the SMB file share that you want to update.
*/
public void setFileShareARN(String fileShareARN) {
this.fileShareARN = fileShareARN;
}
/**
*
* The Amazon Resource Name (ARN) of the SMB file share that you want to update.
*
*
* @return The Amazon Resource Name (ARN) of the SMB file share that you want to update.
*/
public String getFileShareARN() {
return this.fileShareARN;
}
/**
*
* The Amazon Resource Name (ARN) of the SMB file share that you want to update.
*
*
* @param fileShareARN
* The Amazon Resource Name (ARN) of the SMB file share that you want to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withFileShareARN(String fileShareARN) {
setFileShareARN(fileShareARN);
return this;
}
/**
*
* 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
*
*
* @param 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
*/
public void setKMSEncrypted(Boolean kMSEncrypted) {
this.kMSEncrypted = 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
*
*
* @return 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
*/
public Boolean getKMSEncrypted() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withKMSEncrypted(Boolean kMSEncrypted) {
setKMSEncrypted(kMSEncrypted);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public Boolean isKMSEncrypted() {
return this.kMSEncrypted;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setKMSKey(String kMSKey) {
this.kMSKey = 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.
*
*
* @return 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.
*/
public String getKMSKey() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withKMSKey(String kMSKey) {
setKMSKey(kMSKey);
return this;
}
/**
*
* The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
* S3_STANDARD. Optional.
*
*
* Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
* S3_ONEZONE_IA
*
*
* @param defaultStorageClass
* The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default
* value is S3_STANDARD. Optional.
*
* Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA
* | S3_ONEZONE_IA
*/
public void setDefaultStorageClass(String defaultStorageClass) {
this.defaultStorageClass = defaultStorageClass;
}
/**
*
* The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
* S3_STANDARD. Optional.
*
*
* Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
* S3_ONEZONE_IA
*
*
* @return The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default
* value is S3_STANDARD. Optional.
*
* Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
* S3_STANDARD_IA | S3_ONEZONE_IA
*/
public String getDefaultStorageClass() {
return this.defaultStorageClass;
}
/**
*
* The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
* S3_STANDARD. Optional.
*
*
* Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
* S3_ONEZONE_IA
*
*
* @param defaultStorageClass
* The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default
* value is S3_STANDARD. Optional.
*
* Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA
* | S3_ONEZONE_IA
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withDefaultStorageClass(String defaultStorageClass) {
setDefaultStorageClass(defaultStorageClass);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see ObjectACL
*/
public void setObjectACL(String objectACL) {
this.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.
*
*
* @return 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 ObjectACL
*/
public String getObjectACL() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectACL
*/
public UpdateSMBFileShareRequest withObjectACL(String objectACL) {
setObjectACL(objectACL);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectACL
*/
public UpdateSMBFileShareRequest withObjectACL(ObjectACL objectACL) {
this.objectACL = objectACL.toString();
return this;
}
/**
*
* 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
*
*
* @param 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
*/
public void setReadOnly(Boolean readOnly) {
this.readOnly = 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
*
*
* @return 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
*/
public Boolean getReadOnly() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withReadOnly(Boolean readOnly) {
setReadOnly(readOnly);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public Boolean isReadOnly() {
return this.readOnly;
}
/**
*
* 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
*
*
* @param 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
*/
public void setGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled) {
this.guessMIMETypeEnabled = 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
*
*
* @return 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
*/
public Boolean getGuessMIMETypeEnabled() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled) {
setGuessMIMETypeEnabled(guessMIMETypeEnabled);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public Boolean isGuessMIMETypeEnabled() {
return this.guessMIMETypeEnabled;
}
/**
*
* 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
*
*
* @param 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
*/
public void setRequesterPays(Boolean requesterPays) {
this.requesterPays = 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
*
*
* @return 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
*/
public Boolean getRequesterPays() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withRequesterPays(Boolean requesterPays) {
setRequesterPays(requesterPays);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public Boolean isRequesterPays() {
return this.requesterPays;
}
/**
*
* 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
*
*
* @param 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
*/
public void setSMBACLEnabled(Boolean sMBACLEnabled) {
this.sMBACLEnabled = 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
*
*
* @return 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
*/
public Boolean getSMBACLEnabled() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withSMBACLEnabled(Boolean sMBACLEnabled) {
setSMBACLEnabled(sMBACLEnabled);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public Boolean isSMBACLEnabled() {
return this.sMBACLEnabled;
}
/**
*
* The files and folders on this share will only be visible to users with read access.
*
*
* @param accessBasedEnumeration
* The files and folders on this share will only be visible to users with read access.
*/
public void setAccessBasedEnumeration(Boolean accessBasedEnumeration) {
this.accessBasedEnumeration = accessBasedEnumeration;
}
/**
*
* The files and folders on this share will only be visible to users with read access.
*
*
* @return The files and folders on this share will only be visible to users with read access.
*/
public Boolean getAccessBasedEnumeration() {
return this.accessBasedEnumeration;
}
/**
*
* The files and folders on this share will only be visible to users with read access.
*
*
* @param accessBasedEnumeration
* The files and folders on this share will only be visible to users with read access.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withAccessBasedEnumeration(Boolean accessBasedEnumeration) {
setAccessBasedEnumeration(accessBasedEnumeration);
return this;
}
/**
*
* The files and folders on this share will only be visible to users with read access.
*
*
* @return The files and folders on this share will only be visible to users with read access.
*/
public Boolean isAccessBasedEnumeration() {
return this.accessBasedEnumeration;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getAdminUserList() {
if (adminUserList == null) {
adminUserList = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setAdminUserList(java.util.Collection adminUserList) {
if (adminUserList == null) {
this.adminUserList = null;
return;
}
this.adminUserList = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAdminUserList(java.util.Collection)} or {@link #withAdminUserList(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withAdminUserList(String... adminUserList) {
if (this.adminUserList == null) {
setAdminUserList(new com.amazonaws.internal.SdkInternalList(adminUserList.length));
}
for (String ele : adminUserList) {
this.adminUserList.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withAdminUserList(java.util.Collection adminUserList) {
setAdminUserList(adminUserList);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getValidUserList() {
if (validUserList == null) {
validUserList = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setValidUserList(java.util.Collection validUserList) {
if (validUserList == null) {
this.validUserList = null;
return;
}
this.validUserList = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setValidUserList(java.util.Collection)} or {@link #withValidUserList(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withValidUserList(String... validUserList) {
if (this.validUserList == null) {
setValidUserList(new com.amazonaws.internal.SdkInternalList(validUserList.length));
}
for (String ele : validUserList) {
this.validUserList.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withValidUserList(java.util.Collection validUserList) {
setValidUserList(validUserList);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getInvalidUserList() {
if (invalidUserList == null) {
invalidUserList = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setInvalidUserList(java.util.Collection invalidUserList) {
if (invalidUserList == null) {
this.invalidUserList = null;
return;
}
this.invalidUserList = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInvalidUserList(java.util.Collection)} or {@link #withInvalidUserList(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withInvalidUserList(String... invalidUserList) {
if (this.invalidUserList == null) {
setInvalidUserList(new com.amazonaws.internal.SdkInternalList(invalidUserList.length));
}
for (String ele : invalidUserList) {
this.invalidUserList.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withInvalidUserList(java.util.Collection invalidUserList) {
setInvalidUserList(invalidUserList);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the storage used for audit logs.
*
*
* @param auditDestinationARN
* The Amazon Resource Name (ARN) of the storage used for audit logs.
*/
public void setAuditDestinationARN(String auditDestinationARN) {
this.auditDestinationARN = auditDestinationARN;
}
/**
*
* The Amazon Resource Name (ARN) of the storage used for audit logs.
*
*
* @return The Amazon Resource Name (ARN) of the storage used for audit logs.
*/
public String getAuditDestinationARN() {
return this.auditDestinationARN;
}
/**
*
* The Amazon Resource Name (ARN) of the storage used for audit logs.
*
*
* @param auditDestinationARN
* The Amazon Resource Name (ARN) of the storage used for audit logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withAuditDestinationARN(String auditDestinationARN) {
setAuditDestinationARN(auditDestinationARN);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see CaseSensitivity
*/
public void setCaseSensitivity(String caseSensitivity) {
this.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.
*
*
* @return 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 CaseSensitivity
*/
public String getCaseSensitivity() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CaseSensitivity
*/
public UpdateSMBFileShareRequest withCaseSensitivity(String caseSensitivity) {
setCaseSensitivity(caseSensitivity);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CaseSensitivity
*/
public UpdateSMBFileShareRequest withCaseSensitivity(CaseSensitivity caseSensitivity) {
this.caseSensitivity = caseSensitivity.toString();
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setFileShareName(String fileShareName) {
this.fileShareName = 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.
*
*
*
* @return 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.
*
*/
public String getFileShareName() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withFileShareName(String fileShareName) {
setFileShareName(fileShareName);
return this;
}
/**
*
* Specifies refresh cache information for the file share.
*
*
* @param cacheAttributes
* Specifies refresh cache information for the file share.
*/
public void setCacheAttributes(CacheAttributes cacheAttributes) {
this.cacheAttributes = cacheAttributes;
}
/**
*
* Specifies refresh cache information for the file share.
*
*
* @return Specifies refresh cache information for the file share.
*/
public CacheAttributes getCacheAttributes() {
return this.cacheAttributes;
}
/**
*
* Specifies refresh cache information for the file share.
*
*
* @param cacheAttributes
* Specifies refresh cache information for the file share.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withCacheAttributes(CacheAttributes cacheAttributes) {
setCacheAttributes(cacheAttributes);
return this;
}
/**
*
* 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.
*
*
* {}
*
*
* @param 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.
*
*
* {}
*/
public void setNotificationPolicy(String notificationPolicy) {
this.notificationPolicy = 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.
*
*
* {}
*
*
* @return 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.
*
*
* {}
*/
public String getNotificationPolicy() {
return this.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.
*
*
* {}
*
*
* @param 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.
*
*
* {}
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withNotificationPolicy(String notificationPolicy) {
setNotificationPolicy(notificationPolicy);
return this;
}
/**
*
* 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
*
*
* @param 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
*/
public void setOplocksEnabled(Boolean oplocksEnabled) {
this.oplocksEnabled = 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
*
*
* @return 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
*/
public Boolean getOplocksEnabled() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateSMBFileShareRequest withOplocksEnabled(Boolean oplocksEnabled) {
setOplocksEnabled(oplocksEnabled);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public Boolean isOplocksEnabled() {
return this.oplocksEnabled;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFileShareARN() != null)
sb.append("FileShareARN: ").append(getFileShareARN()).append(",");
if (getKMSEncrypted() != null)
sb.append("KMSEncrypted: ").append(getKMSEncrypted()).append(",");
if (getKMSKey() != null)
sb.append("KMSKey: ").append(getKMSKey()).append(",");
if (getDefaultStorageClass() != null)
sb.append("DefaultStorageClass: ").append(getDefaultStorageClass()).append(",");
if (getObjectACL() != null)
sb.append("ObjectACL: ").append(getObjectACL()).append(",");
if (getReadOnly() != null)
sb.append("ReadOnly: ").append(getReadOnly()).append(",");
if (getGuessMIMETypeEnabled() != null)
sb.append("GuessMIMETypeEnabled: ").append(getGuessMIMETypeEnabled()).append(",");
if (getRequesterPays() != null)
sb.append("RequesterPays: ").append(getRequesterPays()).append(",");
if (getSMBACLEnabled() != null)
sb.append("SMBACLEnabled: ").append(getSMBACLEnabled()).append(",");
if (getAccessBasedEnumeration() != null)
sb.append("AccessBasedEnumeration: ").append(getAccessBasedEnumeration()).append(",");
if (getAdminUserList() != null)
sb.append("AdminUserList: ").append(getAdminUserList()).append(",");
if (getValidUserList() != null)
sb.append("ValidUserList: ").append(getValidUserList()).append(",");
if (getInvalidUserList() != null)
sb.append("InvalidUserList: ").append(getInvalidUserList()).append(",");
if (getAuditDestinationARN() != null)
sb.append("AuditDestinationARN: ").append(getAuditDestinationARN()).append(",");
if (getCaseSensitivity() != null)
sb.append("CaseSensitivity: ").append(getCaseSensitivity()).append(",");
if (getFileShareName() != null)
sb.append("FileShareName: ").append(getFileShareName()).append(",");
if (getCacheAttributes() != null)
sb.append("CacheAttributes: ").append(getCacheAttributes()).append(",");
if (getNotificationPolicy() != null)
sb.append("NotificationPolicy: ").append(getNotificationPolicy()).append(",");
if (getOplocksEnabled() != null)
sb.append("OplocksEnabled: ").append(getOplocksEnabled());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateSMBFileShareRequest == false)
return false;
UpdateSMBFileShareRequest other = (UpdateSMBFileShareRequest) obj;
if (other.getFileShareARN() == null ^ this.getFileShareARN() == null)
return false;
if (other.getFileShareARN() != null && other.getFileShareARN().equals(this.getFileShareARN()) == false)
return false;
if (other.getKMSEncrypted() == null ^ this.getKMSEncrypted() == null)
return false;
if (other.getKMSEncrypted() != null && other.getKMSEncrypted().equals(this.getKMSEncrypted()) == false)
return false;
if (other.getKMSKey() == null ^ this.getKMSKey() == null)
return false;
if (other.getKMSKey() != null && other.getKMSKey().equals(this.getKMSKey()) == false)
return false;
if (other.getDefaultStorageClass() == null ^ this.getDefaultStorageClass() == null)
return false;
if (other.getDefaultStorageClass() != null && other.getDefaultStorageClass().equals(this.getDefaultStorageClass()) == false)
return false;
if (other.getObjectACL() == null ^ this.getObjectACL() == null)
return false;
if (other.getObjectACL() != null && other.getObjectACL().equals(this.getObjectACL()) == false)
return false;
if (other.getReadOnly() == null ^ this.getReadOnly() == null)
return false;
if (other.getReadOnly() != null && other.getReadOnly().equals(this.getReadOnly()) == false)
return false;
if (other.getGuessMIMETypeEnabled() == null ^ this.getGuessMIMETypeEnabled() == null)
return false;
if (other.getGuessMIMETypeEnabled() != null && other.getGuessMIMETypeEnabled().equals(this.getGuessMIMETypeEnabled()) == false)
return false;
if (other.getRequesterPays() == null ^ this.getRequesterPays() == null)
return false;
if (other.getRequesterPays() != null && other.getRequesterPays().equals(this.getRequesterPays()) == false)
return false;
if (other.getSMBACLEnabled() == null ^ this.getSMBACLEnabled() == null)
return false;
if (other.getSMBACLEnabled() != null && other.getSMBACLEnabled().equals(this.getSMBACLEnabled()) == false)
return false;
if (other.getAccessBasedEnumeration() == null ^ this.getAccessBasedEnumeration() == null)
return false;
if (other.getAccessBasedEnumeration() != null && other.getAccessBasedEnumeration().equals(this.getAccessBasedEnumeration()) == false)
return false;
if (other.getAdminUserList() == null ^ this.getAdminUserList() == null)
return false;
if (other.getAdminUserList() != null && other.getAdminUserList().equals(this.getAdminUserList()) == false)
return false;
if (other.getValidUserList() == null ^ this.getValidUserList() == null)
return false;
if (other.getValidUserList() != null && other.getValidUserList().equals(this.getValidUserList()) == false)
return false;
if (other.getInvalidUserList() == null ^ this.getInvalidUserList() == null)
return false;
if (other.getInvalidUserList() != null && other.getInvalidUserList().equals(this.getInvalidUserList()) == false)
return false;
if (other.getAuditDestinationARN() == null ^ this.getAuditDestinationARN() == null)
return false;
if (other.getAuditDestinationARN() != null && other.getAuditDestinationARN().equals(this.getAuditDestinationARN()) == false)
return false;
if (other.getCaseSensitivity() == null ^ this.getCaseSensitivity() == null)
return false;
if (other.getCaseSensitivity() != null && other.getCaseSensitivity().equals(this.getCaseSensitivity()) == false)
return false;
if (other.getFileShareName() == null ^ this.getFileShareName() == null)
return false;
if (other.getFileShareName() != null && other.getFileShareName().equals(this.getFileShareName()) == false)
return false;
if (other.getCacheAttributes() == null ^ this.getCacheAttributes() == null)
return false;
if (other.getCacheAttributes() != null && other.getCacheAttributes().equals(this.getCacheAttributes()) == false)
return false;
if (other.getNotificationPolicy() == null ^ this.getNotificationPolicy() == null)
return false;
if (other.getNotificationPolicy() != null && other.getNotificationPolicy().equals(this.getNotificationPolicy()) == false)
return false;
if (other.getOplocksEnabled() == null ^ this.getOplocksEnabled() == null)
return false;
if (other.getOplocksEnabled() != null && other.getOplocksEnabled().equals(this.getOplocksEnabled()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFileShareARN() == null) ? 0 : getFileShareARN().hashCode());
hashCode = prime * hashCode + ((getKMSEncrypted() == null) ? 0 : getKMSEncrypted().hashCode());
hashCode = prime * hashCode + ((getKMSKey() == null) ? 0 : getKMSKey().hashCode());
hashCode = prime * hashCode + ((getDefaultStorageClass() == null) ? 0 : getDefaultStorageClass().hashCode());
hashCode = prime * hashCode + ((getObjectACL() == null) ? 0 : getObjectACL().hashCode());
hashCode = prime * hashCode + ((getReadOnly() == null) ? 0 : getReadOnly().hashCode());
hashCode = prime * hashCode + ((getGuessMIMETypeEnabled() == null) ? 0 : getGuessMIMETypeEnabled().hashCode());
hashCode = prime * hashCode + ((getRequesterPays() == null) ? 0 : getRequesterPays().hashCode());
hashCode = prime * hashCode + ((getSMBACLEnabled() == null) ? 0 : getSMBACLEnabled().hashCode());
hashCode = prime * hashCode + ((getAccessBasedEnumeration() == null) ? 0 : getAccessBasedEnumeration().hashCode());
hashCode = prime * hashCode + ((getAdminUserList() == null) ? 0 : getAdminUserList().hashCode());
hashCode = prime * hashCode + ((getValidUserList() == null) ? 0 : getValidUserList().hashCode());
hashCode = prime * hashCode + ((getInvalidUserList() == null) ? 0 : getInvalidUserList().hashCode());
hashCode = prime * hashCode + ((getAuditDestinationARN() == null) ? 0 : getAuditDestinationARN().hashCode());
hashCode = prime * hashCode + ((getCaseSensitivity() == null) ? 0 : getCaseSensitivity().hashCode());
hashCode = prime * hashCode + ((getFileShareName() == null) ? 0 : getFileShareName().hashCode());
hashCode = prime * hashCode + ((getCacheAttributes() == null) ? 0 : getCacheAttributes().hashCode());
hashCode = prime * hashCode + ((getNotificationPolicy() == null) ? 0 : getNotificationPolicy().hashCode());
hashCode = prime * hashCode + ((getOplocksEnabled() == null) ? 0 : getOplocksEnabled().hashCode());
return hashCode;
}
@Override
public UpdateSMBFileShareRequest clone() {
return (UpdateSMBFileShareRequest) super.clone();
}
}