googleapis.com – notebooks
Notebooks API is used to manage notebook resources in Google Cloud.
- Homepage
- https://api.apis.guru/v2/specs/googleapis.com:notebooks/v1.json
- Provider
- googleapis.com:notebooks / notebooks
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/googleapis.com/notebooks/v1/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/googleapis.com/notebooks/v1/openapi.yaml
Tools (42)
Extracted live via the executor SDK.
-
projects.notebooksProjectsLocationsEnvironmentsCreateCreates a new Environment.
-
projects.notebooksProjectsLocationsEnvironmentsListLists environments in a project.
-
projects.notebooksProjectsLocationsExecutionsCreateCreates a new Execution in a given project and location.
-
projects.notebooksProjectsLocationsExecutionsListLists executions in a given project and location
-
projects.notebooksProjectsLocationsInstancesCreateCreates a new Instance in a given project and location.
-
projects.notebooksProjectsLocationsInstancesGetInstanceHealthCheck if a notebook instance is healthy.
-
projects.notebooksProjectsLocationsInstancesIsUpgradeableCheck if a notebook instance is upgradable.
-
projects.notebooksProjectsLocationsInstancesListLists instances in a given project and location.
-
projects.notebooksProjectsLocationsInstancesRegisterRegisters an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.
-
projects.notebooksProjectsLocationsInstancesReportAllows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.
-
projects.notebooksProjectsLocationsInstancesRollbackRollbacks a notebook instance to the previous version.
-
projects.notebooksProjectsLocationsInstancesSetAcceleratorUpdates the guest accelerators of a single Instance.
-
projects.notebooksProjectsLocationsInstancesSetLabelsReplaces all the labels of an Instance.
-
projects.notebooksProjectsLocationsInstancesSetMachineTypeUpdates the machine type of a single Instance.
-
projects.notebooksProjectsLocationsInstancesUpdateConfigUpdate Notebook Instance configurations.
-
projects.notebooksProjectsLocationsInstancesUpdateMetadataItemsAdd/update metadata items for an instance.
-
projects.notebooksProjectsLocationsInstancesUpdateShieldedInstanceConfigUpdates the Shielded instance configuration of a single Instance.
-
projects.notebooksProjectsLocationsInstancesUpgradeInternalAllows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
-
projects.notebooksProjectsLocationsListLists information about the supported locations for this service.
-
projects.notebooksProjectsLocationsOperationsCancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding toCode.CANCELLED. -
projects.notebooksProjectsLocationsOperationsListLists operations that match the specified filter in the request. If the server doesn't support this method, it returns
UNIMPLEMENTED. -
projects.notebooksProjectsLocationsRuntimesCreateCreates a new Runtime in a given project and location.
-
projects.notebooksProjectsLocationsRuntimesDiagnoseCreates a Diagnostic File and runs Diagnostic Tool given a Runtime.
-
projects.notebooksProjectsLocationsRuntimesGetIamPolicyGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
-
projects.notebooksProjectsLocationsRuntimesListLists Runtimes in a given project and location.
-
projects.notebooksProjectsLocationsRuntimesPatchUpdate Notebook Runtime configuration.
-
projects.notebooksProjectsLocationsRuntimesRefreshRuntimeTokenInternalGets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.
-
projects.notebooksProjectsLocationsRuntimesReportEventReport and process a runtime event.
-
projects.notebooksProjectsLocationsRuntimesResetResets a Managed Notebook Runtime.
-
projects.notebooksProjectsLocationsRuntimesSetIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND,INVALID_ARGUMENT, andPERMISSION_DENIEDerrors. -
projects.notebooksProjectsLocationsRuntimesStartStarts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See:
-
projects.notebooksProjectsLocationsRuntimesStopStops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See:
-
projects.notebooksProjectsLocationsRuntimesSwitchSwitch a Managed Notebook Runtime.
-
projects.notebooksProjectsLocationsRuntimesTestIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a
NOT_FOUNDerror. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. -
projects.notebooksProjectsLocationsRuntimesUpgradeUpgrades a Managed Notebook Runtime to the latest version.
-
projects.notebooksProjectsLocationsSchedulesCreateCreates a new Scheduled Notebook in a given project and location.
-
projects.notebooksProjectsLocationsSchedulesDeleteDeletes schedule and all underlying jobs
-
projects.notebooksProjectsLocationsSchedulesGetGets details of schedule
-
projects.notebooksProjectsLocationsSchedulesListLists schedules in a given project and location.
-
projects.notebooksProjectsLocationsSchedulesTriggerTriggers execution of an existing schedule.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools