software.amazon.awssdk.services.workspaces.model.ConnectionAlias Maven / Gradle / Ivy
Show all versions of workspaces Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.workspaces.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region
* Redirection for Amazon WorkSpaces.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ConnectionAlias implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField CONNECTION_STRING_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConnectionString").getter(getter(ConnectionAlias::connectionString))
.setter(setter(Builder::connectionString))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConnectionString").build()).build();
private static final SdkField ALIAS_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AliasId").getter(getter(ConnectionAlias::aliasId)).setter(setter(Builder::aliasId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AliasId").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(ConnectionAlias::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField OWNER_ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OwnerAccountId").getter(getter(ConnectionAlias::ownerAccountId)).setter(setter(Builder::ownerAccountId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OwnerAccountId").build()).build();
private static final SdkField> ASSOCIATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Associations")
.getter(getter(ConnectionAlias::associations))
.setter(setter(Builder::associations))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Associations").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ConnectionAliasAssociation::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONNECTION_STRING_FIELD,
ALIAS_ID_FIELD, STATE_FIELD, OWNER_ACCOUNT_ID_FIELD, ASSOCIATIONS_FIELD));
private static final long serialVersionUID = 1L;
private final String connectionString;
private final String aliasId;
private final String state;
private final String ownerAccountId;
private final List associations;
private ConnectionAlias(BuilderImpl builder) {
this.connectionString = builder.connectionString;
this.aliasId = builder.aliasId;
this.state = builder.state;
this.ownerAccountId = builder.ownerAccountId;
this.associations = builder.associations;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String connectionString() {
return connectionString;
}
/**
*
* The identifier of the connection alias.
*
*
* @return The identifier of the connection alias.
*/
public final String aliasId() {
return aliasId;
}
/**
*
* The current state of the connection alias.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link ConnectionAliasState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the connection alias.
* @see ConnectionAliasState
*/
public final ConnectionAliasState state() {
return ConnectionAliasState.fromValue(state);
}
/**
*
* The current state of the connection alias.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link ConnectionAliasState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the connection alias.
* @see ConnectionAliasState
*/
public final String stateAsString() {
return state;
}
/**
*
* The identifier of the Amazon Web Services account that owns the connection alias.
*
*
* @return The identifier of the Amazon Web Services account that owns the connection alias.
*/
public final String ownerAccountId() {
return ownerAccountId;
}
/**
* 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 {@code 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.
*/
public final boolean hasAssociations() {
return associations != null && !(associations instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasAssociations} method.
*
*
* @return The association status of the connection alias.
*/
public final List associations() {
return associations;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(connectionString());
hashCode = 31 * hashCode + Objects.hashCode(aliasId());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(ownerAccountId());
hashCode = 31 * hashCode + Objects.hashCode(hasAssociations() ? associations() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ConnectionAlias)) {
return false;
}
ConnectionAlias other = (ConnectionAlias) obj;
return Objects.equals(connectionString(), other.connectionString()) && Objects.equals(aliasId(), other.aliasId())
&& Objects.equals(stateAsString(), other.stateAsString())
&& Objects.equals(ownerAccountId(), other.ownerAccountId()) && hasAssociations() == other.hasAssociations()
&& Objects.equals(associations(), other.associations());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ConnectionAlias").add("ConnectionString", connectionString()).add("AliasId", aliasId())
.add("State", stateAsString()).add("OwnerAccountId", ownerAccountId())
.add("Associations", hasAssociations() ? associations() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ConnectionString":
return Optional.ofNullable(clazz.cast(connectionString()));
case "AliasId":
return Optional.ofNullable(clazz.cast(aliasId()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "OwnerAccountId":
return Optional.ofNullable(clazz.cast(ownerAccountId()));
case "Associations":
return Optional.ofNullable(clazz.cast(associations()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ConnectionAlias) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder connectionString(String connectionString);
/**
*
* The identifier of the connection alias.
*
*
* @param aliasId
* The identifier of the connection alias.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder aliasId(String aliasId);
/**
*
* The current state of the connection alias.
*
*
* @param state
* The current state of the connection alias.
* @see ConnectionAliasState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionAliasState
*/
Builder state(String state);
/**
*
* The current state of the connection alias.
*
*
* @param state
* The current state of the connection alias.
* @see ConnectionAliasState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionAliasState
*/
Builder state(ConnectionAliasState state);
/**
*
* The identifier of the Amazon Web Services account that owns the connection alias.
*
*
* @param ownerAccountId
* The identifier of the Amazon Web Services account that owns the connection alias.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ownerAccountId(String ownerAccountId);
/**
*
* The association status of the connection alias.
*
*
* @param associations
* The association status of the connection alias.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder associations(Collection associations);
/**
*
* The association status of the connection alias.
*
*
* @param associations
* The association status of the connection alias.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder associations(ConnectionAliasAssociation... associations);
/**
*
* The association status of the connection alias.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workspaces.model.ConnectionAliasAssociation.Builder} avoiding the need
* to create one manually via
* {@link software.amazon.awssdk.services.workspaces.model.ConnectionAliasAssociation#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workspaces.model.ConnectionAliasAssociation.Builder#build()} is called
* immediately and its result is passed to {@link #associations(List)}.
*
* @param associations
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workspaces.model.ConnectionAliasAssociation.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #associations(java.util.Collection)
*/
Builder associations(Consumer... associations);
}
static final class BuilderImpl implements Builder {
private String connectionString;
private String aliasId;
private String state;
private String ownerAccountId;
private List associations = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ConnectionAlias model) {
connectionString(model.connectionString);
aliasId(model.aliasId);
state(model.state);
ownerAccountId(model.ownerAccountId);
associations(model.associations);
}
public final String getConnectionString() {
return connectionString;
}
public final void setConnectionString(String connectionString) {
this.connectionString = connectionString;
}
@Override
public final Builder connectionString(String connectionString) {
this.connectionString = connectionString;
return this;
}
public final String getAliasId() {
return aliasId;
}
public final void setAliasId(String aliasId) {
this.aliasId = aliasId;
}
@Override
public final Builder aliasId(String aliasId) {
this.aliasId = aliasId;
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(ConnectionAliasState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final String getOwnerAccountId() {
return ownerAccountId;
}
public final void setOwnerAccountId(String ownerAccountId) {
this.ownerAccountId = ownerAccountId;
}
@Override
public final Builder ownerAccountId(String ownerAccountId) {
this.ownerAccountId = ownerAccountId;
return this;
}
public final List getAssociations() {
List result = ConnectionAliasAssociationListCopier
.copyToBuilder(this.associations);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAssociations(Collection associations) {
this.associations = ConnectionAliasAssociationListCopier.copyFromBuilder(associations);
}
@Override
public final Builder associations(Collection associations) {
this.associations = ConnectionAliasAssociationListCopier.copy(associations);
return this;
}
@Override
@SafeVarargs
public final Builder associations(ConnectionAliasAssociation... associations) {
associations(Arrays.asList(associations));
return this;
}
@Override
@SafeVarargs
public final Builder associations(Consumer... associations) {
associations(Stream.of(associations).map(c -> ConnectionAliasAssociation.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ConnectionAlias build() {
return new ConnectionAlias(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}