software.amazon.awssdk.services.elasticbeanstalk.model.ValidateConfigurationSettingsRequest Maven / Gradle / Ivy
Show all versions of elasticbeanstalk 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.elasticbeanstalk.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;
/**
*
* A list of validation messages for a specified configuration template.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ValidateConfigurationSettingsRequest extends ElasticBeanstalkRequest implements
ToCopyableBuilder {
private static final SdkField APPLICATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationName").getter(getter(ValidateConfigurationSettingsRequest::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(ValidateConfigurationSettingsRequest::templateName))
.setter(setter(Builder::templateName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateName").build()).build();
private static final SdkField ENVIRONMENT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EnvironmentName").getter(getter(ValidateConfigurationSettingsRequest::environmentName))
.setter(setter(Builder::environmentName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnvironmentName").build()).build();
private static final SdkField> OPTION_SETTINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OptionSettings")
.getter(getter(ValidateConfigurationSettingsRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(APPLICATION_NAME_FIELD,
TEMPLATE_NAME_FIELD, ENVIRONMENT_NAME_FIELD, OPTION_SETTINGS_FIELD));
private final String applicationName;
private final String templateName;
private final String environmentName;
private final List optionSettings;
private ValidateConfigurationSettingsRequest(BuilderImpl builder) {
super(builder);
this.applicationName = builder.applicationName;
this.templateName = builder.templateName;
this.environmentName = builder.environmentName;
this.optionSettings = builder.optionSettings;
}
/**
*
* The name of the application that the configuration template or environment belongs to.
*
*
* @return The name of the application that the configuration template or environment belongs to.
*/
public final String applicationName() {
return applicationName;
}
/**
*
* The name of the configuration template to validate the settings against.
*
*
* Condition: You cannot specify both this and an environment name.
*
*
* @return The name of the configuration template to validate the settings against.
*
* Condition: You cannot specify both this and an environment name.
*/
public final String templateName() {
return templateName;
}
/**
*
* The name of the environment to validate the settings against.
*
*
* Condition: You cannot specify both this and a configuration template name.
*
*
* @return The name of the environment to validate the settings against.
*
* Condition: You cannot specify both this and a configuration template name.
*/
public final String environmentName() {
return environmentName;
}
/**
* 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);
}
/**
*
* A list of the options and desired values to evaluate.
*
*
* 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 A list of the options and desired values to evaluate.
*/
public final List optionSettings() {
return optionSettings;
}
@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(applicationName());
hashCode = 31 * hashCode + Objects.hashCode(templateName());
hashCode = 31 * hashCode + Objects.hashCode(environmentName());
hashCode = 31 * hashCode + Objects.hashCode(hasOptionSettings() ? optionSettings() : 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 ValidateConfigurationSettingsRequest)) {
return false;
}
ValidateConfigurationSettingsRequest other = (ValidateConfigurationSettingsRequest) obj;
return Objects.equals(applicationName(), other.applicationName()) && Objects.equals(templateName(), other.templateName())
&& Objects.equals(environmentName(), other.environmentName()) && hasOptionSettings() == other.hasOptionSettings()
&& Objects.equals(optionSettings(), other.optionSettings());
}
/**
* 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("ValidateConfigurationSettingsRequest").add("ApplicationName", applicationName())
.add("TemplateName", templateName()).add("EnvironmentName", environmentName())
.add("OptionSettings", hasOptionSettings() ? optionSettings() : 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 "EnvironmentName":
return Optional.ofNullable(clazz.cast(environmentName()));
case "OptionSettings":
return Optional.ofNullable(clazz.cast(optionSettings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ValidateConfigurationSettingsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElasticBeanstalkRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The name of the application that the configuration template or environment belongs to.
*
*
* @param applicationName
* The name of the application that the configuration template or environment belongs to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationName(String applicationName);
/**
*
* The name of the configuration template to validate the settings against.
*
*
* Condition: You cannot specify both this and an environment name.
*
*
* @param templateName
* The name of the configuration template to validate the settings against.
*
* Condition: You cannot specify both this and an environment name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateName(String templateName);
/**
*
* The name of the environment to validate the settings against.
*
*
* Condition: You cannot specify both this and a configuration template name.
*
*
* @param environmentName
* The name of the environment to validate the settings against.
*
* Condition: You cannot specify both this and a configuration template name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentName(String environmentName);
/**
*
* A list of the options and desired values to evaluate.
*
*
* @param optionSettings
* A list of the options and desired values to evaluate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder optionSettings(Collection optionSettings);
/**
*
* A list of the options and desired values to evaluate.
*
*
* @param optionSettings
* A list of the options and desired values to evaluate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder optionSettings(ConfigurationOptionSetting... optionSettings);
/**
*
* A list of the options and desired values to evaluate.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.elasticbeanstalk.model.ConfigurationOptionSetting.Builder} avoiding
* the need to create one manually via
* {@link software.amazon.awssdk.services.elasticbeanstalk.model.ConfigurationOptionSetting#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.elasticbeanstalk.model.ConfigurationOptionSetting.Builder#build()} is
* called immediately and its result is passed to {@link #optionSettings(List)}.
*
* @param optionSettings
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.elasticbeanstalk.model.ConfigurationOptionSetting.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #optionSettings(java.util.Collection)
*/
Builder optionSettings(Consumer... optionSettings);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ElasticBeanstalkRequest.BuilderImpl implements Builder {
private String applicationName;
private String templateName;
private String environmentName;
private List optionSettings = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ValidateConfigurationSettingsRequest model) {
super(model);
applicationName(model.applicationName);
templateName(model.templateName);
environmentName(model.environmentName);
optionSettings(model.optionSettings);
}
public final String getApplicationName() {
return applicationName;
}
public final void setApplicationName(String applicationName) {
this.applicationName = applicationName;
}
@Override
public final Builder applicationName(String applicationName) {
this.applicationName = applicationName;
return this;
}
public final String getTemplateName() {
return templateName;
}
public final void setTemplateName(String templateName) {
this.templateName = templateName;
}
@Override
public final Builder templateName(String templateName) {
this.templateName = templateName;
return this;
}
public final String getEnvironmentName() {
return environmentName;
}
public final void setEnvironmentName(String environmentName) {
this.environmentName = environmentName;
}
@Override
public final Builder environmentName(String environmentName) {
this.environmentName = environmentName;
return this;
}
public final List getOptionSettings() {
List result = ConfigurationOptionSettingsListCopier
.copyToBuilder(this.optionSettings);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOptionSettings(Collection optionSettings) {
this.optionSettings = ConfigurationOptionSettingsListCopier.copyFromBuilder(optionSettings);
}
@Override
public final Builder optionSettings(Collection optionSettings) {
this.optionSettings = ConfigurationOptionSettingsListCopier.copy(optionSettings);
return this;
}
@Override
@SafeVarargs
public final Builder optionSettings(ConfigurationOptionSetting... optionSettings) {
optionSettings(Arrays.asList(optionSettings));
return this;
}
@Override
@SafeVarargs
public final Builder optionSettings(Consumer... optionSettings) {
optionSettings(Stream.of(optionSettings).map(c -> ConfigurationOptionSetting.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 ValidateConfigurationSettingsRequest build() {
return new ValidateConfigurationSettingsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}