Package com.google.cloud.dataplex.v1

Class Environment

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.Environment
All Implemented Interfaces:
EnvironmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Environment extends com.google.protobuf.GeneratedMessage implements EnvironmentOrBuilder
 Environment represents a user-visible compute infrastructure for analytics
 within a lake.
Protobuf type google.cloud.dataplex.v1.Environment
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • UID_FIELD_NUMBER

      public static final int UID_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • INFRASTRUCTURE_SPEC_FIELD_NUMBER

      public static final int INFRASTRUCTURE_SPEC_FIELD_NUMBER
      See Also:

    • SESSION_SPEC_FIELD_NUMBER

      public static final int SESSION_SPEC_FIELD_NUMBER
      See Also:

    • SESSION_STATUS_FIELD_NUMBER

      public static final int SESSION_STATUS_FIELD_NUMBER
      See Also:

    • ENDPOINTS_FIELD_NUMBER

      public static final int ENDPOINTS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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) = { ... }
      Specified by:
      getName in interface EnvironmentOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getNameBytes in interface EnvironmentOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Optional. User friendly display name.
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayName in interface EnvironmentOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. User friendly display name.
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayNameBytes in interface EnvironmentOrBuilder
      Returns:
      The bytes for displayName.

    • getUid

      public String 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];
      Specified by:
      getUid in interface EnvironmentOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public com.google.protobuf.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];
      Specified by:
      getUidBytes in interface EnvironmentOrBuilder
      Returns:
      The bytes for uid.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Environment creation time.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface EnvironmentOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Environment creation time.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface EnvironmentOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Environment creation time.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface EnvironmentOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface EnvironmentOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time when the environment was last updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface EnvironmentOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time when the environment was last updated.
      .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface EnvironmentOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: EnvironmentOrBuilder
       Optional. User defined labels for the environment.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface EnvironmentOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. User defined labels for the environment.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface EnvironmentOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface EnvironmentOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. User defined labels for the environment.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface EnvironmentOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. User defined labels for the environment.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface EnvironmentOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. User defined labels for the environment.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface EnvironmentOrBuilder

    • getDescription

      public String getDescription()
       Optional. Description of the environment.
      string description = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface EnvironmentOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the environment.
      string description = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface EnvironmentOrBuilder
      Returns:
      The bytes for description.

    • getStateValue

      public int getStateValue()
       Output only. Current state of the environment.
      .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface EnvironmentOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public State getState()
       Output only. Current state of the environment.
      .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface EnvironmentOrBuilder
      Returns:
      The state.

    • hasInfrastructureSpec

      public boolean hasInfrastructureSpec()
       Required. Infrastructure specification for the Environment.
      .google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasInfrastructureSpec in interface EnvironmentOrBuilder
      Returns:
      Whether the infrastructureSpec field is set.

    • 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];
      Specified by:
      getInfrastructureSpec in interface EnvironmentOrBuilder
      Returns:
      The infrastructureSpec.

    • 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];
      Specified by:
      getInfrastructureSpecOrBuilder in interface EnvironmentOrBuilder

    • 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];
      Specified by:
      hasSessionSpec in interface EnvironmentOrBuilder
      Returns:
      Whether the sessionSpec field is set.

    • 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];
      Specified by:
      getSessionSpec in interface EnvironmentOrBuilder
      Returns:
      The sessionSpec.

    • 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];
      Specified by:
      getSessionSpecOrBuilder in interface EnvironmentOrBuilder

    • 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];
      Specified by:
      hasSessionStatus in interface EnvironmentOrBuilder
      Returns:
      Whether the sessionStatus field is set.

    • 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];
      Specified by:
      getSessionStatus in interface EnvironmentOrBuilder
      Returns:
      The sessionStatus.

    • 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];
      Specified by:
      getSessionStatusOrBuilder in interface EnvironmentOrBuilder

    • 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];
      Specified by:
      hasEndpoints in interface EnvironmentOrBuilder
      Returns:
      Whether the endpoints field is set.

    • 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];
      Specified by:
      getEndpoints in interface EnvironmentOrBuilder
      Returns:
      The endpoints.

    • 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];
      Specified by:
      getEndpointsOrBuilder in interface EnvironmentOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Environment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Environment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Environment parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Environment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Environment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Environment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Environment.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Environment.Builder newBuilder()

    • newBuilder

      public static Environment.Builder newBuilder(Environment prototype)

    • toBuilder

      public Environment.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Environment.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Environment getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Environment> parser()

    • getParserForType

      public com.google.protobuf.Parser<Environment> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Environment getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder