DataSphere API v2, REST: Project methods
A set of methods for managing Project resources.
JSON Representation
{
"id": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"createdById": "string",
"settings": {
"serviceAccountId": "string",
"subnetId": "string",
"dataProcClusterId": "string",
"commitMode": "string",
"securityGroupIds": [
"string"
],
"earlyAccess": true,
"ide": "string",
"defaultFolderId": "string",
"staleExecTimeoutMode": "string",
"ideExecutionMode": "string",
"vmInactivityTimeout": "string",
"defaultDedicatedSpec": "string"
},
"limits": {
"maxUnitsPerHour": "integer",
"maxUnitsPerExecution": "integer"
},
"communityId": "string"
}
Field | Description |
---|---|
id | string ID of the project. |
createdAt | string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the project. 1-63 characters long. |
description | string Description of the project. 0-256 characters long. |
labels | object |
createdById | string |
settings | object Settings of the project. |
settings. serviceAccountId |
string ID of the service account, on whose behalf all operations with clusters will be performed. |
settings. subnetId |
string ID of the subnet where the DataProc cluster resides. Currently only subnets created in the availability zone ru-central1-a are supported. |
settings. dataProcClusterId |
string ID of the DataProc cluster. |
settings. commitMode |
string Commit mode that is assigned to the project.
|
settings. securityGroupIds[] |
string Network interfaces security groups. |
settings. earlyAccess |
boolean (boolean) Is early access preview enabled for the project. |
settings. ide |
string Project IDE.
|
settings. defaultFolderId |
string Default project folder ID. |
settings. staleExecTimeoutMode |
string Timeout to automatically stop stale executions.
|
settings. ideExecutionMode |
string VM allocation mode.
|
settings. vmInactivityTimeout |
string Timeout for VM deallocation. |
settings. defaultDedicatedSpec |
string Default VM configuration for DEDICATED mode. |
limits | object Limits of the project. |
limits. maxUnitsPerHour |
integer (int64) The number of units that can be spent per hour. |
limits. maxUnitsPerExecution |
integer (int64) The number of units that can be spent on the one execution. |
communityId | string ID of the community that the project belongs to. |
Methods
Method | Description |
---|---|
addResource | Adds shared resource to project |
create | Creates a project in the specified folder. |
delete | Deletes the specified project. |
execute | Executes code of the specified notebook using configuration defined in the project settings. If the default project configuration is not specified, c1.4 is used. |
get | Returns the specified project. |
getCellOutputs | Returns outputs of the specified cell. Deprecated |
getStateVariables | Returns state variables of the specified notebook. Deprecated |
getUnitBalance | Returns the unit balance of the specified project. |
list | Lists projects for the specified community. |
listAccessBindings | Lists access bindings for the project. |
open | Opens the specified project. |
removeResource | Removes shared resource from project |
setAccessBindings | Sets access bindings for the project. |
setUnitBalance | Sets the unit balance of the specified project. |
update | Updates the specified project. |
updateAccessBindings | Updates access bindings for the project. |