public final class Environment extends GeneratedMessageV3 implements EnvironmentOrBuilder
Environment represents a user-visible compute infrastructure for analytics
within a lake.
Protobuf type google.cloud.dataplex.v1.Environment
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ENDPOINTS_FIELD_NUMBER
public static final int ENDPOINTS_FIELD_NUMBER
Field Value
INFRASTRUCTURE_SPEC_FIELD_NUMBER
public static final int INFRASTRUCTURE_SPEC_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SESSION_SPEC_FIELD_NUMBER
public static final int SESSION_SPEC_FIELD_NUMBER
Field Value
SESSION_STATUS_FIELD_NUMBER
public static final int SESSION_STATUS_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Environment getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Environment.Builder newBuilder()
Returns
newBuilder(Environment prototype)
public static Environment.Builder newBuilder(Environment prototype)
Parameter
Returns
public static Environment parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Environment parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Environment parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Environment parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Environment parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Environment parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Environment> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. User defined labels for the environment.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Environment creation time.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Environment creation time.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Environment getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Optional. Description of the environment.
string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Description of the environment.
string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
Optional. User friendly display name.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. User friendly display name.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for displayName.
|
getEndpoints()
public Environment.Endpoints getEndpoints()
Output only. URI Endpoints to access sessions associated with the
Environment.
.google.cloud.dataplex.v1.Environment.Endpoints endpoints = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndpointsOrBuilder()
public Environment.EndpointsOrBuilder getEndpointsOrBuilder()
Output only. URI Endpoints to access sessions associated with the
Environment.
.google.cloud.dataplex.v1.Environment.Endpoints endpoints = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
getInfrastructureSpec()
public Environment.InfrastructureSpec getInfrastructureSpec()
Required. Infrastructure specification for the Environment.
.google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
getInfrastructureSpecOrBuilder()
public Environment.InfrastructureSpecOrBuilder getInfrastructureSpecOrBuilder()
Required. Infrastructure specification for the Environment.
.google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Optional. User defined labels for the environment.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. User defined labels for the environment.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. User defined labels for the environment.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. User defined labels for the environment.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
getName()
Output only. The relative resource name of the environment, of the form:
projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The relative resource name of the environment, of the form:
projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<Environment> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSessionSpec()
public Environment.SessionSpec getSessionSpec()
Optional. Configuration for sessions created for this environment.
.google.cloud.dataplex.v1.Environment.SessionSpec session_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
getSessionSpecOrBuilder()
public Environment.SessionSpecOrBuilder getSessionSpecOrBuilder()
Optional. Configuration for sessions created for this environment.
.google.cloud.dataplex.v1.Environment.SessionSpec session_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
getSessionStatus()
public Environment.SessionStatus getSessionStatus()
Output only. Status of sessions created for this environment.
.google.cloud.dataplex.v1.Environment.SessionStatus session_status = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSessionStatusOrBuilder()
public Environment.SessionStatusOrBuilder getSessionStatusOrBuilder()
Output only. Status of sessions created for this environment.
.google.cloud.dataplex.v1.Environment.SessionStatus session_status = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState()
Output only. Current state of the environment.
.google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| State | The state.
|
getStateValue()
public int getStateValue()
Output only. Current state of the environment.
.google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUid()
Output only. System generated globally unique ID for the environment. This
ID will be different if the environment is deleted and re-created with the
same name.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUidBytes()
public ByteString getUidBytes()
Output only. System generated globally unique ID for the environment. This
ID will be different if the environment is deleted and re-created with the
same name.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time when the environment was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time when the environment was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Environment creation time.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasEndpoints()
public boolean hasEndpoints()
Output only. URI Endpoints to access sessions associated with the
Environment.
.google.cloud.dataplex.v1.Environment.Endpoints endpoints = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the endpoints field is set.
|
hasInfrastructureSpec()
public boolean hasInfrastructureSpec()
Required. Infrastructure specification for the Environment.
.google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the infrastructureSpec field is set.
|
hasSessionSpec()
public boolean hasSessionSpec()
Optional. Configuration for sessions created for this environment.
.google.cloud.dataplex.v1.Environment.SessionSpec session_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the sessionSpec field is set.
|
hasSessionStatus()
public boolean hasSessionStatus()
Output only. Status of sessions created for this environment.
.google.cloud.dataplex.v1.Environment.SessionStatus session_status = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the sessionStatus field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The time when the environment was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Environment.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Environment.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
