software.amazon.awssdk.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest 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.elasticbeanstalk.model;
import java.beans.Transient;
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;
/**
*
* Request to create a configuration template.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateConfigurationTemplateRequest extends ElasticBeanstalkRequest implements
ToCopyableBuilder {
private static final SdkField APPLICATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationName").getter(getter(CreateConfigurationTemplateRequest::applicationName))
.setter(setter(Builder::applicationName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplicationName").build()).build();
private static final SdkField TEMPLATE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateName").getter(getter(CreateConfigurationTemplateRequest::templateName))
.setter(setter(Builder::templateName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateName").build()).build();
private static final SdkField SOLUTION_STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SolutionStackName").getter(getter(CreateConfigurationTemplateRequest::solutionStackName))
.setter(setter(Builder::solutionStackName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SolutionStackName").build()).build();
private static final SdkField PLATFORM_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PlatformArn").getter(getter(CreateConfigurationTemplateRequest::platformArn))
.setter(setter(Builder::platformArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PlatformArn").build()).build();
private static final SdkField SOURCE_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SourceConfiguration")
.getter(getter(CreateConfigurationTemplateRequest::sourceConfiguration)).setter(setter(Builder::sourceConfiguration))
.constructor(SourceConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceConfiguration").build())
.build();
private static final SdkField ENVIRONMENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EnvironmentId").getter(getter(CreateConfigurationTemplateRequest::environmentId))
.setter(setter(Builder::environmentId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnvironmentId").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateConfigurationTemplateRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> OPTION_SETTINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OptionSettings")
.getter(getter(CreateConfigurationTemplateRequest::optionSettings))
.setter(setter(Builder::optionSettings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OptionSettings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ConfigurationOptionSetting::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateConfigurationTemplateRequest::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(APPLICATION_NAME_FIELD,
TEMPLATE_NAME_FIELD, SOLUTION_STACK_NAME_FIELD, PLATFORM_ARN_FIELD, SOURCE_CONFIGURATION_FIELD, ENVIRONMENT_ID_FIELD,
DESCRIPTION_FIELD, OPTION_SETTINGS_FIELD, TAGS_FIELD));
private final String applicationName;
private final String templateName;
private final String solutionStackName;
private final String platformArn;
private final SourceConfiguration sourceConfiguration;
private final String environmentId;
private final String description;
private final List optionSettings;
private final List tags;
private CreateConfigurationTemplateRequest(BuilderImpl builder) {
super(builder);
this.applicationName = builder.applicationName;
this.templateName = builder.templateName;
this.solutionStackName = builder.solutionStackName;
this.platformArn = builder.platformArn;
this.sourceConfiguration = builder.sourceConfiguration;
this.environmentId = builder.environmentId;
this.description = builder.description;
this.optionSettings = builder.optionSettings;
this.tags = builder.tags;
}
/**
*
* The name of the Elastic Beanstalk application to associate with this configuration template.
*
*
* @return The name of the Elastic Beanstalk application to associate with this configuration template.
*/
public final String applicationName() {
return applicationName;
}
/**
*
* The name of the configuration template.
*
*
* Constraint: This name must be unique per application.
*
*
* @return The name of the configuration template.
*
* Constraint: This name must be unique per application.
*/
public final String templateName() {
return templateName;
}
/**
*
* The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example,
* 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7
. A solution stack specifies the operating system,
* runtime, and application server for a configuration template. It also determines the set of configuration options
* as well as the possible and default values. For more information, see Supported Platforms in
* the AWS Elastic Beanstalk Developer Guide.
*
*
* You must specify SolutionStackName
if you don't specify PlatformArn
,
* EnvironmentId
, or SourceConfiguration
.
*
*
* Use the
* ListAvailableSolutionStacks
API to obtain a list of available solution stacks.
*
*
* @return The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For
* example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7
. A solution stack specifies the
* operating system, runtime, and application server for a configuration template. It also determines the
* set of configuration options as well as the possible and default values. For more information, see Supported
* Platforms in the AWS Elastic Beanstalk Developer Guide.
*
* You must specify SolutionStackName
if you don't specify PlatformArn
,
* EnvironmentId
, or SourceConfiguration
.
*
*
* Use the
* ListAvailableSolutionStacks
API to obtain a list of available solution stacks.
*/
public final String solutionStackName() {
return solutionStackName;
}
/**
*
* The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the
* AWS Elastic Beanstalk Developer Guide.
*
*
*
* If you specify PlatformArn
, then don't specify SolutionStackName
.
*
*
*
* @return The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms
* in the AWS Elastic Beanstalk Developer Guide.
*
* If you specify PlatformArn
, then don't specify SolutionStackName
.
*
*/
public final String platformArn() {
return platformArn;
}
/**
*
* An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the
* configuration values from the specified configuration template to create a new configuration.
*
*
* Values specified in OptionSettings
override any values obtained from the
* SourceConfiguration
.
*
*
* You must specify SourceConfiguration
if you don't specify PlatformArn
,
* EnvironmentId
, or SolutionStackName
.
*
*
* Constraint: If both solution stack name and source configuration are specified, the solution stack of the source
* configuration template must match the specified solution stack name.
*
*
* @return An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the
* configuration values from the specified configuration template to create a new configuration.
*
* Values specified in OptionSettings
override any values obtained from the
* SourceConfiguration
.
*
*
* You must specify SourceConfiguration
if you don't specify PlatformArn
,
* EnvironmentId
, or SolutionStackName
.
*
*
* Constraint: If both solution stack name and source configuration are specified, the solution stack of the
* source configuration template must match the specified solution stack name.
*/
public final SourceConfiguration sourceConfiguration() {
return sourceConfiguration;
}
/**
*
* The ID of an environment whose settings you want to use to create the configuration template. You must specify
* EnvironmentId
if you don't specify PlatformArn
, SolutionStackName
, or
* SourceConfiguration
.
*
*
* @return The ID of an environment whose settings you want to use to create the configuration template. You must
* specify EnvironmentId
if you don't specify PlatformArn
,
* SolutionStackName
, or SourceConfiguration
.
*/
public final String environmentId() {
return environmentId;
}
/**
*
* An optional description for this configuration.
*
*
* @return An optional description for this configuration.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the OptionSettings 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 hasOptionSettings() {
return optionSettings != null && !(optionSettings instanceof SdkAutoConstructList);
}
/**
*
* Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values
* override the values obtained from the solution stack or the source configuration template. For a complete list of
* Elastic Beanstalk configuration options, see Option Values in the
* AWS Elastic Beanstalk Developer 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 #hasOptionSettings} method.
*
*
* @return Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these
* values override the values obtained from the solution stack or the source configuration template. For a
* complete list of Elastic Beanstalk configuration options, see Option Values in
* the AWS Elastic Beanstalk Developer Guide.
*/
public final List optionSettings() {
return optionSettings;
}
/**
* 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);
}
/**
*
* Specifies the tags applied to the configuration 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 #hasTags} method.
*
*
* @return Specifies the tags applied to the configuration template.
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(applicationName());
hashCode = 31 * hashCode + Objects.hashCode(templateName());
hashCode = 31 * hashCode + Objects.hashCode(solutionStackName());
hashCode = 31 * hashCode + Objects.hashCode(platformArn());
hashCode = 31 * hashCode + Objects.hashCode(sourceConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(environmentId());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasOptionSettings() ? optionSettings() : null);
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 CreateConfigurationTemplateRequest)) {
return false;
}
CreateConfigurationTemplateRequest other = (CreateConfigurationTemplateRequest) obj;
return Objects.equals(applicationName(), other.applicationName()) && Objects.equals(templateName(), other.templateName())
&& Objects.equals(solutionStackName(), other.solutionStackName())
&& Objects.equals(platformArn(), other.platformArn())
&& Objects.equals(sourceConfiguration(), other.sourceConfiguration())
&& Objects.equals(environmentId(), other.environmentId()) && Objects.equals(description(), other.description())
&& hasOptionSettings() == other.hasOptionSettings() && Objects.equals(optionSettings(), other.optionSettings())
&& 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("CreateConfigurationTemplateRequest").add("ApplicationName", applicationName())
.add("TemplateName", templateName()).add("SolutionStackName", solutionStackName())
.add("PlatformArn", platformArn()).add("SourceConfiguration", sourceConfiguration())
.add("EnvironmentId", environmentId()).add("Description", description())
.add("OptionSettings", hasOptionSettings() ? optionSettings() : null).add("Tags", hasTags() ? tags() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ApplicationName":
return Optional.ofNullable(clazz.cast(applicationName()));
case "TemplateName":
return Optional.ofNullable(clazz.cast(templateName()));
case "SolutionStackName":
return Optional.ofNullable(clazz.cast(solutionStackName()));
case "PlatformArn":
return Optional.ofNullable(clazz.cast(platformArn()));
case "SourceConfiguration":
return Optional.ofNullable(clazz.cast(sourceConfiguration()));
case "EnvironmentId":
return Optional.ofNullable(clazz.cast(environmentId()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "OptionSettings":
return Optional.ofNullable(clazz.cast(optionSettings()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function