software.amazon.awssdk.services.codebuild.model

Class EnvironmentVariable

java.lang.Object

software.amazon.awssdk.services.codebuild.model.EnvironmentVariable

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>

@Generated(value="software.amazon.awssdk:codegen")
public final class EnvironmentVariable
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>

Information about an environment variable for a build project or a build.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EnvironmentVariable.Builder

Method Summary

Modifier and Type	Method and Description
static EnvironmentVariable.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name or key of the environment variable.
List<SdkField<?>>	sdkFields()
static Class<? extends EnvironmentVariable.Builder>	serializableBuilderClass()
EnvironmentVariable.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
EnvironmentVariableType	type() The type of environment variable.
String	typeAsString() The type of environment variable.
String	value() The value of the environment variable.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

The name or key of the environment variable.

Returns:

The name or key of the environment variable.

value

public String value()

The value of the environment variable.

We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).

Returns:

The value of the environment variable.

We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).

type

public EnvironmentVariableType type()

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.

• PLAINTEXT: An environment variable in plaintext format.

If the service returns an enum value that is not available in the current SDK version, type will return EnvironmentVariableType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.

• PLAINTEXT: An environment variable in plaintext format.

See Also:

EnvironmentVariableType

typeAsString

public String typeAsString()

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.

• PLAINTEXT: An environment variable in plaintext format.

If the service returns an enum value that is not available in the current SDK version, type will return EnvironmentVariableType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.

• PLAINTEXT: An environment variable in plaintext format.

See Also:

EnvironmentVariableType

toBuilder

public EnvironmentVariable.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>

Returns:

a builder for type T

builder

public static EnvironmentVariable.Builder builder()

serializableBuilderClass

public static Class<? extends EnvironmentVariable.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.