/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataplex/v1/analyze.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dataplex.v1;
public interface EnvironmentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.Environment)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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) = { ... }
*
*
* @return The name.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Optional. User friendly display name.
*
*
* string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Optional. User friendly display name.
*
*
* string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* 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];
*
* @return The uid.
*/
java.lang.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];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Output only. Environment creation time.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Environment creation time.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Environment creation time.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time when the environment was last updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time when the environment was last updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Optional. User defined labels for the environment.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. User defined labels for the environment.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. User defined labels for the environment.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. User defined labels for the environment.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. User defined labels for the environment.
*
*
* map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Optional. Description of the environment.
*
*
* string description = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Optional. Description of the environment.
*
*
* string description = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Output only. Current state of the environment.
*
*
* .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. Current state of the environment.
*
*
* .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.dataplex.v1.State getState();
/**
*
*
*
* Required. Infrastructure specification for the Environment.
*
*
*
* .google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the infrastructureSpec field is set.
*/
boolean hasInfrastructureSpec();
/**
*
*
*
* Required. Infrastructure specification for the Environment.
*
*
*
* .google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The infrastructureSpec.
*/
com.google.cloud.dataplex.v1.Environment.InfrastructureSpec getInfrastructureSpec();
/**
*
*
*
* Required. Infrastructure specification for the Environment.
*
*
*
* .google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.dataplex.v1.Environment.InfrastructureSpecOrBuilder
getInfrastructureSpecOrBuilder();
/**
*
*
*
* Optional. Configuration for sessions created for this environment.
*
*
*
* .google.cloud.dataplex.v1.Environment.SessionSpec session_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the sessionSpec field is set.
*/
boolean hasSessionSpec();
/**
*
*
*
* Optional. Configuration for sessions created for this environment.
*
*
*
* .google.cloud.dataplex.v1.Environment.SessionSpec session_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The sessionSpec.
*/
com.google.cloud.dataplex.v1.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];
*
*/
com.google.cloud.dataplex.v1.Environment.SessionSpecOrBuilder getSessionSpecOrBuilder();
/**
*
*
*
* Output only. Status of sessions created for this environment.
*
*
*
* .google.cloud.dataplex.v1.Environment.SessionStatus session_status = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the sessionStatus field is set.
*/
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];
*
*
* @return The sessionStatus.
*/
com.google.cloud.dataplex.v1.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];
*
*/
com.google.cloud.dataplex.v1.Environment.SessionStatusOrBuilder getSessionStatusOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the endpoints field is set.
*/
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];
*
*
* @return The endpoints.
*/
com.google.cloud.dataplex.v1.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];
*
*/
com.google.cloud.dataplex.v1.Environment.EndpointsOrBuilder getEndpointsOrBuilder();
}
