Managed Spark Environment API, gRPC: EnvironmentService.GetBase
Returns the specified Base Environment.
gRPC request
rpc GetBase (GetBaseEnvironmentRequest) returns (BaseEnvironment)
GetBaseEnvironmentRequest
{
"environment_id": "string",
"folder_id": "string"
}
|
Field |
Description |
|
environment_id |
string Required field. ID of the Base Environment to return. The maximum string length in characters is 50. |
|
folder_id |
string Required field. ID of the folder where the base environment is used. The maximum string length in characters is 50. |
BaseEnvironment
{
"info": {
"id": "string",
"life_stage": "EnvironmentLifeStage",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"created_at": "google.protobuf.Timestamp",
"deleted_at": "google.protobuf.Timestamp",
"build_revision": "int64",
"build_base_revision": "int64",
"build_status": "BuildStatus",
"build_error": {
"type": "string",
"message": "string"
},
"build_created_at": "google.protobuf.Timestamp",
"build_deleted_at": "google.protobuf.Timestamp"
},
"config": {
"spark_version": "string"
}
}
Base Environment.
|
Field |
Description |
|
info |
Required field. Base Environment info. |
|
config |
Required field. Base Environment Configuration. |
EnvironmentInfo
Environment Info.
|
Field |
Description |
|
id |
string Required field. Unique ID of the Environment. This ID is assigned in the process of creating an Environment. The maximum string length in characters is 50. |
|
life_stage |
enum EnvironmentLifeStage Environment life stage.
|
|
name |
string Required field. Name of the Environment. The name of the user environment is unique within the folder. 1-63 characters long. The maximum string length in characters is 63. Value must match the regular expression |
|
description |
string Description of the Environment. 0-256 characters long. |
|
labels |
object (map<string, string>) Environment labels. The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression |
|
created_at |
The time when the Environment was created. |
|
deleted_at |
The time when the Environment was deleted. |
|
build_revision |
int64 Actual build revision number. Value must be greater than 0. |
|
build_base_revision |
int64 Base environment actual build revision number. |
|
build_status |
enum BuildStatus Actual build status.
|
|
build_error |
Actual build creation error. |
|
build_created_at |
The time when the actual build was created. |
|
build_deleted_at |
The time when the actual build was deleted. |
BuildError
Environment Build Error.
|
Field |
Description |
|
type |
string Error Type. The maximum string length in characters is 100. |
|
message |
string Error Message. The maximum string length in characters is 2000. |
BaseEnvironmentConfig
Spark Base Environment Configuration.
|
Field |
Description |
|
spark_version |
string Required field. Base Environment Spark version. Format: "Major.Minor". |