software.amazon.awssdk.services.glue.model.IcebergTarget Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of glue Show documentation
Show all versions of glue Show documentation
The AWS Java SDK for AWS Glue module holds the client classes that are used for communicating
with AWS Glue Service
/*
* 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.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 an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class IcebergTarget implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> PATHS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Paths")
.getter(getter(IcebergTarget::paths))
.setter(setter(Builder::paths))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Paths").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 CONNECTION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConnectionName").getter(getter(IcebergTarget::connectionName)).setter(setter(Builder::connectionName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConnectionName").build()).build();
private static final SdkField> EXCLUSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Exclusions")
.getter(getter(IcebergTarget::exclusions))
.setter(setter(Builder::exclusions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Exclusions").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 MAXIMUM_TRAVERSAL_DEPTH_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaximumTraversalDepth").getter(getter(IcebergTarget::maximumTraversalDepth))
.setter(setter(Builder::maximumTraversalDepth))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaximumTraversalDepth").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATHS_FIELD,
CONNECTION_NAME_FIELD, EXCLUSIONS_FIELD, MAXIMUM_TRAVERSAL_DEPTH_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final List paths;
private final String connectionName;
private final List exclusions;
private final Integer maximumTraversalDepth;
private IcebergTarget(BuilderImpl builder) {
this.paths = builder.paths;
this.connectionName = builder.connectionName;
this.exclusions = builder.exclusions;
this.maximumTraversalDepth = builder.maximumTraversalDepth;
}
/**
* For responses, this returns true if the service returned a value for the Paths 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 hasPaths() {
return paths != null && !(paths instanceof SdkAutoConstructList);
}
/**
*
* One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
*
*
* 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 #hasPaths} method.
*
*
* @return One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
*/
public final List paths() {
return paths;
}
/**
*
* The name of the connection to use to connect to the Iceberg target.
*
*
* @return The name of the connection to use to connect to the Iceberg target.
*/
public final String connectionName() {
return connectionName;
}
/**
* For responses, this returns true if the service returned a value for the Exclusions 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 hasExclusions() {
return exclusions != null && !(exclusions instanceof SdkAutoConstructList);
}
/**
*
* A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
*
*
* 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 #hasExclusions} method.
*
*
* @return A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
*/
public final List exclusions() {
return exclusions;
}
/**
*
* The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in
* your Amazon S3 path. Used to limit the crawler run time.
*
*
* @return The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata
* folder in your Amazon S3 path. Used to limit the crawler run time.
*/
public final Integer maximumTraversalDepth() {
return maximumTraversalDepth;
}
@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(hasPaths() ? paths() : null);
hashCode = 31 * hashCode + Objects.hashCode(connectionName());
hashCode = 31 * hashCode + Objects.hashCode(hasExclusions() ? exclusions() : null);
hashCode = 31 * hashCode + Objects.hashCode(maximumTraversalDepth());
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 IcebergTarget)) {
return false;
}
IcebergTarget other = (IcebergTarget) obj;
return hasPaths() == other.hasPaths() && Objects.equals(paths(), other.paths())
&& Objects.equals(connectionName(), other.connectionName()) && hasExclusions() == other.hasExclusions()
&& Objects.equals(exclusions(), other.exclusions())
&& Objects.equals(maximumTraversalDepth(), other.maximumTraversalDepth());
}
/**
* 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("IcebergTarget").add("Paths", hasPaths() ? paths() : null)
.add("ConnectionName", connectionName()).add("Exclusions", hasExclusions() ? exclusions() : null)
.add("MaximumTraversalDepth", maximumTraversalDepth()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Paths":
return Optional.ofNullable(clazz.cast(paths()));
case "ConnectionName":
return Optional.ofNullable(clazz.cast(connectionName()));
case "Exclusions":
return Optional.ofNullable(clazz.cast(exclusions()));
case "MaximumTraversalDepth":
return Optional.ofNullable(clazz.cast(maximumTraversalDepth()));
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("Paths", PATHS_FIELD);
map.put("ConnectionName", CONNECTION_NAME_FIELD);
map.put("Exclusions", EXCLUSIONS_FIELD);
map.put("MaximumTraversalDepth", MAXIMUM_TRAVERSAL_DEPTH_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((IcebergTarget) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
*
*
* @param paths
* One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder paths(Collection paths);
/**
*
* One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
*
*
* @param paths
* One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder paths(String... paths);
/**
*
* The name of the connection to use to connect to the Iceberg target.
*
*
* @param connectionName
* The name of the connection to use to connect to the Iceberg target.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder connectionName(String connectionName);
/**
*
* A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
*
*
* @param exclusions
* A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder exclusions(Collection exclusions);
/**
*
* A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
*
*
* @param exclusions
* A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder exclusions(String... exclusions);
/**
*
* The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in
* your Amazon S3 path. Used to limit the crawler run time.
*
*
* @param maximumTraversalDepth
* The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata
* folder in your Amazon S3 path. Used to limit the crawler run time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maximumTraversalDepth(Integer maximumTraversalDepth);
}
static final class BuilderImpl implements Builder {
private List paths = DefaultSdkAutoConstructList.getInstance();
private String connectionName;
private List exclusions = DefaultSdkAutoConstructList.getInstance();
private Integer maximumTraversalDepth;
private BuilderImpl() {
}
private BuilderImpl(IcebergTarget model) {
paths(model.paths);
connectionName(model.connectionName);
exclusions(model.exclusions);
maximumTraversalDepth(model.maximumTraversalDepth);
}
public final Collection getPaths() {
if (paths instanceof SdkAutoConstructList) {
return null;
}
return paths;
}
public final void setPaths(Collection paths) {
this.paths = PathListCopier.copy(paths);
}
@Override
public final Builder paths(Collection paths) {
this.paths = PathListCopier.copy(paths);
return this;
}
@Override
@SafeVarargs
public final Builder paths(String... paths) {
paths(Arrays.asList(paths));
return this;
}
public final String getConnectionName() {
return connectionName;
}
public final void setConnectionName(String connectionName) {
this.connectionName = connectionName;
}
@Override
public final Builder connectionName(String connectionName) {
this.connectionName = connectionName;
return this;
}
public final Collection getExclusions() {
if (exclusions instanceof SdkAutoConstructList) {
return null;
}
return exclusions;
}
public final void setExclusions(Collection exclusions) {
this.exclusions = PathListCopier.copy(exclusions);
}
@Override
public final Builder exclusions(Collection exclusions) {
this.exclusions = PathListCopier.copy(exclusions);
return this;
}
@Override
@SafeVarargs
public final Builder exclusions(String... exclusions) {
exclusions(Arrays.asList(exclusions));
return this;
}
public final Integer getMaximumTraversalDepth() {
return maximumTraversalDepth;
}
public final void setMaximumTraversalDepth(Integer maximumTraversalDepth) {
this.maximumTraversalDepth = maximumTraversalDepth;
}
@Override
public final Builder maximumTraversalDepth(Integer maximumTraversalDepth) {
this.maximumTraversalDepth = maximumTraversalDepth;
return this;
}
@Override
public IcebergTarget build() {
return new IcebergTarget(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy