Projects - Documentation

Projects

google .cloud .compute .v1. Projects

Represents a Projects

Constructor

new Projects(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Projects service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

disableXpnHost(request, callback) → {undefined}

Calls DisableXpnHost.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDisableXpnHostProjectRequest	DisableXpnHostProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.DisableXpnHostCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

disableXpnHost(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls DisableXpnHost.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDisableXpnHostProjectRequest	DisableXpnHostProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

disableXpnResource(request, callback) → {undefined}

Calls DisableXpnResource.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDisableXpnResourceProjectRequest	DisableXpnResourceProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.DisableXpnResourceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

disableXpnResource(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls DisableXpnResource.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDisableXpnResourceProjectRequest	DisableXpnResourceProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

enableXpnHost(request, callback) → {undefined}

Calls EnableXpnHost.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IEnableXpnHostProjectRequest	EnableXpnHostProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.EnableXpnHostCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

enableXpnHost(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls EnableXpnHost.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IEnableXpnHostProjectRequest	EnableXpnHostProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

enableXpnResource(request, callback) → {undefined}

Calls EnableXpnResource.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IEnableXpnResourceProjectRequest	EnableXpnResourceProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.EnableXpnResourceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

enableXpnResource(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls EnableXpnResource.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IEnableXpnResourceProjectRequest	EnableXpnResourceProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

get(request, callback) → {undefined}

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetProjectRequest	GetProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.GetCallback	Node-style callback called with the error, if any, and Project

Returns:

Type	Description
undefined

get(request) → {Promise.<google.cloud.compute.v1.Project>}

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetProjectRequest	GetProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Project>	Promise

getXpnHost(request, callback) → {undefined}

Calls GetXpnHost.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetXpnHostProjectRequest	GetXpnHostProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.GetXpnHostCallback	Node-style callback called with the error, if any, and Project

Returns:

Type	Description
undefined

getXpnHost(request) → {Promise.<google.cloud.compute.v1.Project>}

Calls GetXpnHost.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetXpnHostProjectRequest	GetXpnHostProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Project>	Promise

getXpnResources(request, callback) → {undefined}

Calls GetXpnResources.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetXpnResourcesProjectsRequest	GetXpnResourcesProjectsRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.GetXpnResourcesCallback	Node-style callback called with the error, if any, and ProjectsGetXpnResources

Returns:

Type	Description
undefined

getXpnResources(request) → {Promise.<google.cloud.compute.v1.ProjectsGetXpnResources>}

Calls GetXpnResources.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetXpnResourcesProjectsRequest	GetXpnResourcesProjectsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.ProjectsGetXpnResources>	Promise

listXpnHosts(request, callback) → {undefined}

Calls ListXpnHosts.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListXpnHostsProjectsRequest	ListXpnHostsProjectsRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.ListXpnHostsCallback	Node-style callback called with the error, if any, and XpnHostList

Returns:

Type	Description
undefined

listXpnHosts(request) → {Promise.<google.cloud.compute.v1.XpnHostList>}

Calls ListXpnHosts.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListXpnHostsProjectsRequest	ListXpnHostsProjectsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.XpnHostList>	Promise

moveDisk(request, callback) → {undefined}

Calls MoveDisk.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IMoveDiskProjectRequest	MoveDiskProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.MoveDiskCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

moveDisk(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls MoveDisk.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IMoveDiskProjectRequest	MoveDiskProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

moveInstance(request, callback) → {undefined}

Calls MoveInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IMoveInstanceProjectRequest	MoveInstanceProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.MoveInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

moveInstance(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls MoveInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IMoveInstanceProjectRequest	MoveInstanceProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

setCommonInstanceMetadata(request, callback) → {undefined}

Calls SetCommonInstanceMetadata.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetCommonInstanceMetadataProjectRequest	SetCommonInstanceMetadataProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.SetCommonInstanceMetadataCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setCommonInstanceMetadata(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls SetCommonInstanceMetadata.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetCommonInstanceMetadataProjectRequest	SetCommonInstanceMetadataProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

setDefaultNetworkTier(request, callback) → {undefined}

Calls SetDefaultNetworkTier.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetDefaultNetworkTierProjectRequest	SetDefaultNetworkTierProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.SetDefaultNetworkTierCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setDefaultNetworkTier(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls SetDefaultNetworkTier.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetDefaultNetworkTierProjectRequest	SetDefaultNetworkTierProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

setUsageExportBucket(request, callback) → {undefined}

Calls SetUsageExportBucket.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetUsageExportBucketProjectRequest	SetUsageExportBucketProjectRequest message or plain object
`callback`	google.cloud.compute.v1.Projects.SetUsageExportBucketCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setUsageExportBucket(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls SetUsageExportBucket.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetUsageExportBucketProjectRequest	SetUsageExportBucketProjectRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Projects}

Creates new Projects service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
Projects	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

DisableXpnHostCallback(error, responseopt)

Callback as used by disableXpnHost.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

DisableXpnResourceCallback(error, responseopt)

Callback as used by disableXpnResource.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

EnableXpnHostCallback(error, responseopt)

Callback as used by enableXpnHost.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

EnableXpnResourceCallback(error, responseopt)

Callback as used by enableXpnResource.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

GetCallback(error, responseopt)

Callback as used by get.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Project	<optional>	Project

GetXpnHostCallback(error, responseopt)

Callback as used by getXpnHost.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Project	<optional>	Project

GetXpnResourcesCallback(error, responseopt)

Callback as used by getXpnResources.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.ProjectsGetXpnResources	<optional>	ProjectsGetXpnResources

ListXpnHostsCallback(error, responseopt)

Callback as used by listXpnHosts.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.XpnHostList	<optional>	XpnHostList

MoveDiskCallback(error, responseopt)

Callback as used by moveDisk.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

MoveInstanceCallback(error, responseopt)

Callback as used by moveInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

SetCommonInstanceMetadataCallback(error, responseopt)

Callback as used by setCommonInstanceMetadata.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

SetDefaultNetworkTierCallback(error, responseopt)

Callback as used by setDefaultNetworkTier.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

SetUsageExportBucketCallback(error, responseopt)

Callback as used by setUsageExportBucket.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation