software.amazon.awssdk.services.glue.model.S3GlueParquetTarget 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 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 data target that writes to Amazon S3 in Apache Parquet columnar storage.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class S3GlueParquetTarget implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(S3GlueParquetTarget::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(S3GlueParquetTarget::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>> PARTITION_KEYS_FIELD = SdkField
.>> builder(MarshallingType.LIST)
.memberName("PartitionKeys")
.getter(getter(S3GlueParquetTarget::partitionKeys))
.setter(setter(Builder::partitionKeys))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PartitionKeys").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Path")
.getter(getter(S3GlueParquetTarget::path)).setter(setter(Builder::path))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Path").build()).build();
private static final SdkField COMPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Compression").getter(getter(S3GlueParquetTarget::compressionAsString))
.setter(setter(Builder::compression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Compression").build()).build();
private static final SdkField SCHEMA_CHANGE_POLICY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SchemaChangePolicy")
.getter(getter(S3GlueParquetTarget::schemaChangePolicy)).setter(setter(Builder::schemaChangePolicy))
.constructor(DirectSchemaChangePolicy::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SchemaChangePolicy").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, INPUTS_FIELD,
PARTITION_KEYS_FIELD, PATH_FIELD, COMPRESSION_FIELD, SCHEMA_CHANGE_POLICY_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Name", NAME_FIELD);
put("Inputs", INPUTS_FIELD);
put("PartitionKeys", PARTITION_KEYS_FIELD);
put("Path", PATH_FIELD);
put("Compression", COMPRESSION_FIELD);
put("SchemaChangePolicy", SCHEMA_CHANGE_POLICY_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String name;
private final List inputs;
private final List> partitionKeys;
private final String path;
private final String compression;
private final DirectSchemaChangePolicy schemaChangePolicy;
private S3GlueParquetTarget(BuilderImpl builder) {
this.name = builder.name;
this.inputs = builder.inputs;
this.partitionKeys = builder.partitionKeys;
this.path = builder.path;
this.compression = builder.compression;
this.schemaChangePolicy = builder.schemaChangePolicy;
}
/**
*
* The name of the data target.
*
*
* @return The name of the data target.
*/
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 nodes that are inputs to the data target.
*
*
* 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 nodes that are inputs to the data target.
*/
public final List inputs() {
return inputs;
}
/**
* For responses, this returns true if the service returned a value for the PartitionKeys 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 hasPartitionKeys() {
return partitionKeys != null && !(partitionKeys instanceof SdkAutoConstructList);
}
/**
*
* Specifies native partitioning using a sequence of keys.
*
*
* 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 #hasPartitionKeys} method.
*
*
* @return Specifies native partitioning using a sequence of keys.
*/
public final List> partitionKeys() {
return partitionKeys;
}
/**
*
* A single Amazon S3 path to write to.
*
*
* @return A single Amazon S3 path to write to.
*/
public final String path() {
return path;
}
/**
*
* Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension.
* Possible values are "gzip" and "bzip").
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #compression} will
* return {@link ParquetCompressionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #compressionAsString}.
*
*
* @return Specifies how the data is compressed. This is generally not necessary if the data has a standard file
* extension. Possible values are "gzip" and "bzip").
* @see ParquetCompressionType
*/
public final ParquetCompressionType compression() {
return ParquetCompressionType.fromValue(compression);
}
/**
*
* Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension.
* Possible values are "gzip" and "bzip").
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #compression} will
* return {@link ParquetCompressionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #compressionAsString}.
*
*
* @return Specifies how the data is compressed. This is generally not necessary if the data has a standard file
* extension. Possible values are "gzip" and "bzip").
* @see ParquetCompressionType
*/
public final String compressionAsString() {
return compression;
}
/**
*
* A policy that specifies update behavior for the crawler.
*
*
* @return A policy that specifies update behavior for the crawler.
*/
public final DirectSchemaChangePolicy schemaChangePolicy() {
return schemaChangePolicy;
}
@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(hasPartitionKeys() ? partitionKeys() : null);
hashCode = 31 * hashCode + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(compressionAsString());
hashCode = 31 * hashCode + Objects.hashCode(schemaChangePolicy());
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 S3GlueParquetTarget)) {
return false;
}
S3GlueParquetTarget other = (S3GlueParquetTarget) obj;
return Objects.equals(name(), other.name()) && hasInputs() == other.hasInputs()
&& Objects.equals(inputs(), other.inputs()) && hasPartitionKeys() == other.hasPartitionKeys()
&& Objects.equals(partitionKeys(), other.partitionKeys()) && Objects.equals(path(), other.path())
&& Objects.equals(compressionAsString(), other.compressionAsString())
&& Objects.equals(schemaChangePolicy(), other.schemaChangePolicy());
}
/**
* 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("S3GlueParquetTarget").add("Name", name()).add("Inputs", hasInputs() ? inputs() : null)
.add("PartitionKeys", hasPartitionKeys() ? partitionKeys() : null).add("Path", path())
.add("Compression", compressionAsString()).add("SchemaChangePolicy", schemaChangePolicy()).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 "PartitionKeys":
return Optional.ofNullable(clazz.cast(partitionKeys()));
case "Path":
return Optional.ofNullable(clazz.cast(path()));
case "Compression":
return Optional.ofNullable(clazz.cast(compressionAsString()));
case "SchemaChangePolicy":
return Optional.ofNullable(clazz.cast(schemaChangePolicy()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((S3GlueParquetTarget) 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 data target.
*
*
* @param name
* The name of the data target.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The nodes that are inputs to the data target.
*
*
* @param inputs
* The nodes that are inputs to the data target.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inputs(Collection inputs);
/**
*
* The nodes that are inputs to the data target.
*
*
* @param inputs
* The nodes that are inputs to the data target.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inputs(String... inputs);
/**
*
* Specifies native partitioning using a sequence of keys.
*
*
* @param partitionKeys
* Specifies native partitioning using a sequence of keys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder partitionKeys(Collection> partitionKeys);
/**
*
* Specifies native partitioning using a sequence of keys.
*
*
* @param partitionKeys
* Specifies native partitioning using a sequence of keys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder partitionKeys(Collection... partitionKeys);
/**
*
* A single Amazon S3 path to write to.
*
*
* @param path
* A single Amazon S3 path to write to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder path(String path);
/**
*
* Specifies how the data is compressed. This is generally not necessary if the data has a standard file
* extension. Possible values are "gzip" and "bzip").
*
*
* @param compression
* Specifies how the data is compressed. This is generally not necessary if the data has a standard file
* extension. Possible values are "gzip" and "bzip").
* @see ParquetCompressionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ParquetCompressionType
*/
Builder compression(String compression);
/**
*
* Specifies how the data is compressed. This is generally not necessary if the data has a standard file
* extension. Possible values are "gzip" and "bzip").
*
*
* @param compression
* Specifies how the data is compressed. This is generally not necessary if the data has a standard file
* extension. Possible values are "gzip" and "bzip").
* @see ParquetCompressionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ParquetCompressionType
*/
Builder compression(ParquetCompressionType compression);
/**
*
* A policy that specifies update behavior for the crawler.
*
*
* @param schemaChangePolicy
* A policy that specifies update behavior for the crawler.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder schemaChangePolicy(DirectSchemaChangePolicy schemaChangePolicy);
/**
*
* A policy that specifies update behavior for the crawler.
*
* This is a convenience method that creates an instance of the {@link DirectSchemaChangePolicy.Builder}
* avoiding the need to create one manually via {@link DirectSchemaChangePolicy#builder()}.
*
*
* When the {@link Consumer} completes, {@link DirectSchemaChangePolicy.Builder#build()} is called immediately
* and its result is passed to {@link #schemaChangePolicy(DirectSchemaChangePolicy)}.
*
* @param schemaChangePolicy
* a consumer that will call methods on {@link DirectSchemaChangePolicy.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #schemaChangePolicy(DirectSchemaChangePolicy)
*/
default Builder schemaChangePolicy(Consumer schemaChangePolicy) {
return schemaChangePolicy(DirectSchemaChangePolicy.builder().applyMutation(schemaChangePolicy).build());
}
}
static final class BuilderImpl implements Builder {
private String name;
private List inputs = DefaultSdkAutoConstructList.getInstance();
private List> partitionKeys = DefaultSdkAutoConstructList.getInstance();
private String path;
private String compression;
private DirectSchemaChangePolicy schemaChangePolicy;
private BuilderImpl() {
}
private BuilderImpl(S3GlueParquetTarget model) {
name(model.name);
inputs(model.inputs);
partitionKeys(model.partitionKeys);
path(model.path);
compression(model.compression);
schemaChangePolicy(model.schemaChangePolicy);
}
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 = OneInputCopier.copy(inputs);
}
@Override
public final Builder inputs(Collection inputs) {
this.inputs = OneInputCopier.copy(inputs);
return this;
}
@Override
@SafeVarargs
public final Builder inputs(String... inputs) {
inputs(Arrays.asList(inputs));
return this;
}
public final Collection> getPartitionKeys() {
if (partitionKeys instanceof SdkAutoConstructList) {
return null;
}
return partitionKeys;
}
public final void setPartitionKeys(Collection> partitionKeys) {
this.partitionKeys = GlueStudioPathListCopier.copy(partitionKeys);
}
@Override
public final Builder partitionKeys(Collection> partitionKeys) {
this.partitionKeys = GlueStudioPathListCopier.copy(partitionKeys);
return this;
}
@Override
@SafeVarargs
public final Builder partitionKeys(Collection... partitionKeys) {
partitionKeys(Arrays.asList(partitionKeys));
return this;
}
public final String getPath() {
return path;
}
public final void setPath(String path) {
this.path = path;
}
@Override
public final Builder path(String path) {
this.path = path;
return this;
}
public final String getCompression() {
return compression;
}
public final void setCompression(String compression) {
this.compression = compression;
}
@Override
public final Builder compression(String compression) {
this.compression = compression;
return this;
}
@Override
public final Builder compression(ParquetCompressionType compression) {
this.compression(compression == null ? null : compression.toString());
return this;
}
public final DirectSchemaChangePolicy.Builder getSchemaChangePolicy() {
return schemaChangePolicy != null ? schemaChangePolicy.toBuilder() : null;
}
public final void setSchemaChangePolicy(DirectSchemaChangePolicy.BuilderImpl schemaChangePolicy) {
this.schemaChangePolicy = schemaChangePolicy != null ? schemaChangePolicy.build() : null;
}
@Override
public final Builder schemaChangePolicy(DirectSchemaChangePolicy schemaChangePolicy) {
this.schemaChangePolicy = schemaChangePolicy;
return this;
}
@Override
public S3GlueParquetTarget build() {
return new S3GlueParquetTarget(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}