1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Aiplatform
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsNotebookRuntimes

ProjectsLocationsNotebookRuntimes

class ProjectsLocationsNotebookRuntimes extends Resource (View source)

The "notebookRuntimes" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $notebookRuntimes = $aiplatformService->projects_locations_notebookRuntimes;

Methods

GoogleLongrunningOperation
assign(string $parent, GoogleCloudAiplatformV1AssignNotebookRuntimeRequest $postBody, array $optParams = [])

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes a NotebookRuntime. (notebookRuntimes.delete)

GoogleCloudAiplatformV1NotebookRuntime
get(string $name, array $optParams = [])

Gets a NotebookRuntime. (notebookRuntimes.get)

GoogleCloudAiplatformV1ListNotebookRuntimesResponse
listProjectsLocationsNotebookRuntimes(string $parent, array $optParams = [])

Lists NotebookRuntimes in a Location.

GoogleLongrunningOperation
start(string $name, GoogleCloudAiplatformV1StartNotebookRuntimeRequest $postBody, array $optParams = [])

Starts a NotebookRuntime. (notebookRuntimes.start)

GoogleLongrunningOperation
upgrade(string $name, GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest $postBody, array $optParams = [])

Upgrades a NotebookRuntime. (notebookRuntimes.upgrade)

Details

at line 49
GoogleLongrunningOperation assign(string $parent, GoogleCloudAiplatformV1AssignNotebookRuntimeRequest $postBody, array $optParams = [])

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

(notebookRuntimes.assign)

Parameters

string $parent

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location}
GoogleCloudAiplatformV1AssignNotebookRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 66
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a NotebookRuntime. (notebookRuntimes.delete)

Parameters

string $name

Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 83
GoogleCloudAiplatformV1NotebookRuntime get(string $name, array $optParams = [])

Gets a NotebookRuntime. (notebookRuntimes.get)

Parameters

string $name

Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1NotebookRuntime

Exceptions

Exception

at line 133
GoogleCloudAiplatformV1ListNotebookRuntimesResponse listProjectsLocationsNotebookRuntimes(string $parent, array $optParams = [])

Lists NotebookRuntimes in a Location.

(notebookRuntimes.listProjectsLocationsNotebookRuntimes)

Parameters

string $parent

Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListNotebookRuntimesResponse

Exceptions

Exception

at line 151
GoogleLongrunningOperation start(string $name, GoogleCloudAiplatformV1StartNotebookRuntimeRequest $postBody, array $optParams = [])

Starts a NotebookRuntime. (notebookRuntimes.start)

Parameters

string $name

Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
GoogleCloudAiplatformV1StartNotebookRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 169
GoogleLongrunningOperation upgrade(string $name, GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest $postBody, array $optParams = [])

Upgrades a NotebookRuntime. (notebookRuntimes.upgrade)

Parameters

string $name

Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception