com.amazonaws.services.storagegateway.model

Class DescribeSMBSettingsResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.storagegateway.model.DescribeSMBSettingsResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSMBSettingsResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeSMBSettingsResult()

Method Summary

Modifier and Type	Method and Description
DescribeSMBSettingsResult	clone()
boolean	equals(Object obj)
String	getActiveDirectoryStatus() Indicates the status of a gateway that is a member of the Active Directory domain.
String	getDomainName() The name of the domain that the gateway is joined to.
Boolean	getFileSharesVisible() The shares on this gateway appear when listing shares.
String	getGatewayARN()
Boolean	getSMBGuestPasswordSet() This value is true if a password for the guest user smbguest is set, otherwise false.
String	getSMBSecurityStrategy() The type of security strategy that was specified for file gateway.
int	hashCode()
Boolean	isFileSharesVisible() The shares on this gateway appear when listing shares.
Boolean	isSMBGuestPasswordSet() This value is true if a password for the guest user smbguest is set, otherwise false.
void	setActiveDirectoryStatus(String activeDirectoryStatus) Indicates the status of a gateway that is a member of the Active Directory domain.
void	setDomainName(String domainName) The name of the domain that the gateway is joined to.
void	setFileSharesVisible(Boolean fileSharesVisible) The shares on this gateway appear when listing shares.
void	setGatewayARN(String gatewayARN)
void	setSMBGuestPasswordSet(Boolean sMBGuestPasswordSet) This value is true if a password for the guest user smbguest is set, otherwise false.
void	setSMBSecurityStrategy(String sMBSecurityStrategy) The type of security strategy that was specified for file gateway.
String	toString() Returns a string representation of this object.
DescribeSMBSettingsResult	withActiveDirectoryStatus(ActiveDirectoryStatus activeDirectoryStatus) Indicates the status of a gateway that is a member of the Active Directory domain.
DescribeSMBSettingsResult	withActiveDirectoryStatus(String activeDirectoryStatus) Indicates the status of a gateway that is a member of the Active Directory domain.
DescribeSMBSettingsResult	withDomainName(String domainName) The name of the domain that the gateway is joined to.
DescribeSMBSettingsResult	withFileSharesVisible(Boolean fileSharesVisible) The shares on this gateway appear when listing shares.
DescribeSMBSettingsResult	withGatewayARN(String gatewayARN)
DescribeSMBSettingsResult	withSMBGuestPasswordSet(Boolean sMBGuestPasswordSet) This value is true if a password for the guest user smbguest is set, otherwise false.
DescribeSMBSettingsResult	withSMBSecurityStrategy(SMBSecurityStrategy sMBSecurityStrategy) The type of security strategy that was specified for file gateway.
DescribeSMBSettingsResult	withSMBSecurityStrategy(String sMBSecurityStrategy) The type of security strategy that was specified for file gateway.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSMBSettingsResult

public DescribeSMBSettingsResult()

Method Detail

setGatewayARN

public void setGatewayARN(String gatewayARN)

Parameters:

gatewayARN -

getGatewayARN

public String getGatewayARN()

Returns:

withGatewayARN

public DescribeSMBSettingsResult withGatewayARN(String gatewayARN)

Parameters:

gatewayARN -

Returns:

Returns a reference to this object so that method calls can be chained together.

setDomainName

public void setDomainName(String domainName)

The name of the domain that the gateway is joined to.

Parameters:

domainName - The name of the domain that the gateway is joined to.

getDomainName

public String getDomainName()

The name of the domain that the gateway is joined to.

Returns:

The name of the domain that the gateway is joined to.

withDomainName

public DescribeSMBSettingsResult withDomainName(String domainName)

The name of the domain that the gateway is joined to.

Parameters:

domainName - The name of the domain that the gateway is joined to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setActiveDirectoryStatus

public void setActiveDirectoryStatus(String activeDirectoryStatus)

Indicates the status of a gateway that is a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

• DETACHED: Indicates that gateway is not joined to a domain.

• JOINED: Indicates that the gateway has successfully joined a domain.

• JOINING: Indicates that a JoinDomain operation is in progress.

• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

Parameters:

activeDirectoryStatus - Indicates the status of a gateway that is a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

• DETACHED: Indicates that gateway is not joined to a domain.

• JOINED: Indicates that the gateway has successfully joined a domain.

• JOINING: Indicates that a JoinDomain operation is in progress.

• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

See Also:

ActiveDirectoryStatus

getActiveDirectoryStatus

public String getActiveDirectoryStatus()

Indicates the status of a gateway that is a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

