Package com.google.cloud.dataplex.v1

Interface EnvironmentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Environment, Environment.Builder
@Generated public interface EnvironmentOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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) = { ... }
      Returns:
      The bytes for name.

    • getDisplayName

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

    • getDisplayNameBytes

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

    • getUid

      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];
      Returns:
      The uid.

    • getUidBytes

      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];
      Returns:
      The bytes for uid.

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Environment creation time.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • getLabelsCount

      int getLabelsCount()
       Optional. User defined labels for the environment.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • containsLabels

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

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. User defined labels for the environment.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrDefault

      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 getLabelsOrThrow(String key)
       Optional. User defined labels for the environment.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getDescription

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

    • getDescriptionBytes

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

    • getStateValue

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

    • getState

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

    • hasInfrastructureSpec

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

    • getInfrastructureSpec

      Environment.InfrastructureSpec getInfrastructureSpec()
       Required. Infrastructure specification for the Environment.
      .google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The infrastructureSpec.

    • getInfrastructureSpecOrBuilder

      Environment.InfrastructureSpecOrBuilder getInfrastructureSpecOrBuilder()
       Required. Infrastructure specification for the Environment.
      .google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];

    • hasSessionSpec

      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:
      Whether the sessionSpec field is set.

    • getSessionSpec

      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];
      Returns:
      The sessionSpec.

    • getSessionSpecOrBuilder

      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];

    • hasSessionStatus

      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:
      Whether the sessionStatus field is set.

    • getSessionStatus

      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];
      Returns:
      The sessionStatus.

    • getSessionStatusOrBuilder

      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];

    • hasEndpoints

      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:
      Whether the endpoints field is set.

    • getEndpoints

      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];
      Returns:
      The endpoints.

    • getEndpointsOrBuilder

      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];