View Source API Reference google_api_notebooks v0.11.0
Modules
API client metadata for GoogleApi.Notebooks.V1.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.Notebooks.V1.
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.
Represents the metadata of the long-running operation.
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.
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-a100
Specifies 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.
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
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.
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
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.
API client metadata for GoogleApi.Notebooks.V2.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.Notebooks.V2.
An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check on type
and core_count
combinations. TPUs are not supported. See GPUs on Compute Engine to find a valid combination.
An access configuration attached to an instance's network interface.
Associates members
, or principals, with a role
.
The definition of a boot disk.
The request message for Operations.CancelOperation.
Response for checking if a notebook instance is upgradeable.
Response for getting WbI configurations in a location
Definition of a container image for starting a notebook instance with the environment installed in a container.
An instance-attached disk resource.
DefaultValues represents the default configuration values.
Request for creating a notebook instance diagnostic file.
Defines flags that are used to run the diagnostic tool
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); }
The definition of an Event for a managed / semi-managed notebook instance.
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.
A GPU driver configuration
The definition of how to configure a VM instance outside of Resources and Identity.
ConfigImage represents an image release available to create a WbI
The definition of a notebook instance.
Response for listing notebook instances.
The response message for Locations.ListLocations.
The response message for Operations.ListOperations.
A resource that represents a Google Cloud location.
The definition of a network interface resource attached to a VM.
This resource represents a long-running operation that is the result of a network API call.
Represents the metadata of the long-running operation.
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.
Request for notebook instances to report information to Notebooks API.
Request for resetting a notebook instance
Request for resizing the notebook instance disks
Request for rollbacking a notebook instance
A service account that acts as an identity.
Request message for SetIamPolicy
method.
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
Request for starting a notebook instance
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
SupportedValues represents the values supported by the configuration.
Request message for TestIamPermissions
method.
Response message for TestIamPermissions
method.
The entry of VM image upgrade history.
Request for upgrading a notebook instance
Request for upgrading a notebook instance from within the VM
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.