Package software.amazon.awssdk.services.workspaces.model

Class ConnectionAlias

java.lang.Object

software.amazon.awssdk.services.workspaces.model.ConnectionAlias

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConnectionAlias.Builder,ConnectionAlias>

@Generated("software.amazon.awssdk:codegen")
public final class ConnectionAlias
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConnectionAlias.Builder,ConnectionAlias>

Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConnectionAlias.Builder

Method Summary

Modifier and Type	Method	Description
String	aliasId()	The identifier of the connection alias.
List<ConnectionAliasAssociation>	associations()	The association status of the connection alias.
static ConnectionAlias.Builder	builder()
String	connectionString()	The connection string specified for the connection alias.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAssociations()	For responses, this returns true if the service returned a value for the Associations property.
int	hashCode()
String	ownerAccountId()	The identifier of the Amazon Web Services account that owns the connection alias.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ConnectionAlias.Builder>	serializableBuilderClass()
ConnectionAliasState	state()	The current state of the connection alias.
String	stateAsString()	The current state of the connection alias.
ConnectionAlias.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

connectionString

public final String connectionString()

The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.

Returns:

The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.

aliasId

public final String aliasId()

The identifier of the connection alias.

Returns:

The identifier of the connection alias.

state

public final ConnectionAliasState state()

The current state of the connection alias.

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

Returns:

The current state of the connection alias.

See Also:

ConnectionAliasState

stateAsString

public final String stateAsString()

The current state of the connection alias.

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

Returns:

The current state of the connection alias.

See Also:

ConnectionAliasState

ownerAccountId

public final String ownerAccountId()

The identifier of the Amazon Web Services account that owns the connection alias.

Returns:

The identifier of the Amazon Web Services account that owns the connection alias.

hasAssociations

public final boolean hasAssociations()

For responses, this returns true if the service returned a value for the Associations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

associations

public final List<ConnectionAliasAssociation> associations()

The association status of the connection alias.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociations() method.

Returns:

The association status of the connection alias.

toBuilder

public ConnectionAlias.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectionAlias.Builder,ConnectionAlias>

builder

public static ConnectionAlias.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo