software.amazon.awssdk.services.cleanrooms.model.CreateAnalysisTemplateRequest Maven / Gradle / Ivy
Show all versions of cleanrooms 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.cleanrooms.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
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.awscore.AwsRequestOverrideConfiguration;
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.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateAnalysisTemplateRequest extends CleanRoomsRequest implements
ToCopyableBuilder {
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateAnalysisTemplateRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField MEMBERSHIP_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("membershipIdentifier").getter(getter(CreateAnalysisTemplateRequest::membershipIdentifier))
.setter(setter(Builder::membershipIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("membershipIdentifier").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(CreateAnalysisTemplateRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField FORMAT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("format")
.getter(getter(CreateAnalysisTemplateRequest::formatAsString)).setter(setter(Builder::format))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("format").build()).build();
private static final SdkField SOURCE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("source").getter(getter(CreateAnalysisTemplateRequest::source)).setter(setter(Builder::source))
.constructor(AnalysisSource::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("source").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(CreateAnalysisTemplateRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> ANALYSIS_PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("analysisParameters")
.getter(getter(CreateAnalysisTemplateRequest::analysisParameters))
.setter(setter(Builder::analysisParameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("analysisParameters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AnalysisParameter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESCRIPTION_FIELD,
MEMBERSHIP_IDENTIFIER_FIELD, NAME_FIELD, FORMAT_FIELD, SOURCE_FIELD, TAGS_FIELD, ANALYSIS_PARAMETERS_FIELD));
private final String description;
private final String membershipIdentifier;
private final String name;
private final String format;
private final AnalysisSource source;
private final Map tags;
private final List analysisParameters;
private CreateAnalysisTemplateRequest(BuilderImpl builder) {
super(builder);
this.description = builder.description;
this.membershipIdentifier = builder.membershipIdentifier;
this.name = builder.name;
this.format = builder.format;
this.source = builder.source;
this.tags = builder.tags;
this.analysisParameters = builder.analysisParameters;
}
/**
*
* The description of the analysis template.
*
*
* @return The description of the analysis template.
*/
public final String description() {
return description;
}
/**
*
* The identifier for a membership resource.
*
*
* @return The identifier for a membership resource.
*/
public final String membershipIdentifier() {
return membershipIdentifier;
}
/**
*
* The name of the analysis template.
*
*
* @return The name of the analysis template.
*/
public final String name() {
return name;
}
/**
*
* The format of the analysis template.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #format} will
* return {@link AnalysisFormat#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #formatAsString}.
*
*
* @return The format of the analysis template.
* @see AnalysisFormat
*/
public final AnalysisFormat format() {
return AnalysisFormat.fromValue(format);
}
/**
*
* The format of the analysis template.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #format} will
* return {@link AnalysisFormat#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #formatAsString}.
*
*
* @return The format of the analysis template.
* @see AnalysisFormat
*/
public final String formatAsString() {
return format;
}
/**
*
* The information in the analysis template. Currently supports text, the query text for the analysis
* template.
*
*
* @return The information in the analysis template. Currently supports text, the query text for the
* analysis template.
*/
public final AnalysisSource source() {
return source;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* An optional label that you can assign to a resource when you create it. Each tag consists of a key and an
* optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM
* policies to control access to this resource.
*
*
* 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 #hasTags} method.
*
*
* @return An optional label that you can assign to a resource when you create it. Each tag consists of a key and an
* optional value, both of which you define. When you use tagging, you can also use tag-based access control
* in IAM policies to control access to this resource.
*/
public final Map tags() {
return tags;
}
/**
* For responses, this returns true if the service returned a value for the AnalysisParameters 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 hasAnalysisParameters() {
return analysisParameters != null && !(analysisParameters instanceof SdkAutoConstructList);
}
/**
*
* The parameters of the analysis template.
*
*
* 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 #hasAnalysisParameters} method.
*
*
* @return The parameters of the analysis template.
*/
public final List analysisParameters() {
return analysisParameters;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(membershipIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(formatAsString());
hashCode = 31 * hashCode + Objects.hashCode(source());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAnalysisParameters() ? analysisParameters() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateAnalysisTemplateRequest)) {
return false;
}
CreateAnalysisTemplateRequest other = (CreateAnalysisTemplateRequest) obj;
return Objects.equals(description(), other.description())
&& Objects.equals(membershipIdentifier(), other.membershipIdentifier()) && Objects.equals(name(), other.name())
&& Objects.equals(formatAsString(), other.formatAsString()) && Objects.equals(source(), other.source())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& hasAnalysisParameters() == other.hasAnalysisParameters()
&& Objects.equals(analysisParameters(), other.analysisParameters());
}
/**
* 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("CreateAnalysisTemplateRequest").add("Description", description())
.add("MembershipIdentifier", membershipIdentifier()).add("Name", name()).add("Format", formatAsString())
.add("Source", source() == null ? null : "*** Sensitive Data Redacted ***")
.add("Tags", hasTags() ? tags() : null)
.add("AnalysisParameters", analysisParameters() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "membershipIdentifier":
return Optional.ofNullable(clazz.cast(membershipIdentifier()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "format":
return Optional.ofNullable(clazz.cast(formatAsString()));
case "source":
return Optional.ofNullable(clazz.cast(source()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "analysisParameters":
return Optional.ofNullable(clazz.cast(analysisParameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateAnalysisTemplateRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CleanRoomsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The description of the analysis template.
*
*
* @param description
* The description of the analysis template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The identifier for a membership resource.
*
*
* @param membershipIdentifier
* The identifier for a membership resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder membershipIdentifier(String membershipIdentifier);
/**
*
* The name of the analysis template.
*
*
* @param name
* The name of the analysis template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The format of the analysis template.
*
*
* @param format
* The format of the analysis template.
* @see AnalysisFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see AnalysisFormat
*/
Builder format(String format);
/**
*
* The format of the analysis template.
*
*
* @param format
* The format of the analysis template.
* @see AnalysisFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see AnalysisFormat
*/
Builder format(AnalysisFormat format);
/**
*
* The information in the analysis template. Currently supports text, the query text for the
* analysis template.
*
*
* @param source
* The information in the analysis template. Currently supports text, the query text for the
* analysis template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder source(AnalysisSource source);
/**
*
* The information in the analysis template. Currently supports text, the query text for the
* analysis template.
*
* This is a convenience method that creates an instance of the {@link AnalysisSource.Builder} avoiding the need
* to create one manually via {@link AnalysisSource#builder()}.
*
*
* When the {@link Consumer} completes, {@link AnalysisSource.Builder#build()} is called immediately and its
* result is passed to {@link #source(AnalysisSource)}.
*
* @param source
* a consumer that will call methods on {@link AnalysisSource.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #source(AnalysisSource)
*/
default Builder source(Consumer source) {
return source(AnalysisSource.builder().applyMutation(source).build());
}
/**
*
* An optional label that you can assign to a resource when you create it. Each tag consists of a key and an
* optional value, both of which you define. When you use tagging, you can also use tag-based access control in
* IAM policies to control access to this resource.
*
*
* @param tags
* An optional label that you can assign to a resource when you create it. Each tag consists of a key and
* an optional value, both of which you define. When you use tagging, you can also use tag-based access
* control in IAM policies to control access to this resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The parameters of the analysis template.
*
*
* @param analysisParameters
* The parameters of the analysis template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder analysisParameters(Collection analysisParameters);
/**
*
* The parameters of the analysis template.
*
*
* @param analysisParameters
* The parameters of the analysis template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder analysisParameters(AnalysisParameter... analysisParameters);
/**
*
* The parameters of the analysis template.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cleanrooms.model.AnalysisParameter.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.cleanrooms.model.AnalysisParameter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cleanrooms.model.AnalysisParameter.Builder#build()} is called
* immediately and its result is passed to {@link #analysisParameters(List)}.
*
* @param analysisParameters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cleanrooms.model.AnalysisParameter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #analysisParameters(java.util.Collection)
*/
Builder analysisParameters(Consumer... analysisParameters);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CleanRoomsRequest.BuilderImpl implements Builder {
private String description;
private String membershipIdentifier;
private String name;
private String format;
private AnalysisSource source;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private List analysisParameters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateAnalysisTemplateRequest model) {
super(model);
description(model.description);
membershipIdentifier(model.membershipIdentifier);
name(model.name);
format(model.format);
source(model.source);
tags(model.tags);
analysisParameters(model.analysisParameters);
}
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 String getMembershipIdentifier() {
return membershipIdentifier;
}
public final void setMembershipIdentifier(String membershipIdentifier) {
this.membershipIdentifier = membershipIdentifier;
}
@Override
public final Builder membershipIdentifier(String membershipIdentifier) {
this.membershipIdentifier = membershipIdentifier;
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 getFormat() {
return format;
}
public final void setFormat(String format) {
this.format = format;
}
@Override
public final Builder format(String format) {
this.format = format;
return this;
}
@Override
public final Builder format(AnalysisFormat format) {
this.format(format == null ? null : format.toString());
return this;
}
public final AnalysisSource.Builder getSource() {
return source != null ? source.toBuilder() : null;
}
public final void setSource(AnalysisSource.BuilderImpl source) {
this.source = source != null ? source.build() : null;
}
@Override
public final Builder source(AnalysisSource source) {
this.source = source;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
public final List getAnalysisParameters() {
List result = AnalysisParameterListCopier.copyToBuilder(this.analysisParameters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAnalysisParameters(Collection analysisParameters) {
this.analysisParameters = AnalysisParameterListCopier.copyFromBuilder(analysisParameters);
}
@Override
public final Builder analysisParameters(Collection analysisParameters) {
this.analysisParameters = AnalysisParameterListCopier.copy(analysisParameters);
return this;
}
@Override
@SafeVarargs
public final Builder analysisParameters(AnalysisParameter... analysisParameters) {
analysisParameters(Arrays.asList(analysisParameters));
return this;
}
@Override
@SafeVarargs
public final Builder analysisParameters(Consumer... analysisParameters) {
analysisParameters(Stream.of(analysisParameters).map(c -> AnalysisParameter.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateAnalysisTemplateRequest build() {
return new CreateAnalysisTemplateRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}