Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Managed Spark Environment API, gRPC: EnvironmentService.List

Written by
Updated at August 26, 2026
View in Markdown

Retrieves a list of Environments.

gRPC request

rpc List (ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

ListEnvironmentsRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

folder_id

string

Required field. ID of the folder to list Environments in.

The maximum string length in characters is 50.

page_size

int64

The maximum number of results per page that should be returned. If the number of available
results is larger than page_size, the service returns a next_page_token that can be used
to get the next page of results in subsequent ListEnvironments requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

The maximum value is 1000.

page_token

string

Page token. Set page_token to the next_page_token returned by a previous ListEnvironments
request to get the next page of results.

The maximum string length in characters is 200.

filter

string

String that describes a display filter.

The maximum string length in characters is 1000.

ListEnvironmentsResponse

{
  "environments": [
    {
      "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"
      },
      "base_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"
      },
      "folder_id": "string",
      "config": {
        "pip_packages": [
          "string"
        ],
        "deb_packages": [
          "string"
        ]
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

environments[]

Environment

Requested list of Environments.

next_page_token

string

This token allows you to get the next page of results for ListEnvironments requests,
if the number of results is larger than page_size specified in the request.
To get the next page, specify the value of next_page_token as a value for
the page_token parameter in the next ListEnvironments request. Subsequent ListEnvironments
requests will have their own next_page_token to continue paging through the results.

The maximum string length in characters is 200.

Environment

Environment.

Field

Description

info

EnvironmentInfo

Required field. Environment info.

base_info

EnvironmentInfo

Required field. Base Environment info.

folder_id

string

ID of the folder that Environment belongs to.

config

EnvironmentConfig

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.

  • ENVIRONMENT_LIFESTAGE_UNKNOWN: Environment life stage is unknown.
  • ENVIRONMENT_LIFESTAGE_UNSTABLE: Environment unstable.
  • ENVIRONMENT_LIFESTAGE_STABLE: Environment stable.
  • ENVIRONMENT_LIFESTAGE_DEPRECATED: Environment deprecated.
  • ENVIRONMENT_LIFESTAGE_DELETED: Environment deleted.

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 ^[a-z][-a-z0-9]{1,61}[a-z0-9]$.

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 [a-z][-_0-9a-z]*. Each value must match the regular expression [-_0-9a-z]*. No more than 64 per resource.

created_at

google.protobuf.Timestamp

The time when the Environment was created.

deleted_at

google.protobuf.Timestamp

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_STATUS_UNKNOWN: Build status is unknown.
  • BUILD_STATUS_NEW: Build pending.
  • BUILD_STATUS_BUILDING: Build creating.
  • BUILD_STATUS_BUILT: Build created successfully.
  • BUILD_STATUS_VALIDATING: Build validating.
  • BUILD_STATUS_READY: Build ready to use.
  • BUILD_STATUS_STABLE: Build stable.
  • BUILD_STATUS_ERROR: Build creation failed.
  • BUILD_STATUS_DELETING: Build deleting.
  • BUILD_STATUS_DELETED: Build deleted.

build_error

BuildError

Actual build creation error.

build_created_at

google.protobuf.Timestamp

The time when the actual build was created.

build_deleted_at

google.protobuf.Timestamp

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.

EnvironmentConfig

Spark Environment Configuration.

Field

Description

pip_packages[]

string

Environment pip packages.

The maximum string length in characters for each value is 256. The maximum number of elements is 100.

deb_packages[]

string

Environment deb packages.

The maximum string length in characters for each value is 256. The maximum number of elements is 100.
Previous
GetBase
Next
ListBase