software.amazon.awssdk.services.cleanrooms.model.AnalysisRuleList Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cleanrooms Show documentation
Show all versions of cleanrooms Show documentation
The AWS Java SDK for Clean Rooms module holds the client classes that are used for
communicating with Clean Rooms.
/*
* 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.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.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 type of analysis rule that enables row-level analysis.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AnalysisRuleList implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> JOIN_COLUMNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("joinColumns")
.getter(getter(AnalysisRuleList::joinColumns))
.setter(setter(Builder::joinColumns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("joinColumns").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> ALLOWED_JOIN_OPERATORS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("allowedJoinOperators")
.getter(getter(AnalysisRuleList::allowedJoinOperatorsAsStrings))
.setter(setter(Builder::allowedJoinOperatorsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("allowedJoinOperators").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> LIST_COLUMNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("listColumns")
.getter(getter(AnalysisRuleList::listColumns))
.setter(setter(Builder::listColumns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("listColumns").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 ADDITIONAL_ANALYSES_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("additionalAnalyses").getter(getter(AnalysisRuleList::additionalAnalysesAsString))
.setter(setter(Builder::additionalAnalyses))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("additionalAnalyses").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(JOIN_COLUMNS_FIELD,
ALLOWED_JOIN_OPERATORS_FIELD, LIST_COLUMNS_FIELD, ADDITIONAL_ANALYSES_FIELD));
private static final long serialVersionUID = 1L;
private final List joinColumns;
private final List allowedJoinOperators;
private final List listColumns;
private final String additionalAnalyses;
private AnalysisRuleList(BuilderImpl builder) {
this.joinColumns = builder.joinColumns;
this.allowedJoinOperators = builder.allowedJoinOperators;
this.listColumns = builder.listColumns;
this.additionalAnalyses = builder.additionalAnalyses;
}
/**
* For responses, this returns true if the service returned a value for the JoinColumns 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 hasJoinColumns() {
return joinColumns != null && !(joinColumns instanceof SdkAutoConstructList);
}
/**
*
* Columns that can be used to join a configured table with the table of the member who can query and other members'
* configured tables.
*
*
* 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 #hasJoinColumns} method.
*
*
* @return Columns that can be used to join a configured table with the table of the member who can query and other
* members' configured tables.
*/
public final List joinColumns() {
return joinColumns;
}
/**
*
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
*
*
* 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 #hasAllowedJoinOperators} method.
*
*
* @return The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
*/
public final List allowedJoinOperators() {
return JoinOperatorsListCopier.copyStringToEnum(allowedJoinOperators);
}
/**
* For responses, this returns true if the service returned a value for the AllowedJoinOperators 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 hasAllowedJoinOperators() {
return allowedJoinOperators != null && !(allowedJoinOperators instanceof SdkAutoConstructList);
}
/**
*
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
*
*
* 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 #hasAllowedJoinOperators} method.
*
*
* @return The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
*/
public final List allowedJoinOperatorsAsStrings() {
return allowedJoinOperators;
}
/**
* For responses, this returns true if the service returned a value for the ListColumns 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 hasListColumns() {
return listColumns != null && !(listColumns instanceof SdkAutoConstructList);
}
/**
*
* Columns that can be listed in the output.
*
*
* 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 #hasListColumns} method.
*
*
* @return Columns that can be listed in the output.
*/
public final List listColumns() {
return listColumns;
}
/**
*
* An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the
* direct query.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #additionalAnalyses} will return {@link AdditionalAnalyses#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #additionalAnalysesAsString}.
*
*
* @return An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of
* the direct query.
* @see AdditionalAnalyses
*/
public final AdditionalAnalyses additionalAnalyses() {
return AdditionalAnalyses.fromValue(additionalAnalyses);
}
/**
*
* An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the
* direct query.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #additionalAnalyses} will return {@link AdditionalAnalyses#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #additionalAnalysesAsString}.
*
*
* @return An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of
* the direct query.
* @see AdditionalAnalyses
*/
public final String additionalAnalysesAsString() {
return additionalAnalyses;
}
@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(hasJoinColumns() ? joinColumns() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAllowedJoinOperators() ? allowedJoinOperatorsAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasListColumns() ? listColumns() : null);
hashCode = 31 * hashCode + Objects.hashCode(additionalAnalysesAsString());
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 AnalysisRuleList)) {
return false;
}
AnalysisRuleList other = (AnalysisRuleList) obj;
return hasJoinColumns() == other.hasJoinColumns() && Objects.equals(joinColumns(), other.joinColumns())
&& hasAllowedJoinOperators() == other.hasAllowedJoinOperators()
&& Objects.equals(allowedJoinOperatorsAsStrings(), other.allowedJoinOperatorsAsStrings())
&& hasListColumns() == other.hasListColumns() && Objects.equals(listColumns(), other.listColumns())
&& Objects.equals(additionalAnalysesAsString(), other.additionalAnalysesAsString());
}
/**
* 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("AnalysisRuleList").add("JoinColumns", hasJoinColumns() ? joinColumns() : null)
.add("AllowedJoinOperators", hasAllowedJoinOperators() ? allowedJoinOperatorsAsStrings() : null)
.add("ListColumns", hasListColumns() ? listColumns() : null)
.add("AdditionalAnalyses", additionalAnalysesAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "joinColumns":
return Optional.ofNullable(clazz.cast(joinColumns()));
case "allowedJoinOperators":
return Optional.ofNullable(clazz.cast(allowedJoinOperatorsAsStrings()));
case "listColumns":
return Optional.ofNullable(clazz.cast(listColumns()));
case "additionalAnalyses":
return Optional.ofNullable(clazz.cast(additionalAnalysesAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AnalysisRuleList) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Columns that can be used to join a configured table with the table of the member who can query and other
* members' configured tables.
*
*
* @param joinColumns
* Columns that can be used to join a configured table with the table of the member who can query and
* other members' configured tables.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder joinColumns(Collection joinColumns);
/**
*
* Columns that can be used to join a configured table with the table of the member who can query and other
* members' configured tables.
*
*
* @param joinColumns
* Columns that can be used to join a configured table with the table of the member who can query and
* other members' configured tables.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder joinColumns(String... joinColumns);
/**
*
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
*
*
* @param allowedJoinOperators
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedJoinOperatorsWithStrings(Collection allowedJoinOperators);
/**
*
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
*
*
* @param allowedJoinOperators
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedJoinOperatorsWithStrings(String... allowedJoinOperators);
/**
*
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
*
*
* @param allowedJoinOperators
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedJoinOperators(Collection allowedJoinOperators);
/**
*
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
*
*
* @param allowedJoinOperators
* The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is
* AND.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedJoinOperators(JoinOperator... allowedJoinOperators);
/**
*
* Columns that can be listed in the output.
*
*
* @param listColumns
* Columns that can be listed in the output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder listColumns(Collection listColumns);
/**
*
* Columns that can be listed in the output.
*
*
* @param listColumns
* Columns that can be listed in the output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder listColumns(String... listColumns);
/**
*
* An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the
* direct query.
*
*
* @param additionalAnalyses
* An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output
* of the direct query.
* @see AdditionalAnalyses
* @return Returns a reference to this object so that method calls can be chained together.
* @see AdditionalAnalyses
*/
Builder additionalAnalyses(String additionalAnalyses);
/**
*
* An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the
* direct query.
*
*
* @param additionalAnalyses
* An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output
* of the direct query.
* @see AdditionalAnalyses
* @return Returns a reference to this object so that method calls can be chained together.
* @see AdditionalAnalyses
*/
Builder additionalAnalyses(AdditionalAnalyses additionalAnalyses);
}
static final class BuilderImpl implements Builder {
private List joinColumns = DefaultSdkAutoConstructList.getInstance();
private List allowedJoinOperators = DefaultSdkAutoConstructList.getInstance();
private List listColumns = DefaultSdkAutoConstructList.getInstance();
private String additionalAnalyses;
private BuilderImpl() {
}
private BuilderImpl(AnalysisRuleList model) {
joinColumns(model.joinColumns);
allowedJoinOperatorsWithStrings(model.allowedJoinOperators);
listColumns(model.listColumns);
additionalAnalyses(model.additionalAnalyses);
}
public final Collection getJoinColumns() {
if (joinColumns instanceof SdkAutoConstructList) {
return null;
}
return joinColumns;
}
public final void setJoinColumns(Collection joinColumns) {
this.joinColumns = AnalysisRuleListJoinColumnsListCopier.copy(joinColumns);
}
@Override
public final Builder joinColumns(Collection joinColumns) {
this.joinColumns = AnalysisRuleListJoinColumnsListCopier.copy(joinColumns);
return this;
}
@Override
@SafeVarargs
public final Builder joinColumns(String... joinColumns) {
joinColumns(Arrays.asList(joinColumns));
return this;
}
public final Collection getAllowedJoinOperators() {
if (allowedJoinOperators instanceof SdkAutoConstructList) {
return null;
}
return allowedJoinOperators;
}
public final void setAllowedJoinOperators(Collection allowedJoinOperators) {
this.allowedJoinOperators = JoinOperatorsListCopier.copy(allowedJoinOperators);
}
@Override
public final Builder allowedJoinOperatorsWithStrings(Collection allowedJoinOperators) {
this.allowedJoinOperators = JoinOperatorsListCopier.copy(allowedJoinOperators);
return this;
}
@Override
@SafeVarargs
public final Builder allowedJoinOperatorsWithStrings(String... allowedJoinOperators) {
allowedJoinOperatorsWithStrings(Arrays.asList(allowedJoinOperators));
return this;
}
@Override
public final Builder allowedJoinOperators(Collection allowedJoinOperators) {
this.allowedJoinOperators = JoinOperatorsListCopier.copyEnumToString(allowedJoinOperators);
return this;
}
@Override
@SafeVarargs
public final Builder allowedJoinOperators(JoinOperator... allowedJoinOperators) {
allowedJoinOperators(Arrays.asList(allowedJoinOperators));
return this;
}
public final Collection getListColumns() {
if (listColumns instanceof SdkAutoConstructList) {
return null;
}
return listColumns;
}
public final void setListColumns(Collection listColumns) {
this.listColumns = AnalysisRuleColumnListCopier.copy(listColumns);
}
@Override
public final Builder listColumns(Collection listColumns) {
this.listColumns = AnalysisRuleColumnListCopier.copy(listColumns);
return this;
}
@Override
@SafeVarargs
public final Builder listColumns(String... listColumns) {
listColumns(Arrays.asList(listColumns));
return this;
}
public final String getAdditionalAnalyses() {
return additionalAnalyses;
}
public final void setAdditionalAnalyses(String additionalAnalyses) {
this.additionalAnalyses = additionalAnalyses;
}
@Override
public final Builder additionalAnalyses(String additionalAnalyses) {
this.additionalAnalyses = additionalAnalyses;
return this;
}
@Override
public final Builder additionalAnalyses(AdditionalAnalyses additionalAnalyses) {
this.additionalAnalyses(additionalAnalyses == null ? null : additionalAnalyses.toString());
return this;
}
@Override
public AnalysisRuleList build() {
return new AnalysisRuleList(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}