Central instance to access all AIPlatformNotebooks related resource activities
Definition of a hardware accelerator. Note that not all combinations of
type and
core_count are valid. See
GPUs on Compute Engine to find a valid combination. TPUs are not supported.
Associates members, or principals, with a role.
Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
The request message for Operations.CancelOperation.
Definition of a container image for starting a notebook instance with the environment installed in a container.
Parameters used in Dataproc JobType executions.
Request for creating a notebook instance diagnostic file.
Request for creating a notebook instance diagnostic file.
Defines flags that are used to run the diagnostic tool
An instance-attached disk resource.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
Definition of a software environment that is used to start a notebook instance.
The definition of an Event for a managed / semi-managed notebook instance.
The definition of a single executed notebook.
The description a notebook execution workload.
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100” Example (Equality): title: “Requestor is owner” description: “Determines if requestor is the document owner” expression: “document.owner == request.auth.claims.email” Example (Logic): title: “Public documents” description: “Determine whether the document should be publicly visible” expression: “document.type != ‘private’ && document.type != ‘internal’” Example (Data Manipulation): title: “Notification string” description: “Create a notification string with a timestamp.” expression: “’New message received at ’ + string(document.create_time)” The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Response for checking if a notebook instance is healthy.
Guest OS features for boot disk.
The definition of a notebook instance.
Notebook instance configurations that can be updated.
InstanceMigrationEligibility represents the feasibility information of a migration from UmN to WbI.
Response for checking if a notebook instance is upgradeable.
Response for listing environments.
Response for listing scheduled notebook executions
Response for listing notebook instances.
The response message for Locations.ListLocations.
The response message for Operations.ListOperations.
Response for listing Managed Notebook Runtimes.
Response for listing scheduled notebook job.
A Local attached disk resource.
Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both.
A resource that represents a Google Cloud location.
Request for migrating a User-Managed Notebook to Workbench Instances.
Request for migrating a Runtime to a Workbench Instance.
This resource represents a long-running operation that is the result of a network API call.
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A
Policy is a collection of
bindings. A
binding binds one or more
members, or principals, to a single
role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A
role is a named list of permissions; each
role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a
binding can also specify a
condition, which is a logical expression that allows access to a resource only if the expression evaluates to
true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the
IAM documentation.
JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the
IAM documentation.
Creates a new Environment.
Deletes a single Environment.
Gets details of a single Environment.
Lists environments in a project.
Creates a new Execution in a given project and location.
Deletes execution
Gets details of executions
Lists executions in a given project and location
Gets information about a location.
Creates a new Instance in a given project and location.
Deletes a single Instance.
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Gets details of a single Instance.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Checks whether a notebook instance is healthy.
Checks whether a notebook instance is upgradable.
Lists instances in a given project and location.
Migrates an existing User-Managed Notebook to Workbench Instances.
Registers 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.
Allows 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.
Reports and processes an instance event.
Resets a notebook instance.
Rollbacks a notebook instance to the previous version.
Updates the guest accelerators of a single Instance.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Replaces all the labels of an Instance.
Updates the machine type of a single Instance.
Starts a notebook instance.
Stops a notebook instance.
Returns 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_FOUND error. 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.
Update Notebook Instance configurations.
Add/update metadata items for an instance.
Updates the Shielded instance configuration of a single Instance.
Upgrades a notebook instance to the latest version.
Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
Lists information about the supported locations for this service.
Starts 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 to Code.CANCELLED.
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
Creates a new Runtime in a given project and location.
Deletes a single Runtime.
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists Runtimes in a given project and location.
Migrate an existing Runtime to a new Workbench Instance.
Update Notebook Runtime configuration.
Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.
Reports and processes a runtime event.
Resets a Managed Notebook Runtime.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Starts a Managed Notebook Runtime. Perform “Start” on GPU instances; “Resume” on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
Stops a Managed Notebook Runtime. Perform “Stop” on GPU instances; “Suspend” on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
Switch a Managed Notebook Runtime.
Returns 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_FOUND error. 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.
Upgrades a Managed Notebook Runtime to the latest version.
Creates a new Scheduled Notebook in a given project and location.
Deletes schedule and all underlying jobs
Gets details of schedule
Lists schedules in a given project and location.
Triggers execution of an existing schedule.
A builder providing access to all methods supported on
project resources.
It is not used directly, but through the
AIPlatformNotebooks hub.
Request for getting a new access token.
Response with a new access token.
Request for registering a notebook instance.
Request for reporting a Managed Notebook Event.
Request for notebook instances to report information to Notebooks API.
Request for reporting a Managed Notebook Event.
Reservation Affinity for consuming Zonal reservation.
Request for resetting a notebook instance
Request for resetting a Managed Notebook Runtime.
Request for rollbacking a notebook instance
The definition of a Runtime for a managed notebook instance.
Definition of the types of hardware accelerators that can be used. See
Compute Engine AcceleratorTypes. Examples: *
nvidia-tesla-k80 *
nvidia-tesla-p100 *
nvidia-tesla-v100 *
nvidia-tesla-p4 *
nvidia-tesla-t4 *
nvidia-tesla-a100Specifies the login configuration for Runtime
Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read
Enabling guest operating system features to see a list of available options. Guest OS features for boot disk.
Contains runtime daemon metrics, such as OS and kernels and sessions stats.
RuntimeMigrationEligibility represents the feasibility information of a migration from GmN to WbI.
Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in key:value format, for example: * idle_shutdown: true * idle_shutdown_timeout: 180 * enable_health_monitoring: true
The definition of a schedule.
Definition of a hardware accelerator. Note that not all combinations of
type and
core_count are valid. See
GPUs on Compute Engine to find a valid combination. TPUs are not supported.
Request message for SetIamPolicy method.
Request for setting instance accelerator.
Request for setting instance labels.
Request for setting instance machine type.
Request for starting a notebook instance
Request for starting a Managed Notebook Runtime.
The
Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by
gRPC. Each
Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the
API Design Guide.
Request for stopping a notebook instance
Request for stopping a Managed Notebook Runtime.
Request for switching a Managed Notebook Runtime.
Request message for TestIamPermissions method.
Response message for TestIamPermissions method.
Request for created scheduled notebooks
Request for updating instance configurations.
Request for adding/changing metadata items for an instance.
Response for adding/changing metadata items for an instance.
Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance
The entry of VM image upgrade history.
Request for upgrading a notebook instance from within the VM
Request for upgrading a notebook instance
Request for upgrading a Managed Notebook Runtime to the latest version. option (google.api.message_visibility).restriction = “TRUSTED_TESTER,SPECIAL_TESTER”;
Parameters used in Vertex AI JobType executions.
Runtime using Virtual Machine for computing.
The config settings for virtual machine.
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.