class ProjectsLocationsRuntimes extends Resource (View source)

The "runtimes" collection of methods.

Typical usage is:

 $notebooksService = new Google\Service\AIPlatformNotebooks(...);
 $runtimes = $notebooksService->projects_locations_runtimes;

Methods

create(string $parent, Runtime $postBody, array $optParams = [])

Creates a new Runtime in a given project and location. (runtimes.create)

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

Deletes a single Runtime. (runtimes.delete)

diagnose(string $name, DiagnoseRuntimeRequest $postBody, array $optParams = [])

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

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

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal. (runtimes.get)

getIamPolicy(string $resource, array $optParams = [])

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

listProjectsLocationsRuntimes(string $parent, array $optParams = [])

Lists Runtimes in a given project and location.

patch(string $name, Runtime $postBody, array $optParams = [])

Update Notebook Runtime configuration. (runtimes.patch)

refreshRuntimeTokenInternal(string $name, RefreshRuntimeTokenInternalRequest $postBody, array $optParams = [])

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

reportEvent(string $name, ReportRuntimeEventRequest $postBody, array $optParams = [])

Report and process a runtime event. (runtimes.reportEvent)

reset(string $name, ResetRuntimeRequest $postBody, array $optParams = [])

Resets a Managed Notebook Runtime. (runtimes.reset)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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

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

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 (runtimes.start)

stop(string $name, StopRuntimeRequest $postBody, array $optParams = [])

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 (runtimes.stop)

switchProjectsLocationsRuntimes(string $name, SwitchRuntimeRequest $postBody, array $optParams = [])

Switch a Managed Notebook Runtime. (runtimes.switchProjectsLocationsRuntimes)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

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

Upgrades a Managed Notebook Runtime to the latest version. (runtimes.upgrade)

Details

Operation create(string $parent, Runtime $postBody, array $optParams = [])

Creates a new Runtime in a given project and location. (runtimes.create)

Parameters

string $parent

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

Runtime $postBody
array $optParams

Optional parameters.

Return Value

Operation

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

Deletes a single Runtime. (runtimes.delete)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

Operation

Operation diagnose(string $name, DiagnoseRuntimeRequest $postBody, array $optParams = [])

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

(runtimes.diagnose)

Parameters

string $name

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

DiagnoseRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

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

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal. (runtimes.get)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

Runtime

Policy getIamPolicy(string $resource, array $optParams = [])

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

Parameters

string $resource

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

array $optParams

Optional parameters.

Return Value

Policy

ListRuntimesResponse listProjectsLocationsRuntimes(string $parent, array $optParams = [])

Lists Runtimes in a given project and location.

(runtimes.listProjectsLocationsRuntimes)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

ListRuntimesResponse

Operation patch(string $name, Runtime $postBody, array $optParams = [])

Update Notebook Runtime configuration. (runtimes.patch)

Parameters

string $name

Output only. The resource name of the runtime. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}

Runtime $postBody
array $optParams

Optional parameters.

Return Value

Operation

RefreshRuntimeTokenInternalResponse refreshRuntimeTokenInternal(string $name, RefreshRuntimeTokenInternalRequest $postBody, array $optParams = [])

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

(runtimes.refreshRuntimeTokenInternal)

Parameters

string $name

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

RefreshRuntimeTokenInternalRequest $postBody
array $optParams

Optional parameters.

Return Value

RefreshRuntimeTokenInternalResponse

Operation reportEvent(string $name, ReportRuntimeEventRequest $postBody, array $optParams = [])

Report and process a runtime event. (runtimes.reportEvent)

Parameters

string $name

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

ReportRuntimeEventRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Operation reset(string $name, ResetRuntimeRequest $postBody, array $optParams = [])

Resets a Managed Notebook Runtime. (runtimes.reset)

Parameters

string $name

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

ResetRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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

Parameters

string $resource

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

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Operation start(string $name, StartRuntimeRequest $postBody, array $optParams = [])

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 (runtimes.start)

Parameters

string $name

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

StartRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Operation stop(string $name, StopRuntimeRequest $postBody, array $optParams = [])

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 (runtimes.stop)

Parameters

string $name

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

StopRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Operation switchProjectsLocationsRuntimes(string $name, SwitchRuntimeRequest $postBody, array $optParams = [])

Switch a Managed Notebook Runtime. (runtimes.switchProjectsLocationsRuntimes)

Parameters

string $name

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

SwitchRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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. (runtimes.testIamPermissions)

Parameters

string $resource

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

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Operation upgrade(string $name, UpgradeRuntimeRequest $postBody, array $optParams = [])

Upgrades a Managed Notebook Runtime to the latest version. (runtimes.upgrade)

Parameters

string $name

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

UpgradeRuntimeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation