Class ProjectsResource.LocationsResource.RuntimesResource

The "runtimes" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.RuntimesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.AIPlatformNotebooks.v1

Assembly: Google.Apis.AIPlatformNotebooks.v1.dll

Syntax

public class ProjectsResource.LocationsResource.RuntimesResource

Constructors

RuntimesResource(IClientService)

Constructs a new resource.

Declaration

public RuntimesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AIPlatformNotebooksSwitch(SwitchRuntimeRequest, string)

Switch a Managed Notebook Runtime.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.AIPlatformNotebooksSwitchRequest AIPlatformNotebooksSwitch(SwitchRuntimeRequest body, string name)

Parameters

Type	Name	Description
SwitchRuntimeRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.AIPlatformNotebooksSwitchRequest

Create(Runtime, string)

Creates a new Runtime in a given project and location.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.CreateRequest Create(Runtime body, string parent)

Parameters

Type	Name	Description
Runtime	body	The body of the request.
string	parent	Required. Format: parent=projects/{project_id}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.CreateRequest

Delete(string)

Deletes a single Runtime.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.DeleteRequest

Diagnose(DiagnoseRuntimeRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.DiagnoseRequest Diagnose(DiagnoseRuntimeRequest body, string name)

Parameters

Type	Name	Description
DiagnoseRuntimeRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtimes_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.DiagnoseRequest

Get(string)

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

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.GetRequest

GetIamPolicy(string)

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

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.GetIamPolicyRequest

List(string)

Lists Runtimes in a given project and location.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. Format: parent=projects/{project_id}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.ListRequest

Migrate(MigrateRuntimeRequest, string)

Migrate an existing Runtime to a new Workbench Instance.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.MigrateRequest Migrate(MigrateRuntimeRequest body, string name)

Parameters

Type	Name	Description
MigrateRuntimeRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.MigrateRequest

Patch(Runtime, string)

Update Notebook Runtime configuration.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.PatchRequest Patch(Runtime body, string name)

Parameters

Type	Name	Description
Runtime	body	The body of the request.
string	name	Output only. The resource name of the runtime. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.PatchRequest

RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.RefreshRuntimeTokenInternalRequest RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest body, string name)

Parameters

Type	Name	Description
RefreshRuntimeTokenInternalRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.RefreshRuntimeTokenInternalRequest

ReportEvent(ReportRuntimeEventRequest, string)

Reports and processes a runtime event.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.ReportEventRequest ReportEvent(ReportRuntimeEventRequest body, string name)

Parameters

Type	Name	Description
ReportRuntimeEventRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.ReportEventRequest

Reset(ResetRuntimeRequest, string)

Resets a Managed Notebook Runtime.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.ResetRequest Reset(ResetRuntimeRequest body, string name)

Parameters

Type	Name	Description
ResetRuntimeRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.ResetRequest

SetIamPolicy(SetIamPolicyRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.SetIamPolicyRequest

Start(StartRuntimeRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.StartRequest Start(StartRuntimeRequest body, string name)

Parameters

Type	Name	Description
StartRuntimeRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.StartRequest

Stop(StopRuntimeRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.StopRequest Stop(StopRuntimeRequest body, string name)

Parameters

Type	Name	Description
StopRuntimeRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.StopRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.TestIamPermissionsRequest

Upgrade(UpgradeRuntimeRequest, string)

Upgrades a Managed Notebook Runtime to the latest version.

Declaration

public virtual ProjectsResource.LocationsResource.RuntimesResource.UpgradeRequest Upgrade(UpgradeRuntimeRequest body, string name)

Parameters

Type	Name	Description
UpgradeRuntimeRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns

Type	Description
ProjectsResource.LocationsResource.RuntimesResource.UpgradeRequest