All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.services.cleanrooms.model.ConfiguredTable Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Clean Rooms module holds the client classes that are used for communicating with Clean Rooms.

There is a newer version: 2.28.3
Show newest version
/*
 * 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.cleanrooms.model;

import java.io.Serializable;
import java.time.Instant;
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 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;

/**
 * 

* A table that has been configured for use in a collaboration. *

*/ @Generated("software.amazon.awssdk:codegen") public final class ConfiguredTable implements SdkPojo, Serializable, ToCopyableBuilder { private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("id") .getter(getter(ConfiguredTable::id)).setter(setter(Builder::id)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build(); private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn") .getter(getter(ConfiguredTable::arn)).setter(setter(Builder::arn)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build(); private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name") .getter(getter(ConfiguredTable::name)).setter(setter(Builder::name)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build(); private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING) .memberName("description").getter(getter(ConfiguredTable::description)).setter(setter(Builder::description)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build(); private static final SdkField TABLE_REFERENCE_FIELD = SdkField . builder(MarshallingType.SDK_POJO).memberName("tableReference") .getter(getter(ConfiguredTable::tableReference)).setter(setter(Builder::tableReference)) .constructor(TableReference::builder) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tableReference").build()).build(); private static final SdkField CREATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT) .memberName("createTime").getter(getter(ConfiguredTable::createTime)).setter(setter(Builder::createTime)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createTime").build()).build(); private static final SdkField UPDATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT) .memberName("updateTime").getter(getter(ConfiguredTable::updateTime)).setter(setter(Builder::updateTime)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("updateTime").build()).build(); private static final SdkField> ANALYSIS_RULE_TYPES_FIELD = SdkField .> builder(MarshallingType.LIST) .memberName("analysisRuleTypes") .getter(getter(ConfiguredTable::analysisRuleTypesAsStrings)) .setter(setter(Builder::analysisRuleTypesWithStrings)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("analysisRuleTypes").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 ANALYSIS_METHOD_FIELD = SdkField. builder(MarshallingType.STRING) .memberName("analysisMethod").getter(getter(ConfiguredTable::analysisMethodAsString)) .setter(setter(Builder::analysisMethod)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("analysisMethod").build()).build(); private static final SdkField> ALLOWED_COLUMNS_FIELD = SdkField .> builder(MarshallingType.LIST) .memberName("allowedColumns") .getter(getter(ConfiguredTable::allowedColumns)) .setter(setter(Builder::allowedColumns)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("allowedColumns").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD, NAME_FIELD, DESCRIPTION_FIELD, TABLE_REFERENCE_FIELD, CREATE_TIME_FIELD, UPDATE_TIME_FIELD, ANALYSIS_RULE_TYPES_FIELD, ANALYSIS_METHOD_FIELD, ALLOWED_COLUMNS_FIELD)); private static final long serialVersionUID = 1L; private final String id; private final String arn; private final String name; private final String description; private final TableReference tableReference; private final Instant createTime; private final Instant updateTime; private final List analysisRuleTypes; private final String analysisMethod; private final List allowedColumns; private ConfiguredTable(BuilderImpl builder) { this.id = builder.id; this.arn = builder.arn; this.name = builder.name; this.description = builder.description; this.tableReference = builder.tableReference; this.createTime = builder.createTime; this.updateTime = builder.updateTime; this.analysisRuleTypes = builder.analysisRuleTypes; this.analysisMethod = builder.analysisMethod; this.allowedColumns = builder.allowedColumns; } /** *

* The unique ID for the configured table. *

* * @return The unique ID for the configured table. */ public final String id() { return id; } /** *

* The unique ARN for the configured table. *

* * @return The unique ARN for the configured table. */ public final String arn() { return arn; } /** *

* A name for the configured table. *

* * @return A name for the configured table. */ public final String name() { return name; } /** *

* A description for the configured table. *

* * @return A description for the configured table. */ public final String description() { return description; } /** *

* The Glue table that this configured table represents. *

* * @return The Glue table that this configured table represents. */ public final TableReference tableReference() { return tableReference; } /** *

* The time the configured table was created. *

* * @return The time the configured table was created. */ public final Instant createTime() { return createTime; } /** *

* The time the configured table was last updated *

* * @return The time the configured table was last updated */ public final Instant updateTime() { return updateTime; } /** *

* The types of analysis rules associated with this configured table. Currently, only one analysis rule may be * associated with a configured table. *

*

* 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 #hasAnalysisRuleTypes} method. *

* * @return The types of analysis rules associated with this configured table. Currently, only one analysis rule may * be associated with a configured table. */ public final List analysisRuleTypes() { return ConfiguredTableAnalysisRuleTypeListCopier.copyStringToEnum(analysisRuleTypes); } /** * For responses, this returns true if the service returned a value for the AnalysisRuleTypes 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 hasAnalysisRuleTypes() { return analysisRuleTypes != null && !(analysisRuleTypes instanceof SdkAutoConstructList); } /** *

* The types of analysis rules associated with this configured table. Currently, only one analysis rule may be * associated with a configured table. *

*

* 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 #hasAnalysisRuleTypes} method. *

* * @return The types of analysis rules associated with this configured table. Currently, only one analysis rule may * be associated with a configured table. */ public final List analysisRuleTypesAsStrings() { return analysisRuleTypes; } /** *

* The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. *

*

* If the service returns an enum value that is not available in the current SDK version, {@link #analysisMethod} * will return {@link AnalysisMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available * from {@link #analysisMethodAsString}. *

* * @return The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. * @see AnalysisMethod */ public final AnalysisMethod analysisMethod() { return AnalysisMethod.fromValue(analysisMethod); } /** *

* The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. *

*

* If the service returns an enum value that is not available in the current SDK version, {@link #analysisMethod} * will return {@link AnalysisMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available * from {@link #analysisMethodAsString}. *

* * @return The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. * @see AnalysisMethod */ public final String analysisMethodAsString() { return analysisMethod; } /** * For responses, this returns true if the service returned a value for the AllowedColumns 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 hasAllowedColumns() { return allowedColumns != null && !(allowedColumns instanceof SdkAutoConstructList); } /** *

* The columns within the underlying Glue table that can be utilized within collaborations. *

*

* 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 #hasAllowedColumns} method. *

* * @return The columns within the underlying Glue table that can be utilized within collaborations. */ public final List allowedColumns() { return allowedColumns; } @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(id()); hashCode = 31 * hashCode + Objects.hashCode(arn()); hashCode = 31 * hashCode + Objects.hashCode(name()); hashCode = 31 * hashCode + Objects.hashCode(description()); hashCode = 31 * hashCode + Objects.hashCode(tableReference()); hashCode = 31 * hashCode + Objects.hashCode(createTime()); hashCode = 31 * hashCode + Objects.hashCode(updateTime()); hashCode = 31 * hashCode + Objects.hashCode(hasAnalysisRuleTypes() ? analysisRuleTypesAsStrings() : null); hashCode = 31 * hashCode + Objects.hashCode(analysisMethodAsString()); hashCode = 31 * hashCode + Objects.hashCode(hasAllowedColumns() ? allowedColumns() : 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 ConfiguredTable)) { return false; } ConfiguredTable other = (ConfiguredTable) obj; return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name()) && Objects.equals(description(), other.description()) && Objects.equals(tableReference(), other.tableReference()) && Objects.equals(createTime(), other.createTime()) && Objects.equals(updateTime(), other.updateTime()) && hasAnalysisRuleTypes() == other.hasAnalysisRuleTypes() && Objects.equals(analysisRuleTypesAsStrings(), other.analysisRuleTypesAsStrings()) && Objects.equals(analysisMethodAsString(), other.analysisMethodAsString()) && hasAllowedColumns() == other.hasAllowedColumns() && Objects.equals(allowedColumns(), other.allowedColumns()); } /** * 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("ConfiguredTable").add("Id", id()).add("Arn", arn()).add("Name", name()) .add("Description", description()).add("TableReference", tableReference()).add("CreateTime", createTime()) .add("UpdateTime", updateTime()) .add("AnalysisRuleTypes", hasAnalysisRuleTypes() ? analysisRuleTypesAsStrings() : null) .add("AnalysisMethod", analysisMethodAsString()) .add("AllowedColumns", hasAllowedColumns() ? allowedColumns() : null).build(); } public final Optional getValueForField(String fieldName, Class clazz) { switch (fieldName) { case "id": return Optional.ofNullable(clazz.cast(id())); case "arn": return Optional.ofNullable(clazz.cast(arn())); case "name": return Optional.ofNullable(clazz.cast(name())); case "description": return Optional.ofNullable(clazz.cast(description())); case "tableReference": return Optional.ofNullable(clazz.cast(tableReference())); case "createTime": return Optional.ofNullable(clazz.cast(createTime())); case "updateTime": return Optional.ofNullable(clazz.cast(updateTime())); case "analysisRuleTypes": return Optional.ofNullable(clazz.cast(analysisRuleTypesAsStrings())); case "analysisMethod": return Optional.ofNullable(clazz.cast(analysisMethodAsString())); case "allowedColumns": return Optional.ofNullable(clazz.cast(allowedColumns())); default: return Optional.empty(); } } @Override public final List> sdkFields() { return SDK_FIELDS; } private static Function getter(Function g) { return obj -> g.apply((ConfiguredTable) obj); } private static BiConsumer setter(BiConsumer s) { return (obj, val) -> s.accept((Builder) obj, val); } public interface Builder extends SdkPojo, CopyableBuilder { /** *

* The unique ID for the configured table. *

* * @param id * The unique ID for the configured table. * @return Returns a reference to this object so that method calls can be chained together. */ Builder id(String id); /** *

* The unique ARN for the configured table. *

* * @param arn * The unique ARN for the configured table. * @return Returns a reference to this object so that method calls can be chained together. */ Builder arn(String arn); /** *

* A name for the configured table. *

* * @param name * A name for the configured table. * @return Returns a reference to this object so that method calls can be chained together. */ Builder name(String name); /** *

* A description for the configured table. *

* * @param description * A description for the configured table. * @return Returns a reference to this object so that method calls can be chained together. */ Builder description(String description); /** *

* The Glue table that this configured table represents. *

* * @param tableReference * The Glue table that this configured table represents. * @return Returns a reference to this object so that method calls can be chained together. */ Builder tableReference(TableReference tableReference); /** *

* The Glue table that this configured table represents. *

* This is a convenience method that creates an instance of the {@link TableReference.Builder} avoiding the need * to create one manually via {@link TableReference#builder()}. * *

* When the {@link Consumer} completes, {@link TableReference.Builder#build()} is called immediately and its * result is passed to {@link #tableReference(TableReference)}. * * @param tableReference * a consumer that will call methods on {@link TableReference.Builder} * @return Returns a reference to this object so that method calls can be chained together. * @see #tableReference(TableReference) */ default Builder tableReference(Consumer tableReference) { return tableReference(TableReference.builder().applyMutation(tableReference).build()); } /** *

* The time the configured table was created. *

* * @param createTime * The time the configured table was created. * @return Returns a reference to this object so that method calls can be chained together. */ Builder createTime(Instant createTime); /** *

* The time the configured table was last updated *

* * @param updateTime * The time the configured table was last updated * @return Returns a reference to this object so that method calls can be chained together. */ Builder updateTime(Instant updateTime); /** *

* The types of analysis rules associated with this configured table. Currently, only one analysis rule may be * associated with a configured table. *

* * @param analysisRuleTypes * The types of analysis rules associated with this configured table. Currently, only one analysis rule * may be associated with a configured table. * @return Returns a reference to this object so that method calls can be chained together. */ Builder analysisRuleTypesWithStrings(Collection analysisRuleTypes); /** *

* The types of analysis rules associated with this configured table. Currently, only one analysis rule may be * associated with a configured table. *

* * @param analysisRuleTypes * The types of analysis rules associated with this configured table. Currently, only one analysis rule * may be associated with a configured table. * @return Returns a reference to this object so that method calls can be chained together. */ Builder analysisRuleTypesWithStrings(String... analysisRuleTypes); /** *

* The types of analysis rules associated with this configured table. Currently, only one analysis rule may be * associated with a configured table. *

* * @param analysisRuleTypes * The types of analysis rules associated with this configured table. Currently, only one analysis rule * may be associated with a configured table. * @return Returns a reference to this object so that method calls can be chained together. */ Builder analysisRuleTypes(Collection analysisRuleTypes); /** *

* The types of analysis rules associated with this configured table. Currently, only one analysis rule may be * associated with a configured table. *

* * @param analysisRuleTypes * The types of analysis rules associated with this configured table. Currently, only one analysis rule * may be associated with a configured table. * @return Returns a reference to this object so that method calls can be chained together. */ Builder analysisRuleTypes(ConfiguredTableAnalysisRuleType... analysisRuleTypes); /** *

* The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. *

* * @param analysisMethod * The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. * @see AnalysisMethod * @return Returns a reference to this object so that method calls can be chained together. * @see AnalysisMethod */ Builder analysisMethod(String analysisMethod); /** *

* The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. *

* * @param analysisMethod * The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. * @see AnalysisMethod * @return Returns a reference to this object so that method calls can be chained together. * @see AnalysisMethod */ Builder analysisMethod(AnalysisMethod analysisMethod); /** *

* The columns within the underlying Glue table that can be utilized within collaborations. *

* * @param allowedColumns * The columns within the underlying Glue table that can be utilized within collaborations. * @return Returns a reference to this object so that method calls can be chained together. */ Builder allowedColumns(Collection allowedColumns); /** *

* The columns within the underlying Glue table that can be utilized within collaborations. *

* * @param allowedColumns * The columns within the underlying Glue table that can be utilized within collaborations. * @return Returns a reference to this object so that method calls can be chained together. */ Builder allowedColumns(String... allowedColumns); } static final class BuilderImpl implements Builder { private String id; private String arn; private String name; private String description; private TableReference tableReference; private Instant createTime; private Instant updateTime; private List analysisRuleTypes = DefaultSdkAutoConstructList.getInstance(); private String analysisMethod; private List allowedColumns = DefaultSdkAutoConstructList.getInstance(); private BuilderImpl() { } private BuilderImpl(ConfiguredTable model) { id(model.id); arn(model.arn); name(model.name); description(model.description); tableReference(model.tableReference); createTime(model.createTime); updateTime(model.updateTime); analysisRuleTypesWithStrings(model.analysisRuleTypes); analysisMethod(model.analysisMethod); allowedColumns(model.allowedColumns); } public final String getId() { return id; } public final void setId(String id) { this.id = id; } @Override public final Builder id(String id) { this.id = id; return this; } public final String getArn() { return arn; } public final void setArn(String arn) { this.arn = arn; } @Override public final Builder arn(String arn) { this.arn = arn; return this; } 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 String getDescription() { return description; } public final void setDescription(String description) { this.description = description; } @Override public final Builder description(String description) { this.description = description; return this; } public final TableReference.Builder getTableReference() { return tableReference != null ? tableReference.toBuilder() : null; } public final void setTableReference(TableReference.BuilderImpl tableReference) { this.tableReference = tableReference != null ? tableReference.build() : null; } @Override public final Builder tableReference(TableReference tableReference) { this.tableReference = tableReference; return this; } public final Instant getCreateTime() { return createTime; } public final void setCreateTime(Instant createTime) { this.createTime = createTime; } @Override public final Builder createTime(Instant createTime) { this.createTime = createTime; return this; } public final Instant getUpdateTime() { return updateTime; } public final void setUpdateTime(Instant updateTime) { this.updateTime = updateTime; } @Override public final Builder updateTime(Instant updateTime) { this.updateTime = updateTime; return this; } public final Collection getAnalysisRuleTypes() { if (analysisRuleTypes instanceof SdkAutoConstructList) { return null; } return analysisRuleTypes; } public final void setAnalysisRuleTypes(Collection analysisRuleTypes) { this.analysisRuleTypes = ConfiguredTableAnalysisRuleTypeListCopier.copy(analysisRuleTypes); } @Override public final Builder analysisRuleTypesWithStrings(Collection analysisRuleTypes) { this.analysisRuleTypes = ConfiguredTableAnalysisRuleTypeListCopier.copy(analysisRuleTypes); return this; } @Override @SafeVarargs public final Builder analysisRuleTypesWithStrings(String... analysisRuleTypes) { analysisRuleTypesWithStrings(Arrays.asList(analysisRuleTypes)); return this; } @Override public final Builder analysisRuleTypes(Collection analysisRuleTypes) { this.analysisRuleTypes = ConfiguredTableAnalysisRuleTypeListCopier.copyEnumToString(analysisRuleTypes); return this; } @Override @SafeVarargs public final Builder analysisRuleTypes(ConfiguredTableAnalysisRuleType... analysisRuleTypes) { analysisRuleTypes(Arrays.asList(analysisRuleTypes)); return this; } public final String getAnalysisMethod() { return analysisMethod; } public final void setAnalysisMethod(String analysisMethod) { this.analysisMethod = analysisMethod; } @Override public final Builder analysisMethod(String analysisMethod) { this.analysisMethod = analysisMethod; return this; } @Override public final Builder analysisMethod(AnalysisMethod analysisMethod) { this.analysisMethod(analysisMethod == null ? null : analysisMethod.toString()); return this; } public final Collection getAllowedColumns() { if (allowedColumns instanceof SdkAutoConstructList) { return null; } return allowedColumns; } public final void setAllowedColumns(Collection allowedColumns) { this.allowedColumns = AllowedColumnListCopier.copy(allowedColumns); } @Override public final Builder allowedColumns(Collection allowedColumns) { this.allowedColumns = AllowedColumnListCopier.copy(allowedColumns); return this; } @Override @SafeVarargs public final Builder allowedColumns(String... allowedColumns) { allowedColumns(Arrays.asList(allowedColumns)); return this; } @Override public ConfiguredTable build() { return new ConfiguredTable(this); } @Override public List> sdkFields() { return SDK_FIELDS; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy