software.amazon.awssdk.services.glue.model.Join Maven / Gradle / Ivy
Show all versions of glue 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.glue.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*
* Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data
* property keys. You can use inner, outer, left, right, left semi, and left anti joins.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Join implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Join::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField> INPUTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Inputs")
.getter(getter(Join::inputs))
.setter(setter(Builder::inputs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Inputs").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField JOIN_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("JoinType").getter(getter(Join::joinTypeAsString)).setter(setter(Builder::joinType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JoinType").build()).build();
private static final SdkField> COLUMNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Columns")
.getter(getter(Join::columns))
.setter(setter(Builder::columns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Columns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(JoinColumn::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, INPUTS_FIELD,
JOIN_TYPE_FIELD, COLUMNS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String name;
private final List inputs;
private final String joinType;
private final List columns;
private Join(BuilderImpl builder) {
this.name = builder.name;
this.inputs = builder.inputs;
this.joinType = builder.joinType;
this.columns = builder.columns;
}
/**
*
* The name of the transform node.
*
*
* @return The name of the transform node.
*/
public final String name() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the Inputs 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 hasInputs() {
return inputs != null && !(inputs instanceof SdkAutoConstructList);
}
/**
*
* The data inputs identified by their node names.
*
*
* 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 #hasInputs} method.
*
*
* @return The data inputs identified by their node names.
*/
public final List inputs() {
return inputs;
}
/**
*
* Specifies the type of join to be performed on the datasets.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #joinType} will
* return {@link JoinType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #joinTypeAsString}.
*
*
* @return Specifies the type of join to be performed on the datasets.
* @see JoinType
*/
public final JoinType joinType() {
return JoinType.fromValue(joinType);
}
/**
*
* Specifies the type of join to be performed on the datasets.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #joinType} will
* return {@link JoinType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #joinTypeAsString}.
*
*
* @return Specifies the type of join to be performed on the datasets.
* @see JoinType
*/
public final String joinTypeAsString() {
return joinType;
}
/**
* For responses, this returns true if the service returned a value for the Columns 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 hasColumns() {
return columns != null && !(columns instanceof SdkAutoConstructList);
}
/**
*
* A list of the two columns to be joined.
*
*
* 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 #hasColumns} method.
*
*
* @return A list of the two columns to be joined.
*/
public final List columns() {
return columns;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(hasInputs() ? inputs() : null);
hashCode = 31 * hashCode + Objects.hashCode(joinTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasColumns() ? columns() : 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 Join)) {
return false;
}
Join other = (Join) obj;
return Objects.equals(name(), other.name()) && hasInputs() == other.hasInputs()
&& Objects.equals(inputs(), other.inputs()) && Objects.equals(joinTypeAsString(), other.joinTypeAsString())
&& hasColumns() == other.hasColumns() && Objects.equals(columns(), other.columns());
}
/**
* 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("Join").add("Name", name()).add("Inputs", hasInputs() ? inputs() : null)
.add("JoinType", joinTypeAsString()).add("Columns", hasColumns() ? columns() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Inputs":
return Optional.ofNullable(clazz.cast(inputs()));
case "JoinType":
return Optional.ofNullable(clazz.cast(joinTypeAsString()));
case "Columns":
return Optional.ofNullable(clazz.cast(columns()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Name", NAME_FIELD);
map.put("Inputs", INPUTS_FIELD);
map.put("JoinType", JOIN_TYPE_FIELD);
map.put("Columns", COLUMNS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((Join) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the transform node.
*
*
* @param name
* The name of the transform node.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The data inputs identified by their node names.
*
*
* @param inputs
* The data inputs identified by their node names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inputs(Collection inputs);
/**
*
* The data inputs identified by their node names.
*
*
* @param inputs
* The data inputs identified by their node names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inputs(String... inputs);
/**
*
* Specifies the type of join to be performed on the datasets.
*
*
* @param joinType
* Specifies the type of join to be performed on the datasets.
* @see JoinType
* @return Returns a reference to this object so that method calls can be chained together.
* @see JoinType
*/
Builder joinType(String joinType);
/**
*
* Specifies the type of join to be performed on the datasets.
*
*
* @param joinType
* Specifies the type of join to be performed on the datasets.
* @see JoinType
* @return Returns a reference to this object so that method calls can be chained together.
* @see JoinType
*/
Builder joinType(JoinType joinType);
/**
*
* A list of the two columns to be joined.
*
*
* @param columns
* A list of the two columns to be joined.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columns(Collection columns);
/**
*
* A list of the two columns to be joined.
*
*
* @param columns
* A list of the two columns to be joined.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columns(JoinColumn... columns);
/**
*
* A list of the two columns to be joined.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.glue.model.JoinColumn.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.glue.model.JoinColumn#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.glue.model.JoinColumn.Builder#build()} is called immediately and its
* result is passed to {@link #columns(List)}.
*
* @param columns
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.glue.model.JoinColumn.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #columns(java.util.Collection)
*/
Builder columns(Consumer... columns);
}
static final class BuilderImpl implements Builder {
private String name;
private List inputs = DefaultSdkAutoConstructList.getInstance();
private String joinType;
private List columns = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Join model) {
name(model.name);
inputs(model.inputs);
joinType(model.joinType);
columns(model.columns);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final Collection getInputs() {
if (inputs instanceof SdkAutoConstructList) {
return null;
}
return inputs;
}
public final void setInputs(Collection inputs) {
this.inputs = TwoInputsCopier.copy(inputs);
}
@Override
public final Builder inputs(Collection inputs) {
this.inputs = TwoInputsCopier.copy(inputs);
return this;
}
@Override
@SafeVarargs
public final Builder inputs(String... inputs) {
inputs(Arrays.asList(inputs));
return this;
}
public final String getJoinType() {
return joinType;
}
public final void setJoinType(String joinType) {
this.joinType = joinType;
}
@Override
public final Builder joinType(String joinType) {
this.joinType = joinType;
return this;
}
@Override
public final Builder joinType(JoinType joinType) {
this.joinType(joinType == null ? null : joinType.toString());
return this;
}
public final List getColumns() {
List result = JoinColumnsCopier.copyToBuilder(this.columns);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setColumns(Collection columns) {
this.columns = JoinColumnsCopier.copyFromBuilder(columns);
}
@Override
public final Builder columns(Collection columns) {
this.columns = JoinColumnsCopier.copy(columns);
return this;
}
@Override
@SafeVarargs
public final Builder columns(JoinColumn... columns) {
columns(Arrays.asList(columns));
return this;
}
@Override
@SafeVarargs
public final Builder columns(Consumer... columns) {
columns(Stream.of(columns).map(c -> JoinColumn.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Join build() {
return new Join(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}