DataSphere API v2, gRPC: ProjectService
A set of methods for managing Project resources.
Call | Description |
---|---|
Create | Creates a project in the specified folder. |
Update | Updates the specified project. |
Delete | Deletes the specified project. |
Open | Opens the specified project. |
Get | Returns the specified project. |
List | Lists projects for the specified community. |
GetUnitBalance | Returns the unit balance of the specified project. |
SetUnitBalance | Sets the unit balance of the specified project. |
Execute | Executes code of the specified notebook using configuration defined in the project settings. |
GetCellOutputs | Returns outputs of the specified cell. |
GetStateVariables | Returns state variables of the specified notebook. |
ListAccessBindings | Lists access bindings for the project. |
SetAccessBindings | Sets access bindings for the project. |
UpdateAccessBindings | Updates access bindings for the project. |
AddResource | Adds shared resource to project |
RemoveResource | Removes shared resource from project |
Calls ProjectService
Create
Creates a project in the specified folder.
rpc Create (CreateProjectRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateProjectMetadata
Operation.response:Project
CreateProjectRequest
Field | Description |
---|---|
community_id | string Required. ID of the community to create a project in. The maximum string length in characters is 50. |
name | string Name of the project. 0-63 characters long. The maximum string length in characters is 63. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the project. 0-256 characters long. The maximum string length in characters is 256. |
labels | map<string,string> Labels of the project. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
settings | Project.Settings Settings of the project. |
limits | Project.Limits Limits of the project. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateProjectMetadata
Field | Description |
---|---|
project_id | string ID of the project that is being created. |
Project
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 | 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. |
commit_mode | enum CommitMode Commit mode that is assigned to the project.
|
security_group_ids[] | string Network interfaces security groups. |
early_access | bool Is early access preview enabled for the project. |
ide | enum Ide Project IDE.
|
default_folder_id | string Default project folder ID. |
stale_exec_timeout_mode | enum StaleExecutionTimeoutMode Timeout to automatically stop stale executions.
|
ide_execution_mode | enum IdeExecutionMode VM allocation mode.
|
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. |
Update
Updates the specified project.
rpc Update (UpdateProjectRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateProjectMetadata
Operation.response:Project
UpdateProjectRequest
Field | Description |
---|---|
project_id | string Required. ID of the Project resource to update. To get the project ID use a ProjectService.List request. The maximum string length in characters is 50. |
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. The maximum string length in characters is 63. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the project. 0-256 characters long. The maximum string length in characters is 256. |
labels | map<string,string> Labels of the project. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
settings | Project.Settings Settings of the project. |
limits | Project.Limits Limits of the project. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateProjectMetadata
Field | Description |
---|---|
project_id | string ID of the project that is being updated. |
Project
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 | 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. |
commit_mode | enum CommitMode Commit mode that is assigned to the project.
|
security_group_ids[] | string Network interfaces security groups. |
early_access | bool Is early access preview enabled for the project. |
ide | enum Ide Project IDE.
|
default_folder_id | string Default project folder ID. |
stale_exec_timeout_mode | enum StaleExecutionTimeoutMode Timeout to automatically stop stale executions.
|
ide_execution_mode | enum IdeExecutionMode VM allocation mode.
|
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. |
Delete
Deletes the specified project.
rpc Delete (DeleteProjectRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteProjectMetadata
Operation.response:google.protobuf.Empty
DeleteProjectRequest
Field | Description |
---|---|
project_id | string Required. ID of the Project resource to delete. To get the project ID use a ProjectService.List request. The maximum string length in characters is 50. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteProjectMetadata
Field | Description |
---|---|
project_id | string ID of the project that is being deleted. |
Open
Opens the specified project.
rpc Open (OpenProjectRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:OpenProjectMetadata
Operation.response:OpenProjectResponse
OpenProjectRequest
Field | Description |
---|---|
project_id | string Required. ID of the Project resource to open. To get the project ID use a ProjectService.List request. The maximum string length in characters is 50. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
OpenProjectMetadata
Field | Description |
---|---|
project_id | string ID of the project that is being opened. |
status | enum OpenProjectStatus Project opening status.
|
OpenProjectResponse
Field | Description |
---|---|
project_url | string URL of the project that is being opened. Make GET request to project_url with sessionToken query parameter equals to session_token or POST request to project_url with sessionToken body parameter equals to session_token to fetch DataSphere web interface. |
session_token | string Session token of the project that is being opened. |
Get
Returns the specified project.
rpc Get (GetProjectRequest) returns (Project)
GetProjectRequest
Field | Description |
---|---|
project_id | string Required. ID of the Project resource to return. To get the project ID use a ProjectService.List request. The maximum string length in characters is 50. |
Project
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 | 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. |
commit_mode | enum CommitMode Commit mode that is assigned to the project.
|
security_group_ids[] | string Network interfaces security groups. |
early_access | bool Is early access preview enabled for the project. |
ide | enum Ide Project IDE.
|
default_folder_id | string Default project folder ID. |
stale_exec_timeout_mode | enum StaleExecutionTimeoutMode Timeout to automatically stop stale executions.
|
ide_execution_mode | enum IdeExecutionMode VM allocation mode.
|
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. |
List
Lists projects for the specified community.
rpc List (ListProjectsRequest) returns (ListProjectsResponse)
ListProjectsRequest
Field | Description |
---|---|
community_id | string Required. ID of the community to list projects in. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListProjectsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListProjectsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
project_name_pattern | string Name pattern to filter projects that are returned. Only projects with names matching the pattern will be returned. |
owned_by_id | string User ID to filter projects that are returned. Only projects that are owned by specified user will be returned. |
ListProjectsResponse
Field | Description |
---|---|
projects[] | Project List of Project resources. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListProjectsRequest.page_size, use the next_page_token as the value for the ListProjectsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Project
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 | 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. |
commit_mode | enum CommitMode Commit mode that is assigned to the project.
|
security_group_ids[] | string Network interfaces security groups. |
early_access | bool Is early access preview enabled for the project. |
ide | enum Ide Project IDE.
|
default_folder_id | string Default project folder ID. |
stale_exec_timeout_mode | enum StaleExecutionTimeoutMode Timeout to automatically stop stale executions.
|
ide_execution_mode | enum IdeExecutionMode VM allocation mode.
|
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. |
GetUnitBalance
Returns the unit balance of the specified project.
rpc GetUnitBalance (GetUnitBalanceRequest) returns (GetUnitBalanceResponse)
GetUnitBalanceRequest
Field | Description |
---|---|
project_id | string Required. ID of the project to return the unit balance for. The maximum string length in characters is 50. |
GetUnitBalanceResponse
Field | Description |
---|---|
unit_balance | google.protobuf.Int64Value The number of units available to the project. |
SetUnitBalance
Sets the unit balance of the specified project.
rpc SetUnitBalance (SetUnitBalanceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:SetUnitBalanceMetadata
Operation.response:google.protobuf.Empty
SetUnitBalanceRequest
Field | Description |
---|---|
project_id | string Required. ID of the project to set the unit balance for. The maximum string length in characters is 50. |
unit_balance | google.protobuf.Int64Value The number of units available to the project. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
SetUnitBalanceMetadata
Field | Description |
---|---|
project_id | string ID of the project which unit balance is set. |
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.
rpc Execute (ProjectExecutionRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:ProjectExecutionMetadata
Operation.response:ProjectExecutionResponse
ProjectExecutionRequest
Field | Description |
---|---|
project_id | string Required. ID of the project to execute notebook/cell in. The maximum string length in characters is 50. |
target | oneof: notebook_id or cell_id |
notebook_id | string The path to the executable notebook in the project storage. The maximum string length is 200 characters. To get the path, right-click on the notebook in JupyterLab and select Copy path . The maximum string length in characters is 200. |
cell_id | string ID of the cell to execute. Deprecated The maximum string length in characters is 200. |
input_variables | google.protobuf.Struct Values of input variables. |
output_variable_names[] | string Names of output variables. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
ProjectExecutionMetadata
Field | Description |
---|---|
project_id | string ID of the project in which notebook is being executed. |
target | oneof: notebook_id or cell_id |
notebook_id | string ID of the notebook that is being executed The maximum string length in characters is 200. |
cell_id | string ID of the cell that is being executed The maximum string length in characters is 200. |
ProjectExecutionResponse
Field | Description |
---|---|
checkpoint_id | string ID of the checkpoint resulting from the execution. |
output_variables | google.protobuf.Struct Values of output variables resulting from the execution. |
execution_status | enum ExecutionStatus Execution final status.
|
GetCellOutputs
Returns outputs of the specified cell. Deprecated
rpc GetCellOutputs (CellOutputsRequest) returns (CellOutputsResponse)
CellOutputsRequest
Field | Description |
---|---|
project_id | string Required. ID of the project to return cell outputs for. The maximum string length in characters is 50. |
cell_id | string Required. ID of the cell to return outputs for. The maximum string length in characters is 200. |
checkpoint_id | string ID of the checkpoint to return cell outputs for. |
start_at | google.protobuf.Timestamp Timestamp from which to return outputs. |
CellOutputsResponse
Field | Description |
---|---|
outputs[] | string List of outputs. |
GetStateVariables
Returns state variables of the specified notebook. Deprecated
rpc GetStateVariables (GetStateVariablesRequest) returns (GetStateVariablesResponse)
GetStateVariablesRequest
Field | Description |
---|---|
project_id | string Required. ID of the project, for which to return state variables. The maximum string length in characters is 50. |
notebook_id | string Required. ID of the notebook, for which to return state variables. The maximum string length in characters is 200. |
variable_names[] | string Names of variables to return. |
checkpoint_id | string ID of the checkpoint, for which to return state variables. |
GetStateVariablesResponse
Field | Description |
---|---|
variables | google.protobuf.Struct Values of the specified variables. |
ListAccessBindings
Lists access bindings for the project.
rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)
ListAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource to list access bindings for. To get the resource ID, use a corresponding List request. For example, use the yandex.cloud.resourcemanager.v1.CloudService.List request to get the Cloud resource ID. 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 ListAccessBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
page_token | string Page token. Set page_token to the ListAccessBindingsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 100. |
ListAccessBindingsResponse
Field | Description |
---|---|
access_bindings[] | AccessBinding List of access bindings for the specified resource. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListAccessBindingsRequest.page_size, use the next_page_token as the value for the ListAccessBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
SetAccessBindings
Sets access bindings for the project.
rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:SetProjectAccessBindingsMetadata
Operation.response:google.protobuf.Empty
SetAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource for which access bindings are being set. To get the resource ID, use a corresponding List request. The maximum string length in characters is 50. |
access_bindings[] | AccessBinding Required. Access bindings to be set. For more information, see Access Bindings. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
SetProjectAccessBindingsMetadata
Field | Description |
---|---|
project_id | string ID of the project which access bindings are set. |
UpdateAccessBindings
Updates access bindings for the project.
rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateProjectAccessBindingsMetadata
Operation.response:google.protobuf.Empty
UpdateAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource for which access bindings are being updated. The maximum string length in characters is 50. |
access_binding_deltas[] | AccessBindingDelta Required. Updates to access bindings. The number of elements must be greater than 0. |
AccessBindingDelta
Field | Description |
---|---|
action | enum AccessBindingAction Required. The action that is being performed on an access binding.
|
access_binding | AccessBinding Required. Access binding. For more information, see Access Bindings. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateProjectAccessBindingsMetadata
Field | Description |
---|---|
project_id | string ID of the project which access bindings are updated. |
AddResource
Adds shared resource to project
rpc AddResource (AddResourceToProjectRequest) returns (operation.Operation)
Response of Operation:
Operation.response:google.protobuf.Empty
AddResourceToProjectRequest
Field | Description |
---|---|
project_id | string Required. The maximum string length in characters is 50. |
resource_type | enum ResourceType |
resource_id | string Required. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RemoveResource
Removes shared resource from project
rpc RemoveResource (RemoveResourceFromProjectRequest) returns (operation.Operation)
Response of Operation:
Operation.response:google.protobuf.Empty
RemoveResourceFromProjectRequest
Field | Description |
---|---|
project_id | string Required. The maximum string length in characters is 50. |
resource_type | enum ResourceType |
resource_id | string Required. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |