DataSphere API v2, gRPC: ProjectService.Update

Статья создана

Yandex Cloud

Обновлена 17 декабря 2024 г.

gRPC request
UpdateProjectRequest
Settings
Limits
operation.Operation
UpdateProjectMetadata
Project
Settings
Limits

Updates the specified project.

gRPC request

rpc Update (UpdateProjectRequest) returns (operation.Operation)

UpdateProjectRequest

{
  "project_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "settings": {
    "service_account_id": "string",
    "subnet_id": "string",
    "data_proc_cluster_id": "string",
    "security_group_ids": [
      "string"
    ],
    "early_access": "bool",
    "ide": "Ide",
    "default_folder_id": "string",
    "stale_exec_timeout_mode": "StaleExecutionTimeoutMode",
    "vm_inactivity_timeout": "google.protobuf.Duration",
    "default_dedicated_spec": "string"
  },
  "limits": {
    "max_units_per_hour": "google.protobuf.Int64Value",
    "max_units_per_execution": "google.protobuf.Int64Value"
  }
}

Field	Description
project_id	string Required field. ID of the Project resource to update. To get the project ID use a ProjectService.List request.
update_mask	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	object (map<string, string>) Labels of the project.
settings	Settings Settings of the project.
limits	Limits Limits of the project.

Settings

Field	Description
service_account_id	string ID of the service account, on whose behalf all operations with clusters will be performed.
subnet_id	string ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported.
data_proc_cluster_id	string ID of the DataProc cluster.
security_group_ids[]	string Network interfaces security groups.
early_access	bool Is early access preview enabled for the project.
ide	enum Ide Project IDE. `IDE_UNSPECIFIED` `JUPYTER_LAB`: Project running on JupyterLab IDE.
default_folder_id	string Default project folder ID.
stale_exec_timeout_mode	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.
vm_inactivity_timeout	google.protobuf.Duration Timeout for VM deallocation.
default_dedicated_spec	string Default VM configuration for DEDICATED mode.

Limits

Field

Description

max_units_per_hour

google.protobuf.Int64Value

The number of units that can be spent per hour.

max_units_per_execution

google.protobuf.Int64Value

The number of units that can be spent on the one execution.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "project_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "created_by_id": "string",
    "settings": {
      "service_account_id": "string",
      "subnet_id": "string",
      "data_proc_cluster_id": "string",
      "security_group_ids": [
        "string"
      ],
      "early_access": "bool",
      "ide": "Ide",
      "default_folder_id": "string",
      "stale_exec_timeout_mode": "StaleExecutionTimeoutMode",
      "vm_inactivity_timeout": "google.protobuf.Duration",
      "default_dedicated_spec": "string"
    },
    "limits": {
      "max_units_per_hour": "google.protobuf.Int64Value",
      "max_units_per_execution": "google.protobuf.Int64Value"
    },
    "community_id": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	UpdateProjectMetadata 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. 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.
response	Project 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. Includes only one of the fields `error`, `response`. 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.

UpdateProjectMetadata

Field

Description

project_id

string

ID of the project that is being updated.

Project

A Project resource.

Field	Description
id	string ID of the project.
created_at	google.protobuf.Timestamp
name	string Name of the project. 1-63 characters long.
description	string Description of the project. 0-256 characters long.
labels	object (map<string, string>)
created_by_id	string
settings	Settings Settings of the project.
limits	Limits Limits of the project.
community_id	string ID of the community that the project belongs to.

Settings

Field	Description
service_account_id	string ID of the service account, on whose behalf all operations with clusters will be performed.
subnet_id	string ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported.
data_proc_cluster_id	string ID of the DataProc cluster.
security_group_ids[]	string Network interfaces security groups.
early_access	bool Is early access preview enabled for the project.
ide	enum Ide Project IDE. `IDE_UNSPECIFIED` `JUPYTER_LAB`: Project running on JupyterLab IDE.
default_folder_id	string Default project folder ID.
stale_exec_timeout_mode	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.
vm_inactivity_timeout	google.protobuf.Duration Timeout for VM deallocation.
default_dedicated_spec	string Default VM configuration for DEDICATED mode.

Limits

Field

Description

max_units_per_hour

google.protobuf.Int64Value

The number of units that can be spent per hour.

max_units_per_execution

google.protobuf.Int64Value

The number of units that can be spent on the one execution.

DataSphere API v2, gRPC: ProjectService.Update

gRPC requestgRPC request

UpdateProjectRequestUpdateProjectRequest

SettingsSettings

LimitsLimits

operation.Operationoperation.Operation

UpdateProjectMetadataUpdateProjectMetadata

ProjectProject

SettingsSettings

LimitsLimits

Была ли статья полезна?

gRPC request

UpdateProjectRequest

Settings

Limits

operation.Operation

UpdateProjectMetadata

Project

Settings

Limits