Class Environment (1.42.0) 

public final class Environment extends GeneratedMessageV3 implements EnvironmentOrBuilder

An environment for running orchestration tasks.

Protobuf type google.cloud.orchestration.airflow.service.v1beta1.Environment

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Environment

Static Fields

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_CONFIG_FIELD_NUMBER

public static final int STORAGE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

UUID_FIELD_NUMBER

public static final int UUID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Environment getDefaultInstance()
Returns
Type Description
Environment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Environment.Builder newBuilder()
Returns
Type Description
Environment.Builder

newBuilder(Environment prototype)

public static Environment.Builder newBuilder(Environment prototype)
Parameter
Name Description
prototype Environment
Returns
Type Description
Environment.Builder

parseDelimitedFrom(InputStream input)

public static Environment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Environment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Environment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Environment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Environment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Environment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Environment> parser()
Returns
Type Description
Parser<Environment>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfig()

public EnvironmentConfig getConfig()

Configuration parameters for this environment.

.google.cloud.orchestration.airflow.service.v1beta1.EnvironmentConfig config = 2;

Returns
Type Description
EnvironmentConfig

The config.

getConfigOrBuilder()

public EnvironmentConfigOrBuilder getConfigOrBuilder()

Configuration parameters for this environment.

.google.cloud.orchestration.airflow.service.v1beta1.EnvironmentConfig config = 2;

Returns
Type Description
EnvironmentConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which this environment was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which this environment was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()
Returns
Type Description
Environment

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Environment> getParserForType()
Returns
Type Description
Parser<Environment>
Overrides

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Environment.State getState()

The current state of the environment.

.google.cloud.orchestration.airflow.service.v1beta1.Environment.State state = 4;

Returns
Type Description
Environment.State

The state.

getStateValue()

public int getStateValue()

The current state of the environment.

.google.cloud.orchestration.airflow.service.v1beta1.Environment.State state = 4;

Returns
Type Description
int

The enum numeric value on the wire for state.

getStorageConfig()

public StorageConfig getStorageConfig()

Optional. Storage configuration for this environment.

.google.cloud.orchestration.airflow.service.v1beta1.StorageConfig storage_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StorageConfig

The storageConfig.

getStorageConfigOrBuilder()

public StorageConfigOrBuilder getStorageConfigOrBuilder()

Optional. Storage configuration for this environment.

.google.cloud.orchestration.airflow.service.v1beta1.StorageConfig storage_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StorageConfigOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time at which this environment was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which this environment was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getUuid()

public String getUuid()

Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.

string uuid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uuid.

getUuidBytes()

public ByteString getUuidBytes()

Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.

string uuid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uuid.

hasConfig()

public boolean hasConfig()

Configuration parameters for this environment.

.google.cloud.orchestration.airflow.service.v1beta1.EnvironmentConfig config = 2;

Returns
Type Description
boolean

Whether the config field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which this environment was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasStorageConfig()

public boolean hasStorageConfig()

Optional. Storage configuration for this environment.

.google.cloud.orchestration.airflow.service.v1beta1.StorageConfig storage_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the storageConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time at which this environment was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Environment.Builder newBuilderForType()
Returns
Type Description
Environment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Environment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Environment.Builder toBuilder()
Returns
Type Description
Environment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException