software.amazon.awssdk.services.m2.model.CreateApplicationRequest Maven / Gradle / Ivy
Show all versions of m2 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.m2.model;
import java.util.Arrays;
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 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.DefaultValueTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
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 CreateApplicationRequest extends M2Request implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreateApplicationRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField DEFINITION_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("definition").getter(getter(CreateApplicationRequest::definition)).setter(setter(Builder::definition))
.constructor(Definition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("definition").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateApplicationRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField ENGINE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("engineType").getter(getter(CreateApplicationRequest::engineTypeAsString))
.setter(setter(Builder::engineType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("engineType").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(CreateApplicationRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(CreateApplicationRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
DEFINITION_FIELD, DESCRIPTION_FIELD, ENGINE_TYPE_FIELD, NAME_FIELD, TAGS_FIELD));
private final String clientToken;
private final Definition definition;
private final String description;
private final String engineType;
private final String name;
private final Map tags;
private CreateApplicationRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.definition = builder.definition;
this.description = builder.description;
this.engineType = builder.engineType;
this.name = builder.name;
this.tags = builder.tags;
}
/**
*
* Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an
* application. The service generates the clientToken when the API call is triggered. The token expires after one
* hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response.
* The service also handles deleting the clientToken after it expires.
*
*
* @return Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to
* create an application. The service generates the clientToken when the API call is triggered. The token
* expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will
* get the same response. The service also handles deleting the clientToken after it expires.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* The application definition for this application. You can specify either inline JSON or an S3 bucket location.
*
*
* @return The application definition for this application. You can specify either inline JSON or an S3 bucket
* location.
*/
public final Definition definition() {
return definition;
}
/**
*
* The description of the application.
*
*
* @return The description of the application.
*/
public final String description() {
return description;
}
/**
*
* The type of the target platform for this application.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #engineType} will
* return {@link EngineType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #engineTypeAsString}.
*
*
* @return The type of the target platform for this application.
* @see EngineType
*/
public final EngineType engineType() {
return EngineType.fromValue(engineType);
}
/**
*
* The type of the target platform for this application.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #engineType} will
* return {@link EngineType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #engineTypeAsString}.
*
*
* @return The type of the target platform for this application.
* @see EngineType
*/
public final String engineTypeAsString() {
return engineType;
}
/**
*
* The unique identifier of the application.
*
*
* @return The unique identifier of the application.
*/
public final String name() {
return name;
}
/**
* 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);
}
/**
*
* A list of tags to apply to the application.
*
*
* 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 A list of tags to apply to the application.
*/
public final Map 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(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(definition());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(engineTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(name());
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 CreateApplicationRequest)) {
return false;
}
CreateApplicationRequest other = (CreateApplicationRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(definition(), other.definition())
&& Objects.equals(description(), other.description())
&& Objects.equals(engineTypeAsString(), other.engineTypeAsString()) && Objects.equals(name(), other.name())
&& 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("CreateApplicationRequest").add("ClientToken", clientToken()).add("Definition", definition())
.add("Description", description()).add("EngineType", engineTypeAsString()).add("Name", name())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "definition":
return Optional.ofNullable(clazz.cast(definition()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "engineType":
return Optional.ofNullable(clazz.cast(engineTypeAsString()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
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((CreateApplicationRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends M2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an
* application. The service generates the clientToken when the API call is triggered. The token expires after
* one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same
* response. The service also handles deleting the clientToken after it expires.
*
*
* @param clientToken
* Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to
* create an application. The service generates the clientToken when the API call is triggered. The token
* expires after one hour, so if you retry the API within this timeframe with the same clientToken, you
* will get the same response. The service also handles deleting the clientToken after it expires.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* The application definition for this application. You can specify either inline JSON or an S3 bucket location.
*
*
* @param definition
* The application definition for this application. You can specify either inline JSON or an S3 bucket
* location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder definition(Definition definition);
/**
*
* The application definition for this application. You can specify either inline JSON or an S3 bucket location.
*
* This is a convenience method that creates an instance of the {@link Definition.Builder} avoiding the need to
* create one manually via {@link Definition#builder()}.
*
*
* When the {@link Consumer} completes, {@link Definition.Builder#build()} is called immediately and its result
* is passed to {@link #definition(Definition)}.
*
* @param definition
* a consumer that will call methods on {@link Definition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #definition(Definition)
*/
default Builder definition(Consumer definition) {
return definition(Definition.builder().applyMutation(definition).build());
}
/**
*
* The description of the application.
*
*
* @param description
* The description of the application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The type of the target platform for this application.
*
*
* @param engineType
* The type of the target platform for this application.
* @see EngineType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EngineType
*/
Builder engineType(String engineType);
/**
*
* The type of the target platform for this application.
*
*
* @param engineType
* The type of the target platform for this application.
* @see EngineType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EngineType
*/
Builder engineType(EngineType engineType);
/**
*
* The unique identifier of the application.
*
*
* @param name
* The unique identifier of the application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* A list of tags to apply to the application.
*
*
* @param tags
* A list of tags to apply to the application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends M2Request.BuilderImpl implements Builder {
private String clientToken;
private Definition definition;
private String description;
private String engineType;
private String name;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateApplicationRequest model) {
super(model);
clientToken(model.clientToken);
definition(model.definition);
description(model.description);
engineType(model.engineType);
name(model.name);
tags(model.tags);
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final Definition.Builder getDefinition() {
return definition != null ? definition.toBuilder() : null;
}
public final void setDefinition(Definition.BuilderImpl definition) {
this.definition = definition != null ? definition.build() : null;
}
@Override
public final Builder definition(Definition definition) {
this.definition = definition;
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 String getEngineType() {
return engineType;
}
public final void setEngineType(String engineType) {
this.engineType = engineType;
}
@Override
public final Builder engineType(String engineType) {
this.engineType = engineType;
return this;
}
@Override
public final Builder engineType(EngineType engineType) {
this.engineType(engineType == null ? null : engineType.toString());
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 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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateApplicationRequest build() {
return new CreateApplicationRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}