Class ProjectsResource.LocationsResource.InstancesResource

The "instances" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.InstancesResource

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.v2

Assembly: Google.Apis.AIPlatformNotebooks.v2.dll

Syntax

public class ProjectsResource.LocationsResource.InstancesResource

Constructors

InstancesResource(IClientService)

Constructs a new resource.

Declaration

public InstancesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

CheckUpgradability(string)

Checks whether a notebook instance is upgradable.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.CheckUpgradabilityRequest CheckUpgradability(string notebookInstance)

Parameters

Type	Name	Description
string	notebookInstance	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.CheckUpgradabilityRequest

Create(Instance, string)

Creates a new Instance in a given project and location.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.CreateRequest Create(Instance body, string parent)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.CreateRequest

Delete(string)

Deletes a single Instance.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.DeleteRequest

Diagnose(DiagnoseInstanceRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.DiagnoseRequest Diagnose(DiagnoseInstanceRequest body, string name)

Parameters

Type	Name	Description
DiagnoseInstanceRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.DiagnoseRequest

Get(string)

Gets details of a single Instance.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.GetRequest

GetConfig(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.GetConfigRequest GetConfig(string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.GetConfigRequest

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.InstancesResource.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.InstancesResource.GetIamPolicyRequest

List(string)

Lists instances in a given project and location.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ListRequest

Patch(Instance, string)

UpdateInstance updates an Instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.PatchRequest Patch(Instance body, string name)

Parameters

Type	Name	Description
Instance	body	The body of the request.
string	name	Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.PatchRequest

ReportInfoSystem(ReportInstanceInfoSystemRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ReportInfoSystemRequest ReportInfoSystem(ReportInstanceInfoSystemRequest body, string name)

Parameters

Type	Name	Description
ReportInstanceInfoSystemRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ReportInfoSystemRequest

Reset(ResetInstanceRequest, string)

Resets a notebook instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ResetRequest Reset(ResetInstanceRequest body, string name)

Parameters

Type	Name	Description
ResetInstanceRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ResetRequest

ResizeDisk(ResizeDiskRequest, string)

Resize a notebook instance disk to a higher capacity.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ResizeDiskRequest ResizeDisk(ResizeDiskRequest body, string notebookInstance)

Parameters

Type	Name	Description
ResizeDiskRequest	body	The body of the request.
string	notebookInstance	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ResizeDiskRequest

Restore(RestoreInstanceRequest, string)

RestoreInstance restores an Instance from a BackupSource.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.RestoreRequest Restore(RestoreInstanceRequest body, string name)

Parameters

Type	Name	Description
RestoreInstanceRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.RestoreRequest

Rollback(RollbackInstanceRequest, string)

Rollbacks a notebook instance to the previous version.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.RollbackRequest Rollback(RollbackInstanceRequest body, string name)

Parameters

Type	Name	Description
RollbackInstanceRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.RollbackRequest

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.InstancesResource.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.InstancesResource.SetIamPolicyRequest

Start(StartInstanceRequest, string)

Starts a notebook instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.StartRequest Start(StartInstanceRequest body, string name)

Parameters

Type	Name	Description
StartInstanceRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.StartRequest

Stop(StopInstanceRequest, string)

Stops a notebook instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.StopRequest Stop(StopInstanceRequest body, string name)

Parameters

Type	Name	Description
StopInstanceRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.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.InstancesResource.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.InstancesResource.TestIamPermissionsRequest

Upgrade(UpgradeInstanceRequest, string)

Upgrades a notebook instance to the latest version.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.UpgradeRequest Upgrade(UpgradeInstanceRequest body, string name)

Parameters

Type	Name	Description
UpgradeInstanceRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.UpgradeRequest

UpgradeSystem(UpgradeInstanceSystemRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.UpgradeSystemRequest UpgradeSystem(UpgradeInstanceSystemRequest body, string name)

Parameters

Type	Name	Description
UpgradeInstanceSystemRequest	body	The body of the request.
string	name	Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.UpgradeSystemRequest