Update

Updates the specified project.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Project = cloudApi.datasphere.project.Project;
const UpdateProjectRequest =
  cloudApi.datasphere.project_service.UpdateProjectRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ProjectServiceClient);

  const operation = await client.update(
    UpdateProjectRequest.fromPartial({
      projectId: "projectId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // settings: {
      // serviceAccountId: "serviceAccountId",
      // subnetId: "subnetId",
      // dataProcClusterId: "dataProcClusterId",
      // securityGroupIds: ["securityGroupIds"]
      // },
      // limits: {
      // maxUnitsPerHour: {
      // value: 0
      // },
      // maxUnitsPerExecution: {
      // value: 0
      // }
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Project>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.datasphere.v1.project_pb2 import Project
from yandex.cloud.datasphere.v1.project_service_pb2_grpc import ProjectServiceStub
from yandex.cloud.datasphere.v1.project_service_pb2 import UpdateProjectMetadata
from yandex.cloud.datasphere.v1.project_service_pb2 import UpdateProjectRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ProjectServiceStub)
operation = service.Update(
    UpdateProjectRequest(
        project_id="projectId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # settings = Project.Settings(
        # service_account_id = "serviceAccountId",
        # subnet_id = "subnetId",
        # data_proc_cluster_id = "dataProcClusterId",
        # security_group_ids = ["securityGroupIds"]
        # ),
        # limits = Project.Limits(
        # max_units_per_hour = Int64Value(
        # value = 0
        # ),
        # max_units_per_execution = Int64Value(
        # value = 0
        # )
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Project,
    meta_type=UpdateProjectMetadata,
)
print(operation_result)

UpdateProjectRequest

projectId : string

ID of the Project resource to update. To get the project ID use a ProjectService.List request.

updateMask : google.protobuf.FieldMask

Field mask that specifies which fields of the Project resource are going to be updated.

name : string

Name of the project. 0-63 characters long.

description : string

Description of the project. 0-256 characters long.

labels : string

Labels of the project.

settings : Project.Settings

Settings of the project.

limits : Project.Limits

Limits of the project.

Settings

Ide

• IDE_UNSPECIFIED

• JUPYTER_LAB

  Project running on JupyterLab IDE.

StaleExecutionTimeoutMode

• 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.

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 : Ide

Project IDE.

defaultFolderId : string

Default project folder ID.

staleExecTimeoutMode : StaleExecutionTimeoutMode

Timeout to automatically stop stale executions.

vmInactivityTimeout : google.protobuf.Duration

Timeout for VM deallocation.

defaultDedicatedSpec : string

Default VM configuration for DEDICATED mode.

Limits

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.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp

The time when the Operation resource was last modified.

done : bool

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

• error : google.rpc.Status

  The error result of the operation in case of failure or cancellation.

• response : google.protobuf.Any

  The normal response of the operation in case of success.

  If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

---