Subnetworks

google .cloud .compute .v1. Subnetworks

Represents a Subnetworks

Constructor

new Subnetworks(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Subnetworks 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

aggregatedList(request, callback) → {undefined}

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListSubnetworksRequest	AggregatedListSubnetworksRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.AggregatedListCallback	Node-style callback called with the error, if any, and SubnetworkAggregatedList

Returns:

Type	Description
undefined

aggregatedList(request) → {Promise.<google.cloud.compute.v1.SubnetworkAggregatedList>}

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListSubnetworksRequest	AggregatedListSubnetworksRequest message or plain object

Returns:

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

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteSubnetworkRequest	DeleteSubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.DeleteCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteSubnetworkRequest	DeleteSubnetworkRequest message or plain object

Returns:

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

expandIpCidrRange(request, callback) → {undefined}

Calls ExpandIpCidrRange.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest	ExpandIpCidrRangeSubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.ExpandIpCidrRangeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls ExpandIpCidrRange.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest	ExpandIpCidrRangeSubnetworkRequest 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.IGetSubnetworkRequest	GetSubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.GetCallback	Node-style callback called with the error, if any, and Subnetwork

Returns:

Type	Description
undefined

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

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetSubnetworkRequest	GetSubnetworkRequest message or plain object

Returns:

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

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetIamPolicySubnetworkRequest	GetIamPolicySubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.GetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

getIamPolicy(request) → {Promise.<google.cloud.compute.v1.Policy>}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetIamPolicySubnetworkRequest	GetIamPolicySubnetworkRequest message or plain object

Returns:

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

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertSubnetworkRequest	InsertSubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.InsertCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertSubnetworkRequest	InsertSubnetworkRequest message or plain object

Returns:

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

list(request, callback) → {undefined}

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListSubnetworksRequest	ListSubnetworksRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.ListCallback	Node-style callback called with the error, if any, and SubnetworkList

Returns:

Type	Description
undefined

list(request) → {Promise.<google.cloud.compute.v1.SubnetworkList>}

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListSubnetworksRequest	ListSubnetworksRequest message or plain object

Returns:

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

listUsable(request, callback) → {undefined}

Calls ListUsable.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListUsableSubnetworksRequest	ListUsableSubnetworksRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.ListUsableCallback	Node-style callback called with the error, if any, and UsableSubnetworksAggregatedList

Returns:

Type	Description
undefined

listUsable(request) → {Promise.<google.cloud.compute.v1.UsableSubnetworksAggregatedList>}

Calls ListUsable.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListUsableSubnetworksRequest	ListUsableSubnetworksRequest message or plain object

Returns:

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

patch(request, callback) → {undefined}

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchSubnetworkRequest	PatchSubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.PatchCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchSubnetworkRequest	PatchSubnetworkRequest message or plain object

Returns:

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

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetIamPolicySubnetworkRequest	SetIamPolicySubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.SetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

setIamPolicy(request) → {Promise.<google.cloud.compute.v1.Policy>}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetIamPolicySubnetworkRequest	SetIamPolicySubnetworkRequest message or plain object

Returns:

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

setPrivateIpGoogleAccess(request, callback) → {undefined}

Calls SetPrivateIpGoogleAccess.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest	SetPrivateIpGoogleAccessSubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.SetPrivateIpGoogleAccessCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SetPrivateIpGoogleAccess.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest	SetPrivateIpGoogleAccessSubnetworkRequest message or plain object

Returns:

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

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest	TestIamPermissionsSubnetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Subnetworks.TestIamPermissionsCallback	Node-style callback called with the error, if any, and TestPermissionsResponse

Returns:

Type	Description
undefined

testIamPermissions(request) → {Promise.<google.cloud.compute.v1.TestPermissionsResponse>}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest	TestIamPermissionsSubnetworkRequest message or plain object

Returns:

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

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

Creates new Subnetworks 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
Subnetworks	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AggregatedListCallback(error, responseopt)

Callback as used by aggregatedList.

Parameters:

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

DeleteCallback(error, responseopt)

Callback as used by delete_.

Parameters:

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

ExpandIpCidrRangeCallback(error, responseopt)

Callback as used by expandIpCidrRange.

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.Subnetwork	<optional>	Subnetwork

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:

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

InsertCallback(error, responseopt)

Callback as used by insert.

Parameters:

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

ListCallback(error, responseopt)

Callback as used by list.

Parameters:

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

ListUsableCallback(error, responseopt)

Callback as used by listUsable.

Parameters:

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

PatchCallback(error, responseopt)

Callback as used by patch.

Parameters:

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

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:

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

SetPrivateIpGoogleAccessCallback(error, responseopt)

Callback as used by setPrivateIpGoogleAccess.

Parameters:

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

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:

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