Notebooks

import { Notebooks } from "https://googleapis.deno.dev/v1/notebooks:v2.ts";

Notebooks API is used to manage notebook resources in Google Cloud.

class Notebooks {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsInstancesCheckUpgradability(notebookInstance: string): Promise<CheckInstanceUpgradabilityResponse>;

async projectsLocationsInstancesCreate(

parent: string,

req: Instance,

opts?: ProjectsLocationsInstancesCreateOptions,

): Promise<Operation>;

async projectsLocationsInstancesDelete(name: string, opts?: ProjectsLocationsInstancesDeleteOptions): Promise<Operation>;

async projectsLocationsInstancesDiagnose(name: string, req: DiagnoseInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesGet(name: string): Promise<Instance>;

async projectsLocationsInstancesGetConfig(name: string): Promise<Config>;

async projectsLocationsInstancesGetIamPolicy(resource: string, opts?: ProjectsLocationsInstancesGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListInstancesResponse>;

async projectsLocationsInstancesPatch(

name: string,

req: Instance,

opts?: ProjectsLocationsInstancesPatchOptions,

): Promise<Operation>;

async projectsLocationsInstancesReportInfoSystem(name: string, req: ReportInstanceInfoSystemRequest): Promise<Operation>;

async projectsLocationsInstancesReset(name: string, req: ResetInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesResizeDisk(notebookInstance: string, req: ResizeDiskRequest): Promise<Operation>;

async projectsLocationsInstancesRollback(name: string, req: RollbackInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsInstancesStart(name: string, req: StartInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesStop(name: string, req: StopInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsInstancesUpgrade(name: string, req: UpgradeInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesUpgradeSystem(name: string, req: UpgradeInstanceSystemRequest): Promise<Operation>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

}

§Constructors

new Notebooks(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsInstancesCheckUpgradability(notebookInstance: string): Promise<CheckInstanceUpgradabilityResponse>

[src]

Checks whether a notebook instance is upgradable.

@param notebookInstance

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesCreate(parent: string, req: Instance, opts?: ProjectsLocationsInstancesCreateOptions): Promise<Operation>

[src]

Creates a new Instance in a given project and location.

@param parent

Required. Format: parent=projects/{project_id}/locations/{location}

projectsLocationsInstancesDelete(name: string, opts?: ProjectsLocationsInstancesDeleteOptions): Promise<Operation>

[src]

Deletes a single Instance.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesDiagnose(name: string, req: DiagnoseInstanceRequest): Promise<Operation>

[src]

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesGet(name: string): Promise<Instance>

[src]

Gets details of a single Instance.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesGetConfig(name: string): Promise<Config>

[src]

Gets general backend configurations that might also affect the frontend. Location is required by CCFE. Although we could bypass it to send location- less request directly to the backend job, we would need CPE (go/cloud-cpe). Having the location might also be useful depending on the query.

@param name

Required. Format: projects/{project_id}/locations/{location}

projectsLocationsInstancesGetIamPolicy(resource: string, opts?: ProjectsLocationsInstancesGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListInstancesResponse>

[src]

Lists instances in a given project and location.

@param parent

Required. Format: parent=projects/{project_id}/locations/{location}

projectsLocationsInstancesPatch(name: string, req: Instance, opts?: ProjectsLocationsInstancesPatchOptions): Promise<Operation>

[src]

UpdateInstance updates an Instance.

@param name

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesReportInfoSystem(name: string, req: ReportInstanceInfoSystemRequest): Promise<Operation>

[src]

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.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesReset(name: string, req: ResetInstanceRequest): Promise<Operation>

[src]

Resets a notebook instance.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesResizeDisk(notebookInstance: string, req: ResizeDiskRequest): Promise<Operation>

[src]

Resize a notebook instance disk to a higher capacity.

@param notebookInstance

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesRollback(name: string, req: RollbackInstanceRequest): Promise<Operation>

[src]

Rollbacks a notebook instance to the previous version.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsInstancesStart(name: string, req: StartInstanceRequest): Promise<Operation>

[src]

Starts a notebook instance.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesStop(name: string, req: StopInstanceRequest): Promise<Operation>

[src]

Stops a notebook instance.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

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.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsInstancesUpgrade(name: string, req: UpgradeInstanceRequest): Promise<Operation>

[src]

Upgrades a notebook instance to the latest version.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesUpgradeSystem(name: string, req: UpgradeInstanceSystemRequest): Promise<Operation>

[src]

Allows notebook instances to upgrade themselves. Do not use this method directly.

@param name

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.