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 |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENDPOINTS_FIELD_NUMBER
public static final int ENDPOINTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INFRASTRUCTURE_SPEC_FIELD_NUMBER
public static final int INFRASTRUCTURE_SPEC_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 | |
SESSION_SPEC_FIELD_NUMBER
public static final int SESSION_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SESSION_STATUS_FIELD_NUMBER
public static final int SESSION_STATUS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Environment getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Environment.Builder newBuilder()
newBuilder(Environment prototype)
public static Environment.Builder newBuilder(Environment prototype)
public static Environment parseDelimitedFrom(InputStream input)
public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Environment parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Environment parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(CodedInputStream input)
public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(InputStream input)
public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Environment parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Environment> parser()
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];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Environment creation time.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
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()
getDescription()
public String getDescription()
Optional. Description of the environment.
string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Description of the environment.
string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. User friendly display name.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| 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()
getLabelsCount()
public int getLabelsCount()
Optional. User defined labels for the environment.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | |
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];
| Parameter |
|---|
| Name | Description |
key | String
|
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) = { ... }
| Returns |
|---|
| 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) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Environment> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
String | The uid.
|
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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uid.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| 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];
| Returns |
|---|
| 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];
| Returns |
|---|
| 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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Environment.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Environment.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
