software.amazon.awssdk.services.codebuild.model.EnvironmentVariable Maven / Gradle / Ivy
Show all versions of codebuild 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.codebuild.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;
/**
*
* Information about an environment variable for a build project or a build.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EnvironmentVariable implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(EnvironmentVariable::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").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 TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(EnvironmentVariable::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, VALUE_FIELD,
TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String value;
private final String type;
private EnvironmentVariable(BuilderImpl builder) {
this.name = builder.name;
this.value = builder.value;
this.type = builder.type;
}
/**
*
* The name or key of the environment variable.
*
*
* @return The name or key of the environment variable.
*/
public final String name() {
return name;
}
/**
*
* The value of the environment variable.
*
*
*
* We strongly discourage the use of PLAINTEXT environment variables to store sensitive values,
* especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in
* plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment
* variable of type PARAMETER_STORE or SECRETS_MANAGER.
*
*
*
* @return The value of the environment variable.
*
* We strongly discourage the use of PLAINTEXT environment variables to store sensitive values,
* especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be
* displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you
* use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
*
*/
public final String value() {
return value;
}
/**
*
* The type of environment variable. Valid values include:
*
*
* -
*
* PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment
* variables of this type, specify the name of the parameter as the value of the EnvironmentVariable.
* The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment
* variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
*
*
* -
*
* PLAINTEXT: An environment variable in plain text format. This is the default value.
*
*
* -
*
* SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of
* this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value
* will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the
* buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link EnvironmentVariableType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of environment variable. Valid values include:
*
* -
*
* PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For
* environment variables of this type, specify the name of the parameter as the value of the
* EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define
* Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
*
*
* -
*
* PLAINTEXT: An environment variable in plain text format. This is the default value.
*
*
* -
*
* SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment
* variables of this type, specify the name of the secret as the value of the
* EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define
* Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
*
*
* @see EnvironmentVariableType
*/
public final EnvironmentVariableType type() {
return EnvironmentVariableType.fromValue(type);
}
/**
*
* The type of environment variable. Valid values include:
*
*
* -
*
* PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment
* variables of this type, specify the name of the parameter as the value of the EnvironmentVariable.
* The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment
* variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
*
*
* -
*
* PLAINTEXT: An environment variable in plain text format. This is the default value.
*
*
* -
*
* SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of
* this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value
* will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the
* buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link EnvironmentVariableType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of environment variable. Valid values include:
*
* -
*
* PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For
* environment variables of this type, specify the name of the parameter as the value of the
* EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define
* Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
*
*
* -
*
* PLAINTEXT: An environment variable in plain text format. This is the default value.
*
*
* -
*
* SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment
* variables of this type, specify the name of the secret as the value of the
* EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define
* Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
*
*
* @see EnvironmentVariableType
*/
public final String typeAsString() {
return type;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(value());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
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(name(), other.name()) && Objects.equals(value(), other.value())
&& Objects.equals(typeAsString(), other.typeAsString());
}
/**
* 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("Name", name()).add("Value", value()).add("Type", typeAsString())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "value":
return Optional.ofNullable(clazz.cast(value()));
case "type":
return Optional.ofNullable(clazz.cast(typeAsString()));
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 {
/**
*
* The name or key of the environment variable.
*
*
* @param name
* The name or key of the environment variable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The value of the environment variable.
*
*
*
* We strongly discourage the use of PLAINTEXT environment variables to store sensitive values,
* especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed
* in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an
* environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
*
*
*
* @param value
* The value of the environment variable.
*
* We strongly discourage the use of PLAINTEXT environment variables to store sensitive
* values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables
* can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we
* recommend you use an environment variable of type PARAMETER_STORE or
* SECRETS_MANAGER.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(String value);
/**
*
* The type of environment variable. Valid values include:
*
*
* -
*
* PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For
* environment variables of this type, specify the name of the parameter as the value of the
* EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define
* Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
*
*
* -
*
* PLAINTEXT: An environment variable in plain text format. This is the default value.
*
*
* -
*
* SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of
* this type, specify the name of the secret as the value of the EnvironmentVariable. The secret
* value will be substituted for the name at runtime. You can also define Secrets Manager environment variables
* in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
*
*
*
*
* @param type
* The type of environment variable. Valid values include:
*
* -
*
* PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For
* environment variables of this type, specify the name of the parameter as the value of the
* EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also
* define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
*
*
* -
*
* PLAINTEXT: An environment variable in plain text format. This is the default value.
*
*
* -
*
* SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment
* variables of this type, specify the name of the secret as the value of the
* EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define
* Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
*
*
* @see EnvironmentVariableType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentVariableType
*/
Builder type(String type);
/**
*
* The type of environment variable. Valid values include:
*
*
* -
*
* PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For
* environment variables of this type, specify the name of the parameter as the value of the
* EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define
* Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
*
*
* -
*
* PLAINTEXT: An environment variable in plain text format. This is the default value.
*
*
* -
*
* SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of
* this type, specify the name of the secret as the value of the EnvironmentVariable. The secret
* value will be substituted for the name at runtime. You can also define Secrets Manager environment variables
* in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
*
*
*
*
* @param type
* The type of environment variable. Valid values include:
*
* -
*
* PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For
* environment variables of this type, specify the name of the parameter as the value of the
* EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also
* define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
*
*
* -
*
* PLAINTEXT: An environment variable in plain text format. This is the default value.
*
*
* -
*
* SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment
* variables of this type, specify the name of the secret as the value of the
* EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define
* Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
*
*
* @see EnvironmentVariableType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentVariableType
*/
Builder type(EnvironmentVariableType type);
}
static final class BuilderImpl implements Builder {
private String name;
private String value;
private String type;
private BuilderImpl() {
}
private BuilderImpl(EnvironmentVariable model) {
name(model.name);
value(model.value);
type(model.type);
}
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 getValue() {
return value;
}
public final void setValue(String value) {
this.value = value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(EnvironmentVariableType type) {
this.type(type == null ? null : type.toString());
return this;
}
@Override
public EnvironmentVariable build() {
return new EnvironmentVariable(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}