software.amazon.awssdk.services.proton.model.CreateServiceTemplateRequest Maven / Gradle / Ivy
/*
* 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.proton.model;
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 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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateServiceTemplateRequest extends ProtonRequest implements
ToCopyableBuilder {
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateServiceTemplateRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("displayName").getter(getter(CreateServiceTemplateRequest::displayName))
.setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("displayName").build()).build();
private static final SdkField ENCRYPTION_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("encryptionKey").getter(getter(CreateServiceTemplateRequest::encryptionKey))
.setter(setter(Builder::encryptionKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("encryptionKey").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(CreateServiceTemplateRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField PIPELINE_PROVISIONING_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("pipelineProvisioning").getter(getter(CreateServiceTemplateRequest::pipelineProvisioningAsString))
.setter(setter(Builder::pipelineProvisioning))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("pipelineProvisioning").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateServiceTemplateRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::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,
DISPLAY_NAME_FIELD, ENCRYPTION_KEY_FIELD, NAME_FIELD, PIPELINE_PROVISIONING_FIELD, TAGS_FIELD));
private final String description;
private final String displayName;
private final String encryptionKey;
private final String name;
private final String pipelineProvisioning;
private final List tags;
private CreateServiceTemplateRequest(BuilderImpl builder) {
super(builder);
this.description = builder.description;
this.displayName = builder.displayName;
this.encryptionKey = builder.encryptionKey;
this.name = builder.name;
this.pipelineProvisioning = builder.pipelineProvisioning;
this.tags = builder.tags;
}
/**
*
* A description of the service template.
*
*
* @return A description of the service template.
*/
public final String description() {
return description;
}
/**
*
* The name of the service template as displayed in the developer interface.
*
*
* @return The name of the service template as displayed in the developer interface.
*/
public final String displayName() {
return displayName;
}
/**
*
* A customer provided encryption key that's used to encrypt data.
*
*
* @return A customer provided encryption key that's used to encrypt data.
*/
public final String encryptionKey() {
return encryptionKey;
}
/**
*
* The name of the service template.
*
*
* @return The name of the service template.
*/
public final String name() {
return name;
}
/**
*
* By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates
* that an Proton service pipeline isn't provided for your service. After it's included, it can't be
* changed. For more information, see Template bundles in the Proton User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #pipelineProvisioning} will return {@link Provisioning#UNKNOWN_TO_SDK_VERSION}. The raw value returned by
* the service is available from {@link #pipelineProvisioningAsString}.
*
*
* @return By default, Proton provides a service pipeline for your service. When this parameter is included, it
* indicates that an Proton service pipeline isn't provided for your service. After it's included, it
* can't be changed. For more information, see Template bundles in the Proton User Guide.
* @see Provisioning
*/
public final Provisioning pipelineProvisioning() {
return Provisioning.fromValue(pipelineProvisioning);
}
/**
*
* By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates
* that an Proton service pipeline isn't provided for your service. After it's included, it can't be
* changed. For more information, see Template bundles in the Proton User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #pipelineProvisioning} will return {@link Provisioning#UNKNOWN_TO_SDK_VERSION}. The raw value returned by
* the service is available from {@link #pipelineProvisioningAsString}.
*
*
* @return By default, Proton provides a service pipeline for your service. When this parameter is included, it
* indicates that an Proton service pipeline isn't provided for your service. After it's included, it
* can't be changed. For more information, see Template bundles in the Proton User Guide.
* @see Provisioning
*/
public final String pipelineProvisioningAsString() {
return pipelineProvisioning;
}
/**
* 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 SdkAutoConstructList);
}
/**
*
* An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value
* pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
*
* 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 list of metadata items that you can associate with the Proton service template. A tag is a
* key-value pair.
*
* For more information, see Proton resources and
* tagging in the Proton User Guide.
*/
public final List tags() {
return tags;
}
@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(displayName());
hashCode = 31 * hashCode + Objects.hashCode(encryptionKey());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(pipelineProvisioningAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 CreateServiceTemplateRequest)) {
return false;
}
CreateServiceTemplateRequest other = (CreateServiceTemplateRequest) obj;
return Objects.equals(description(), other.description()) && Objects.equals(displayName(), other.displayName())
&& Objects.equals(encryptionKey(), other.encryptionKey()) && Objects.equals(name(), other.name())
&& Objects.equals(pipelineProvisioningAsString(), other.pipelineProvisioningAsString())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("CreateServiceTemplateRequest")
.add("Description", description() == null ? null : "*** Sensitive Data Redacted ***")
.add("DisplayName", displayName() == null ? null : "*** Sensitive Data Redacted ***")
.add("EncryptionKey", encryptionKey()).add("Name", name())
.add("PipelineProvisioning", pipelineProvisioningAsString()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "displayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "encryptionKey":
return Optional.ofNullable(clazz.cast(encryptionKey()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "pipelineProvisioning":
return Optional.ofNullable(clazz.cast(pipelineProvisioningAsString()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateServiceTemplateRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ProtonRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A description of the service template.
*
*
* @param description
* A description of the service template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The name of the service template as displayed in the developer interface.
*
*
* @param displayName
* The name of the service template as displayed in the developer interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* A customer provided encryption key that's used to encrypt data.
*
*
* @param encryptionKey
* A customer provided encryption key that's used to encrypt data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionKey(String encryptionKey);
/**
*
* The name of the service template.
*
*
* @param name
* The name of the service template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* By default, Proton provides a service pipeline for your service. When this parameter is included, it
* indicates that an Proton service pipeline isn't provided for your service. After it's included, it
* can't be changed. For more information, see Template bundles in the Proton User Guide.
*
*
* @param pipelineProvisioning
* By default, Proton provides a service pipeline for your service. When this parameter is included, it
* indicates that an Proton service pipeline isn't provided for your service. After it's included,
* it can't be changed. For more information, see Template bundles in the Proton User Guide.
* @see Provisioning
* @return Returns a reference to this object so that method calls can be chained together.
* @see Provisioning
*/
Builder pipelineProvisioning(String pipelineProvisioning);
/**
*
* By default, Proton provides a service pipeline for your service. When this parameter is included, it
* indicates that an Proton service pipeline isn't provided for your service. After it's included, it
* can't be changed. For more information, see Template bundles in the Proton User Guide.
*
*
* @param pipelineProvisioning
* By default, Proton provides a service pipeline for your service. When this parameter is included, it
* indicates that an Proton service pipeline isn't provided for your service. After it's included,
* it can't be changed. For more information, see Template bundles in the Proton User Guide.
* @see Provisioning
* @return Returns a reference to this object so that method calls can be chained together.
* @see Provisioning
*/
Builder pipelineProvisioning(Provisioning pipelineProvisioning);
/**
*
* An optional list of metadata items that you can associate with the Proton service template. A tag is a
* key-value pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
*
* @param tags
* An optional list of metadata items that you can associate with the Proton service template. A tag is a
* key-value pair.
*
* For more information, see Proton resources and
* tagging in the Proton User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* An optional list of metadata items that you can associate with the Proton service template. A tag is a
* key-value pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
*
* @param tags
* An optional list of metadata items that you can associate with the Proton service template. A tag is a
* key-value pair.
*
* For more information, see Proton resources and
* tagging in the Proton User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* An optional list of metadata items that you can associate with the Proton service template. A tag is a
* key-value pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.proton.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.proton.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.proton.model.Tag.Builder#build()}
* is called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.proton.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ProtonRequest.BuilderImpl implements Builder {
private String description;
private String displayName;
private String encryptionKey;
private String name;
private String pipelineProvisioning;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateServiceTemplateRequest model) {
super(model);
description(model.description);
displayName(model.displayName);
encryptionKey(model.encryptionKey);
name(model.name);
pipelineProvisioning(model.pipelineProvisioning);
tags(model.tags);
}
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 getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final String getEncryptionKey() {
return encryptionKey;
}
public final void setEncryptionKey(String encryptionKey) {
this.encryptionKey = encryptionKey;
}
@Override
public final Builder encryptionKey(String encryptionKey) {
this.encryptionKey = encryptionKey;
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 getPipelineProvisioning() {
return pipelineProvisioning;
}
public final void setPipelineProvisioning(String pipelineProvisioning) {
this.pipelineProvisioning = pipelineProvisioning;
}
@Override
public final Builder pipelineProvisioning(String pipelineProvisioning) {
this.pipelineProvisioning = pipelineProvisioning;
return this;
}
@Override
public final Builder pipelineProvisioning(Provisioning pipelineProvisioning) {
this.pipelineProvisioning(pipelineProvisioning == null ? null : pipelineProvisioning.toString());
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.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 CreateServiceTemplateRequest build() {
return new CreateServiceTemplateRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}