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

Assembly: Google.Apis.AIPlatformNotebooks.v1.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

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

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

GetInstanceHealth(string)

Checks whether a notebook instance is healthy.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.GetInstanceHealthRequest GetInstanceHealth(string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.GetInstanceHealthRequest

IsUpgradeable(string)

Checks whether a notebook instance is upgradable.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.IsUpgradeableRequest IsUpgradeable(string notebookInstance)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.IsUpgradeableRequest

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

Migrate(MigrateInstanceRequest, string)

Migrates an existing User-Managed Notebook to Workbench Instances.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.MigrateRequest Migrate(MigrateInstanceRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.MigrateRequest

Register(RegisterInstanceRequest, string)

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.RegisterRequest Register(RegisterInstanceRequest body, string parent)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.RegisterRequest

Report(ReportInstanceInfoRequest, 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.ReportRequest Report(ReportInstanceInfoRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ReportRequest

ReportEvent(ReportInstanceEventRequest, string)

Reports and processes an instance event.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ReportEventRequest ReportEvent(ReportInstanceEventRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ReportEventRequest

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

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

SetAccelerator(SetInstanceAcceleratorRequest, string)

Updates the guest accelerators of a single Instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.SetAcceleratorRequest SetAccelerator(SetInstanceAcceleratorRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.SetAcceleratorRequest

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

SetLabels(SetInstanceLabelsRequest, string)

Replaces all the labels of an Instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.SetLabelsRequest SetLabels(SetInstanceLabelsRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.SetLabelsRequest

SetMachineType(SetInstanceMachineTypeRequest, string)

Updates the machine type of a single Instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.SetMachineTypeRequest SetMachineType(SetInstanceMachineTypeRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.SetMachineTypeRequest

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

UpdateConfig(UpdateInstanceConfigRequest, string)

Update Notebook Instance configurations.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.UpdateConfigRequest UpdateConfig(UpdateInstanceConfigRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.UpdateConfigRequest

UpdateMetadataItems(UpdateInstanceMetadataItemsRequest, string)

Add/update metadata items for an instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.UpdateMetadataItemsRequest UpdateMetadataItems(UpdateInstanceMetadataItemsRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.UpdateMetadataItemsRequest

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, string)

Updates the Shielded instance configuration of a single Instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.UpdateShieldedInstanceConfigRequest UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.UpdateShieldedInstanceConfigRequest

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

UpgradeInternal(UpgradeInstanceInternalRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.UpgradeInternalRequest UpgradeInternal(UpgradeInstanceInternalRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.UpgradeInternalRequest