software.amazon.awssdk.services.storagegateway.model

Class DescribeSmbSettingsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

software.amazon.awssdk.services.storagegateway.model.DescribeSmbSettingsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSmbSettingsResponse.Builder,DescribeSmbSettingsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeSmbSettingsResponse.Builder

Method Summary

Modifier and Type	Method and Description
ActiveDirectoryStatus	activeDirectoryStatus() Indicates the status of a gateway that is a member of the Active Directory domain.
String	activeDirectoryStatusAsString() Indicates the status of a gateway that is a member of the Active Directory domain.
static DescribeSmbSettingsResponse.Builder	builder()
String	domainName() The name of the domain that the gateway is joined to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	fileSharesVisible() The shares on this gateway appear when listing shares.
String	gatewayARN() Returns the value of the GatewayARN property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSmbSettingsResponse.Builder>	serializableBuilderClass()
Boolean	smbGuestPasswordSet() This value is true if a password for the guest user smbguest is set, otherwise false.
SMBLocalGroups	smbLocalGroups() A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
SMBSecurityStrategy	smbSecurityStrategy() The type of security strategy that was specified for file gateway.
String	smbSecurityStrategyAsString() The type of security strategy that was specified for file gateway.
DescribeSmbSettingsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

gatewayARN

public final String gatewayARN()

Returns the value of the GatewayARN property for this object.

Returns:

The value of the GatewayARN property for this object.

domainName

public final String domainName()

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

Returns:

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

activeDirectoryStatus

public final 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.

If the service returns an enum value that is not available in the current SDK version, activeDirectoryStatus will return ActiveDirectoryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activeDirectoryStatusAsString().

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

activeDirectoryStatusAsString

public final String activeDirectoryStatusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, activeDirectoryStatus will return ActiveDirectoryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activeDirectoryStatusAsString().

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

smbGuestPasswordSet

public final 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

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

smbSecurityStrategy

public final 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.

If the service returns an enum value that is not available in the current SDK version, smbSecurityStrategy will return SMBSecurityStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from smbSecurityStrategyAsString().

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

smbSecurityStrategyAsString

public final String smbSecurityStrategyAsString()

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.

If the service returns an enum value that is not available in the current SDK version, smbSecurityStrategy will return SMBSecurityStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from smbSecurityStrategyAsString().

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

fileSharesVisible

public final Boolean fileSharesVisible()

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.

smbLocalGroups

public final SMBLocalGroups smbLocalGroups()

A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

Returns:

A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

toBuilder

public DescribeSmbSettingsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSmbSettingsResponse.Builder,DescribeSmbSettingsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeSmbSettingsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSmbSettingsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo