EnvironmentVariable (AWS Java SDK :: Services :: AWS Code Build 2.16.60 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EnvironmentVariable.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EnvironmentVariable.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(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()`
`String`	`toString()` Returns a string representation of this object.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - name
```
public final String name()
```
    The name or key of the environment variable.
    
    Returns:
    
    The name or key of the environment variable.
  - value
```
public final String value()
```
    The value of the environment variable.
    
    We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
    
    Returns:
    
    The value of the environment variable.
    
    We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
  - type
```
public final EnvironmentVariableType type()
```
    The type of environment variable. Valid values include:
    - PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.
    - PLAINTEXT: An environment variable in plain text format. This is the default value.
    - SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.
    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. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.
    
    PLAINTEXT: An environment variable in plain text format. This is the default value.
    
    SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.
    See Also:
    
    EnvironmentVariableType
  - typeAsString
```
public final String typeAsString()
```
    The type of environment variable. Valid values include:
    - PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.
    - PLAINTEXT: An environment variable in plain text format. This is the default value.
    - SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.
    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. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.
    
    PLAINTEXT: An environment variable in plain text format. This is the default value.
    
    SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.
    See Also:
    
    EnvironmentVariableType
  - toBuilder
```
public EnvironmentVariable.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>
  - builder
```
public static EnvironmentVariable.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EnvironmentVariable.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class EnvironmentVariable

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

value

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields