software.amazon.awssdk.services.opsworks.model.EnvironmentVariable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opsworks Show documentation
Show all versions of opsworks Show documentation
The AWS Java SDK for AWS OpsWorks module holds the client classes that are used for communicating with
AWS OpsWorks Service
/*
* 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.opsworks.model;
import java.io.Serializable;
import java.util.Arrays;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents an app's environment variable.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EnvironmentVariable implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField KEY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Key")
.getter(getter(EnvironmentVariable::key)).setter(setter(Builder::key))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Key").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Value")
.getter(getter(EnvironmentVariable::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Value").build()).build();
private static final SdkField SECURE_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Secure").getter(getter(EnvironmentVariable::secure)).setter(setter(Builder::secure))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Secure").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_FIELD, VALUE_FIELD,
SECURE_FIELD));
private static final long serialVersionUID = 1L;
private final String key;
private final String value;
private final Boolean secure;
private EnvironmentVariable(BuilderImpl builder) {
this.key = builder.key;
this.value = builder.value;
this.secure = builder.secure;
}
/**
*
* (Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The
* name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or
* underscore.
*
*
* @return (Required) The environment variable's name, which can consist of up to 64 characters and must be
* specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must
* start with a letter or underscore.
*/
public final String key() {
return key;
}
/**
*
* (Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up
* to 256 characters, which must all be printable.
*
*
* @return (Optional) The environment variable's value, which can be left empty. If you specify a value, it can
* contain up to 256 characters, which must all be printable.
*/
public final String value() {
return value;
}
/**
*
* (Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an
* environment variable's value, set Secure to true. DescribeApps then
* returns *****FILTERED***** instead of the actual value. The default value for Secure is
* false.
*
*
* @return (Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an
* environment variable's value, set Secure to true. DescribeApps
* then returns *****FILTERED***** instead of the actual value. The default value for
* Secure is false.
*/
public final Boolean secure() {
return secure;
}
@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 + Objects.hashCode(key());
hashCode = 31 * hashCode + Objects.hashCode(value());
hashCode = 31 * hashCode + Objects.hashCode(secure());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EnvironmentVariable)) {
return false;
}
EnvironmentVariable other = (EnvironmentVariable) obj;
return Objects.equals(key(), other.key()) && Objects.equals(value(), other.value())
&& Objects.equals(secure(), other.secure());
}
/**
* 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("EnvironmentVariable").add("Key", key()).add("Value", value()).add("Secure", secure()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Key":
return Optional.ofNullable(clazz.cast(key()));
case "Value":
return Optional.ofNullable(clazz.cast(value()));
case "Secure":
return Optional.ofNullable(clazz.cast(secure()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EnvironmentVariable) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* (Required) The environment variable's name, which can consist of up to 64 characters and must be specified.
* The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a
* letter or underscore.
*
*
* @param key
* (Required) The environment variable's name, which can consist of up to 64 characters and must be
* specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it
* must start with a letter or underscore.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder key(String key);
/**
*
* (Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain
* up to 256 characters, which must all be printable.
*
*
* @param value
* (Optional) The environment variable's value, which can be left empty. If you specify a value, it can
* contain up to 256 characters, which must all be printable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(String value);
/**
*
* (Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an
* environment variable's value, set Secure to true. DescribeApps then
* returns *****FILTERED***** instead of the actual value. The default value for
* Secure is false.
*
*
* @param secure
* (Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal
* an environment variable's value, set Secure to true.
* DescribeApps then returns *****FILTERED***** instead of the actual value.
* The default value for Secure is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder secure(Boolean secure);
}
static final class BuilderImpl implements Builder {
private String key;
private String value;
private Boolean secure;
private BuilderImpl() {
}
private BuilderImpl(EnvironmentVariable model) {
key(model.key);
value(model.value);
secure(model.secure);
}
public final String getKey() {
return key;
}
@Override
public final Builder key(String key) {
this.key = key;
return this;
}
public final void setKey(String key) {
this.key = key;
}
public final String getValue() {
return value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
public final void setValue(String value) {
this.value = value;
}
public final Boolean getSecure() {
return secure;
}
@Override
public final Builder secure(Boolean secure) {
this.secure = secure;
return this;
}
public final void setSecure(Boolean secure) {
this.secure = secure;
}
@Override
public EnvironmentVariable build() {
return new EnvironmentVariable(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy