Contact UsGet started

DataSphere API v2, gRPC: ProjectService.List

Written by
Updated at October 17, 2024

Lists projects for the specified community.

gRPC request

rpc List (ListProjectsRequest) returns (ListProjectsResponse)

ListProjectsRequest

{
  "communityId": "string",
  "pageSize": "int64",
  "pageToken": "string",
  "projectNamePattern": "string",
  "ownedById": "string"
}

Field

Description

communityId

string

Required field. ID of the community to list projects in.

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListProjectsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListProjectsResponse.nextPageToken returned by a previous list request.

projectNamePattern

string

Name pattern to filter projects that are returned.
Only projects with names matching the pattern will be returned.

ownedById

string

User ID to filter projects that are returned.
Only projects that are owned by specified user will be returned.

ListProjectsResponse

{
  "projects": [
    {
      "id": "string",
      "createdAt": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "string",
      "createdById": "string",
      "settings": {
        "serviceAccountId": "string",
        "subnetId": "string",
        "dataProcClusterId": "string",
        "securityGroupIds": [
          "string"
        ],
        "earlyAccess": "bool",
        "ide": "Ide",
        "defaultFolderId": "string",
        "staleExecTimeoutMode": "StaleExecutionTimeoutMode",
        "vmInactivityTimeout": "google.protobuf.Duration",
        "defaultDedicatedSpec": "string"
      },
      "limits": {
        "maxUnitsPerHour": "google.protobuf.Int64Value",
        "maxUnitsPerExecution": "google.protobuf.Int64Value"
      },
      "communityId": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

projects[]

Project

List of Project resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListProjectsRequest.pageSize, use
the nextPageToken as the value
for the ListProjectsRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

Project

A Project resource.

Field

Description

id

string

ID of the project.

createdAt

google.protobuf.Timestamp

name

string

Name of the project. 1-63 characters long.

description

string

Description of the project. 0-256 characters long.

labels

string

createdById

string

settings

Settings

Settings of the project.

limits

Limits

Limits of the project.

communityId

string

ID of the community that the project belongs to.

Settings

Field

Description

serviceAccountId

string

ID of the service account, on whose behalf all operations with clusters will be performed.

subnetId

string

ID of the subnet where the DataProc cluster resides.
Currently only subnets created in the availability zone ru-central1-a are supported.

dataProcClusterId

string

ID of the DataProc cluster.

securityGroupIds[]

string

Network interfaces security groups.

earlyAccess

bool

Is early access preview enabled for the project.

ide

enum Ide

Project IDE.

  • IDE_UNSPECIFIED
  • JUPYTER_LAB: Project running on JupyterLab IDE.

defaultFolderId

string

Default project folder ID.

staleExecTimeoutMode

enum StaleExecutionTimeoutMode

Timeout to automatically stop stale executions.

  • STALE_EXECUTION_TIMEOUT_MODE_UNSPECIFIED
  • ONE_HOUR: Setting to automatically stop stale execution after one hour with low consumption.
  • THREE_HOURS: Setting to automatically stop stale execution after three hours with low consumption.
  • NO_TIMEOUT: Setting to never automatically stop stale executions.

vmInactivityTimeout

google.protobuf.Duration

Timeout for VM deallocation.

defaultDedicatedSpec

string

Default VM configuration for DEDICATED mode.

Limits

Field

Description

maxUnitsPerHour

google.protobuf.Int64Value

The number of units that can be spent per hour.

maxUnitsPerExecution

google.protobuf.Int64Value

The number of units that can be spent on the one execution.
Previous
Get
Next
GetUnitBalance