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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ConnectionAlias.Builder,ConnectionAlias>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.