Namespace Google.Apis.AIPlatformNotebooks.v1
Classes
AIPlatformNotebooksBaseServiceRequest<TResponse>
A base abstract class for AIPlatformNotebooks requests.
AIPlatformNotebooksService
The AIPlatformNotebooks Service.
AIPlatformNotebooksService.Scope
Available OAuth 2.0 scopes for use with the Notebooks API.
AIPlatformNotebooksService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Notebooks API.
ProjectsResource
The "projects" collection of methods.
ProjectsResource.LocationsResource
The "locations" collection of methods.
ProjectsResource.LocationsResource.EnvironmentsResource
The "environments" collection of methods.
ProjectsResource.LocationsResource.EnvironmentsResource.CreateRequest
Creates a new Environment.
ProjectsResource.LocationsResource.EnvironmentsResource.DeleteRequest
Deletes a single Environment.
ProjectsResource.LocationsResource.EnvironmentsResource.GetRequest
Gets details of a single Environment.
ProjectsResource.LocationsResource.EnvironmentsResource.ListRequest
Lists environments in a project.
ProjectsResource.LocationsResource.ExecutionsResource
The "executions" collection of methods.
ProjectsResource.LocationsResource.ExecutionsResource.CreateRequest
Creates a new Execution in a given project and location.
ProjectsResource.LocationsResource.ExecutionsResource.DeleteRequest
Deletes execution
ProjectsResource.LocationsResource.ExecutionsResource.GetRequest
Gets details of executions
ProjectsResource.LocationsResource.ExecutionsResource.ListRequest
Lists executions in a given project and location
ProjectsResource.LocationsResource.GetRequest
Gets information about a location.
ProjectsResource.LocationsResource.InstancesResource
The "instances" collection of methods.
ProjectsResource.LocationsResource.InstancesResource.CreateRequest
Creates a new Instance in a given project and location.
ProjectsResource.LocationsResource.InstancesResource.DeleteRequest
Deletes a single Instance.
ProjectsResource.LocationsResource.InstancesResource.DiagnoseRequest
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
ProjectsResource.LocationsResource.InstancesResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.LocationsResource.InstancesResource.GetInstanceHealthRequest
Checks whether a notebook instance is healthy.
ProjectsResource.LocationsResource.InstancesResource.GetRequest
Gets details of a single Instance.
ProjectsResource.LocationsResource.InstancesResource.IsUpgradeableRequest
Checks whether a notebook instance is upgradable.
ProjectsResource.LocationsResource.InstancesResource.ListRequest
Lists instances in a given project and location.
ProjectsResource.LocationsResource.InstancesResource.MigrateRequest
Migrates an existing User-Managed Notebook to Workbench Instances.
ProjectsResource.LocationsResource.InstancesResource.RegisterRequest
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.
ProjectsResource.LocationsResource.InstancesResource.ReportEventRequest
Reports and processes an instance event.
ProjectsResource.LocationsResource.InstancesResource.ReportRequest
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.
ProjectsResource.LocationsResource.InstancesResource.ResetRequest
Resets a notebook instance.
ProjectsResource.LocationsResource.InstancesResource.RollbackRequest
Rollbacks a notebook instance to the previous version.
ProjectsResource.LocationsResource.InstancesResource.SetAcceleratorRequest
Updates the guest accelerators of a single Instance.
ProjectsResource.LocationsResource.InstancesResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
ProjectsResource.LocationsResource.InstancesResource.SetLabelsRequest
Replaces all the labels of an Instance.
ProjectsResource.LocationsResource.InstancesResource.SetMachineTypeRequest
Updates the machine type of a single Instance.
ProjectsResource.LocationsResource.InstancesResource.StartRequest
Starts a notebook instance.
ProjectsResource.LocationsResource.InstancesResource.StopRequest
Stops a notebook instance.
ProjectsResource.LocationsResource.InstancesResource.TestIamPermissionsRequest
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.
ProjectsResource.LocationsResource.InstancesResource.UpdateConfigRequest
Update Notebook Instance configurations.
ProjectsResource.LocationsResource.InstancesResource.UpdateMetadataItemsRequest
Add/update metadata items for an instance.
ProjectsResource.LocationsResource.InstancesResource.UpdateShieldedInstanceConfigRequest
Updates the Shielded instance configuration of a single Instance.
ProjectsResource.LocationsResource.InstancesResource.UpgradeInternalRequest
Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
ProjectsResource.LocationsResource.InstancesResource.UpgradeRequest
Upgrades a notebook instance to the latest version.
ProjectsResource.LocationsResource.ListRequest
Lists information about the supported locations for this service.
ProjectsResource.LocationsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.OperationsResource.CancelRequest
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
.
ProjectsResource.LocationsResource.OperationsResource.DeleteRequest
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
.
ProjectsResource.LocationsResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support this
method, it returns UNIMPLEMENTED
.
ProjectsResource.LocationsResource.RuntimesResource
The "runtimes" collection of methods.
ProjectsResource.LocationsResource.RuntimesResource.AIPlatformNotebooksSwitchRequest
Switch a Managed Notebook Runtime.
ProjectsResource.LocationsResource.RuntimesResource.CreateRequest
Creates a new Runtime in a given project and location.
ProjectsResource.LocationsResource.RuntimesResource.DeleteRequest
Deletes a single Runtime.
ProjectsResource.LocationsResource.RuntimesResource.DiagnoseRequest
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
ProjectsResource.LocationsResource.RuntimesResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.LocationsResource.RuntimesResource.GetRequest
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
ProjectsResource.LocationsResource.RuntimesResource.ListRequest
Lists Runtimes in a given project and location.
ProjectsResource.LocationsResource.RuntimesResource.MigrateRequest
Migrate an existing Runtime to a new Workbench Instance.
ProjectsResource.LocationsResource.RuntimesResource.PatchRequest
Update Notebook Runtime configuration.
ProjectsResource.LocationsResource.RuntimesResource.RefreshRuntimeTokenInternalRequest
Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.
ProjectsResource.LocationsResource.RuntimesResource.ReportEventRequest
Reports and processes a runtime event.
ProjectsResource.LocationsResource.RuntimesResource.ResetRequest
Resets a Managed Notebook Runtime.
ProjectsResource.LocationsResource.RuntimesResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
ProjectsResource.LocationsResource.RuntimesResource.StartRequest
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
ProjectsResource.LocationsResource.RuntimesResource.StopRequest
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
ProjectsResource.LocationsResource.RuntimesResource.TestIamPermissionsRequest
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.
ProjectsResource.LocationsResource.RuntimesResource.UpgradeRequest
Upgrades a Managed Notebook Runtime to the latest version.
ProjectsResource.LocationsResource.SchedulesResource
The "schedules" collection of methods.
ProjectsResource.LocationsResource.SchedulesResource.CreateRequest
Creates a new Scheduled Notebook in a given project and location.
ProjectsResource.LocationsResource.SchedulesResource.DeleteRequest
Deletes schedule and all underlying jobs
ProjectsResource.LocationsResource.SchedulesResource.GetRequest
Gets details of schedule
ProjectsResource.LocationsResource.SchedulesResource.ListRequest
Lists schedules in a given project and location.
ProjectsResource.LocationsResource.SchedulesResource.TriggerRequest
Triggers execution of an existing schedule.
Enums
AIPlatformNotebooksBaseServiceRequest<TResponse>.AltEnum
Data format for response.
AIPlatformNotebooksBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.
ProjectsResource.LocationsResource.InstancesResource.IsUpgradeableRequest.TypeEnum
Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.