• DETACHED: Indicates that gateway is not joined to a domain.

• JOINED: Indicates that the gateway has successfully joined a domain.

• JOINING: Indicates that a JoinDomain operation is in progress.

• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

Returns:

Indicates the status of a gateway that is a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

• DETACHED: Indicates that gateway is not joined to a domain.

• JOINED: Indicates that the gateway has successfully joined a domain.

• JOINING: Indicates that a JoinDomain operation is in progress.

• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

See Also:

ActiveDirectoryStatus

withActiveDirectoryStatus

public DescribeSMBSettingsResult withActiveDirectoryStatus(String activeDirectoryStatus)

Indicates the status of a gateway that is a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

• DETACHED: Indicates that gateway is not joined to a domain.

• JOINED: Indicates that the gateway has successfully joined a domain.

• JOINING: Indicates that a JoinDomain operation is in progress.

• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

Parameters:

activeDirectoryStatus - Indicates the status of a gateway that is a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

• DETACHED: Indicates that gateway is not joined to a domain.

• JOINED: Indicates that the gateway has successfully joined a domain.

• JOINING: Indicates that a JoinDomain operation is in progress.

• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActiveDirectoryStatus

withActiveDirectoryStatus

public DescribeSMBSettingsResult withActiveDirectoryStatus(ActiveDirectoryStatus activeDirectoryStatus)

Indicates the status of a gateway that is a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

• DETACHED: Indicates that gateway is not joined to a domain.

• JOINED: Indicates that the gateway has successfully joined a domain.

• JOINING: Indicates that a JoinDomain operation is in progress.

• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

Parameters:

activeDirectoryStatus - Indicates the status of a gateway that is a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

• DETACHED: Indicates that gateway is not joined to a domain.

• JOINED: Indicates that the gateway has successfully joined a domain.

• JOINING: Indicates that a JoinDomain operation is in progress.

• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActiveDirectoryStatus

setSMBGuestPasswordSet

public void setSMBGuestPasswordSet(Boolean sMBGuestPasswordSet)

This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

Parameters:

sMBGuestPasswordSet - This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

getSMBGuestPasswordSet

public Boolean getSMBGuestPasswordSet()

This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

Returns:

This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

withSMBGuestPasswordSet

public DescribeSMBSettingsResult withSMBGuestPasswordSet(Boolean sMBGuestPasswordSet)

This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

Parameters:

sMBGuestPasswordSet - This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

Returns:

Returns a reference to this object so that method calls can be chained together.

isSMBGuestPasswordSet

public Boolean isSMBGuestPasswordSet()

This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

Returns:

This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

setSMBSecurityStrategy

public void setSMBSecurityStrategy(String sMBSecurityStrategy)

The type of security strategy that was specified for file gateway.

• ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

• MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

• MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Parameters:

sMBSecurityStrategy - The type of security strategy that was specified for file gateway.

• ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

• MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

• MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

See Also:

SMBSecurityStrategy

getSMBSecurityStrategy

public String getSMBSecurityStrategy()

The type of security strategy that was specified for file gateway.

• ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

• MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

• MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Returns:

The type of security strategy that was specified for file gateway.

• ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

• MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

• MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

See Also:

SMBSecurityStrategy

withSMBSecurityStrategy

public DescribeSMBSettingsResult withSMBSecurityStrategy(String sMBSecurityStrategy)

The type of security strategy that was specified for file gateway.

• ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

• MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

• MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Parameters:

sMBSecurityStrategy - The type of security strategy that was specified for file gateway.

• ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

• MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

• MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SMBSecurityStrategy

withSMBSecurityStrategy

public DescribeSMBSettingsResult withSMBSecurityStrategy(SMBSecurityStrategy sMBSecurityStrategy)

The type of security strategy that was specified for file gateway.

• ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

• MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

• MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Parameters:

sMBSecurityStrategy - The type of security strategy that was specified for file gateway.

• ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

• MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

• MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SMBSecurityStrategy

setFileSharesVisible

public void setFileSharesVisible(Boolean fileSharesVisible)

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Parameters:

fileSharesVisible - The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

getFileSharesVisible

public Boolean getFileSharesVisible()

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Returns:

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

withFileSharesVisible

public DescribeSMBSettingsResult withFileSharesVisible(Boolean fileSharesVisible)

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Parameters:

fileSharesVisible - The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Returns:

Returns a reference to this object so that method calls can be chained together.

isFileSharesVisible

public Boolean isFileSharesVisible()

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Returns:

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeSMBSettingsResult clone()

Overrides:

clone in class Object