Class protos.google.cloud.compute.v1.Subnetworks (4.5.0)

Represents a Subnetworks

Inheritance

$protobuf.rpc.Service > protos.google.cloud.compute.v1.Subnetworks

Package

@google-cloud/compute

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Subnetworks service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

aggregatedList(request, callback)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListSubnetworksRequest, callback: google.cloud.compute.v1.Subnetworks.AggregatedListCallback): void;

Calls AggregatedList.

Parameters
Name Description
request IAggregatedListSubnetworksRequest

AggregatedListSubnetworksRequest message or plain object

callback AggregatedListCallback

Node-style callback called with the error, if any, and SubnetworkAggregatedList

Returns
Type Description
void

aggregatedList(request)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListSubnetworksRequest): Promise<google.cloud.compute.v1.SubnetworkAggregatedList>;

Calls AggregatedList.

Parameter
Name Description
request IAggregatedListSubnetworksRequest

AggregatedListSubnetworksRequest message or plain object

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

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Subnetworks;

Creates new Subnetworks service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
Type Description
Subnetworks

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

delete(request, callback)

public delete(request: google.cloud.compute.v1.IDeleteSubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.DeleteCallback): void;

Calls Delete.

Parameters
Name Description
request IDeleteSubnetworkRequest

DeleteSubnetworkRequest message or plain object

callback DeleteCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

delete(request)

public delete(request: google.cloud.compute.v1.IDeleteSubnetworkRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Delete.

Parameter
Name Description
request IDeleteSubnetworkRequest

DeleteSubnetworkRequest message or plain object

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

Promise

expandIpCidrRange(request, callback)

public expandIpCidrRange(request: google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.ExpandIpCidrRangeCallback): void;

Calls ExpandIpCidrRange.

Parameters
Name Description
request IExpandIpCidrRangeSubnetworkRequest

ExpandIpCidrRangeSubnetworkRequest message or plain object

callback ExpandIpCidrRangeCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

expandIpCidrRange(request)

public expandIpCidrRange(request: google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest): Promise<google.cloud.compute.v1.Operation>;

Calls ExpandIpCidrRange.

Parameter
Name Description
request IExpandIpCidrRangeSubnetworkRequest

ExpandIpCidrRangeSubnetworkRequest message or plain object

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

Promise

get(request, callback)

public get(request: google.cloud.compute.v1.IGetSubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.GetCallback): void;

Calls Get.

Parameters
Name Description
request IGetSubnetworkRequest

GetSubnetworkRequest message or plain object

callback GetCallback

Node-style callback called with the error, if any, and Subnetwork

Returns
Type Description
void

get(request)

public get(request: google.cloud.compute.v1.IGetSubnetworkRequest): Promise<google.cloud.compute.v1.Subnetwork>;

Calls Get.

Parameter
Name Description
request IGetSubnetworkRequest

GetSubnetworkRequest message or plain object

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

Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.cloud.compute.v1.IGetIamPolicySubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
Name Description
request IGetIamPolicySubnetworkRequest

GetIamPolicySubnetworkRequest message or plain object

callback GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns
Type Description
void

getIamPolicy(request)

public getIamPolicy(request: google.cloud.compute.v1.IGetIamPolicySubnetworkRequest): Promise<google.cloud.compute.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name Description
request IGetIamPolicySubnetworkRequest

GetIamPolicySubnetworkRequest message or plain object

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

Promise

insert(request, callback)

public insert(request: google.cloud.compute.v1.IInsertSubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.InsertCallback): void;

Calls Insert.

Parameters
Name Description
request IInsertSubnetworkRequest

InsertSubnetworkRequest message or plain object

callback InsertCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

insert(request)

public insert(request: google.cloud.compute.v1.IInsertSubnetworkRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Insert.

Parameter
Name Description
request IInsertSubnetworkRequest

InsertSubnetworkRequest message or plain object

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

Promise

list(request, callback)

public list(request: google.cloud.compute.v1.IListSubnetworksRequest, callback: google.cloud.compute.v1.Subnetworks.ListCallback): void;

Calls List.

Parameters
Name Description
request IListSubnetworksRequest

ListSubnetworksRequest message or plain object

callback ListCallback

Node-style callback called with the error, if any, and SubnetworkList

Returns
Type Description
void

list(request)

public list(request: google.cloud.compute.v1.IListSubnetworksRequest): Promise<google.cloud.compute.v1.SubnetworkList>;

Calls List.

Parameter
Name Description
request IListSubnetworksRequest

ListSubnetworksRequest message or plain object

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

Promise

listUsable(request, callback)

public listUsable(request: google.cloud.compute.v1.IListUsableSubnetworksRequest, callback: google.cloud.compute.v1.Subnetworks.ListUsableCallback): void;

Calls ListUsable.

Parameters
Name Description
request IListUsableSubnetworksRequest

ListUsableSubnetworksRequest message or plain object

callback ListUsableCallback

Node-style callback called with the error, if any, and UsableSubnetworksAggregatedList

Returns
Type Description
void

listUsable(request)

public listUsable(request: google.cloud.compute.v1.IListUsableSubnetworksRequest): Promise<google.cloud.compute.v1.UsableSubnetworksAggregatedList>;

Calls ListUsable.

Parameter
Name Description
request IListUsableSubnetworksRequest

ListUsableSubnetworksRequest message or plain object

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

Promise

patch(request, callback)

public patch(request: google.cloud.compute.v1.IPatchSubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.PatchCallback): void;

Calls Patch.

Parameters
Name Description
request IPatchSubnetworkRequest

PatchSubnetworkRequest message or plain object

callback PatchCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

patch(request)

public patch(request: google.cloud.compute.v1.IPatchSubnetworkRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Patch.

Parameter
Name Description
request IPatchSubnetworkRequest

PatchSubnetworkRequest message or plain object

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

Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.cloud.compute.v1.ISetIamPolicySubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
Name Description
request ISetIamPolicySubnetworkRequest

SetIamPolicySubnetworkRequest message or plain object

callback SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns
Type Description
void

setIamPolicy(request)

public setIamPolicy(request: google.cloud.compute.v1.ISetIamPolicySubnetworkRequest): Promise<google.cloud.compute.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name Description
request ISetIamPolicySubnetworkRequest

SetIamPolicySubnetworkRequest message or plain object

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

Promise

setPrivateIpGoogleAccess(request, callback)

public setPrivateIpGoogleAccess(request: google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.SetPrivateIpGoogleAccessCallback): void;

Calls SetPrivateIpGoogleAccess.

Parameters
Name Description
request ISetPrivateIpGoogleAccessSubnetworkRequest

SetPrivateIpGoogleAccessSubnetworkRequest message or plain object

callback SetPrivateIpGoogleAccessCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

setPrivateIpGoogleAccess(request)

public setPrivateIpGoogleAccess(request: google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetPrivateIpGoogleAccess.

Parameter
Name Description
request ISetPrivateIpGoogleAccessSubnetworkRequest

SetPrivateIpGoogleAccessSubnetworkRequest message or plain object

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

Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest, callback: google.cloud.compute.v1.Subnetworks.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Name Description
request ITestIamPermissionsSubnetworkRequest

TestIamPermissionsSubnetworkRequest message or plain object

callback TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestPermissionsResponse

Returns
Type Description
void

testIamPermissions(request)

public testIamPermissions(request: google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest): Promise<google.cloud.compute.v1.TestPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name Description
request ITestIamPermissionsSubnetworkRequest

TestIamPermissionsSubnetworkRequest message or plain object

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

Promise