Class v1.SubnetworksClient (6.5.0) Stay organized with collections Save and categorize content based on your preferences.
The Subnetworks API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);Construct an instance of SubnetworksClient.
| Parameters | |
|---|---|
| Name | Description |
opts | ClientOptions |
gaxInstance | typeofgax | typeoffallback: loaded instance of |
Properties
apiEndpoint
getapiEndpoint():string;The DNS address for this API service.
apiEndpoint
staticgetapiEndpoint():string;The DNS address for this API service - same as servicePath.
auth
auth:gax.GoogleAuth;descriptors
descriptors:Descriptors;innerApiCalls
innerApiCalls:{[name:string]:Function;};port
staticgetport():number;The port for this API service.
scopes
staticgetscopes():string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
staticgetservicePath():string;The DNS address for this API service.
subnetworksStub
subnetworksStub?:Promise<{[name:string]:Function;}>;universeDomain
getuniverseDomain():string;warn
warn:(code:string,message:string,warnType?:string)=>void;Methods
aggregatedListAsync(request, options)
aggregatedListAsync(request?:protos.google.cloud.compute.v1.IAggregatedListSubnetworksRequest,options?:CallOptions):AsyncIterable<[string,protos.google.cloud.compute.v1.ISubnetworksScopedList]>;Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set thereturnPartialSuccess parameter totrue.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IAggregatedListSubnetworksRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<[string,protos.google.cloud.compute.v1.ISubnetworksScopedList]> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing as tuple [string,SubnetworksScopedList]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: labels.owner:*
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)/ // const filter = 'abc123' /*
- Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included./// const includeAllScopes = true/*
- The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults, Compute Engine returns anextPageTokenthat can be used to get the next page of results in subsequent list requests. Acceptable values are0to500, inclusive. (Default:500)/// const maxResults = 1234/* - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc". This sorts results based on thecreationTimestampfield in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting bynameorcreationTimestamp descis supported./// const orderBy = 'abc123'/* - Specifies a page token to use. Set
pageTokento thenextPageTokenreturned by a previous list request to get the next page of results./// const pageToken = 'abc123'/* - Project ID for this request./// const project = 'my-project'/*
- Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code./// const returnPartialSuccess = true/*
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.*/// const serviceProjectNumber = 1234
// Imports the Compute libraryconst {SubnetworksClient} = require('@google-cloud/compute').v1;
// Instantiates a clientconst computeClient = new SubnetworksClient();
async function callAggregatedList() {// Construct requestconst request = {project,};
// Run requestconst iterable = computeClient.aggregatedListAsync(request);for await (const [key, value] of iterable) { console.log(response);}}
callAggregatedList();
close()
close():Promise<void>;Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Returns | |
|---|---|
| Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
delete(request, options)
delete(request?:protos.google.cloud.compute.v1.IDeleteSubnetworkRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Deletes the specified subnetwork.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteSubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Project ID for this request. */// const project = 'my-project'/** * Name of the region scoping this request. */// const region = 'us-central1'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * Name of the Subnetwork resource to delete. */// const subnetwork = 'abc123'// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallDelete(){// Construct requestconstrequest={project,region,subnetwork,};// Run requestconstresponse=awaitcomputeClient.delete(request);console.log(response);}callDelete();delete(request, options, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteSubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteSubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
delete(request, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteSubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteSubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
expandIpCidrRange(request, options)
expandIpCidrRange(request?:protos.google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Expands the IP CIDR range of the subnetwork to a specified value.
| Parameters | |
|---|---|
| Name | Description |
request | IExpandIpCidrRangeSubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Project ID for this request. */// const project = 'my-project'/** * Name of the region scoping this request. */// const region = 'us-central1'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * Name of the Subnetwork resource to update. */// const subnetwork = 'abc123'/** * The body resource for this request */// const subnetworksExpandIpCidrRangeRequestResource = {}// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallExpandIpCidrRange(){// Construct requestconstrequest={project,region,subnetwork,subnetworksExpandIpCidrRangeRequestResource,};// Run requestconstresponse=awaitcomputeClient.expandIpCidrRange(request);console.log(response);}callExpandIpCidrRange();expandIpCidrRange(request, options, callback)
expandIpCidrRange(request:protos.google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IExpandIpCidrRangeSubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
expandIpCidrRange(request, callback)
expandIpCidrRange(request:protos.google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IExpandIpCidrRangeSubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IExpandIpCidrRangeSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, options)
get(request?:protos.google.cloud.compute.v1.IGetSubnetworkRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.ISubnetwork,protos.google.cloud.compute.v1.IGetSubnetworkRequest|undefined,{}|undefined]>;Returns the specified subnetwork.
| Parameters | |
|---|---|
| Name | Description |
request | IGetSubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.ISubnetwork,protos.google.cloud.compute.v1.IGetSubnetworkRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Project ID for this request. */// const project = 'my-project'/** * Name of the region scoping this request. */// const region = 'us-central1'/** * Name of the Subnetwork resource to return. */// const subnetwork = 'abc123'/** * Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. * Check the Views enum for the list of possible values. */// const views = 'abc123'// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallGet(){// Construct requestconstrequest={project,region,subnetwork,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();get(request, options, callback)
get(request:protos.google.cloud.compute.v1.IGetSubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.ISubnetwork,protos.google.cloud.compute.v1.IGetSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetSubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.ISubnetwork,protos.google.cloud.compute.v1.IGetSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, callback)
get(request:protos.google.cloud.compute.v1.IGetSubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.ISubnetwork,protos.google.cloud.compute.v1.IGetSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetSubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.ISubnetwork,protos.google.cloud.compute.v1.IGetSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getIamPolicy(request, options)
getIamPolicy(request?:protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest|undefined,{}|undefined]>;Gets the access control policy for a resource. May be empty if no such policy or resource exists.
| Parameters | |
|---|---|
| Name | Description |
request | IGetIamPolicySubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingPolicy. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Requested IAM Policy version. */// const optionsRequestedPolicyVersion = 1234/** * Project ID for this request. */// const project = 'my-project'/** * The name of the region for this request. */// const region = 'us-central1'/** * Name or id of the resource for this request. */// const resource = 'abc123'// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallGetIamPolicy(){// Construct requestconstrequest={project,region,resource,};// Run requestconstresponse=awaitcomputeClient.getIamPolicy(request);console.log(response);}callGetIamPolicy();getIamPolicy(request, options, callback)
getIamPolicy(request:protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetIamPolicySubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getIamPolicy(request, callback)
getIamPolicy(request:protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetIamPolicySubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicySubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getProjectId()
getProjectId():Promise<string>;| Returns | |
|---|---|
| Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback:Callback<string,undefined,undefined>):void;| Parameter | |
|---|---|
| Name | Description |
callback | Callback<string, undefined, undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
initialize()
initialize():Promise<{[name:string]:Function;}>;Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Returns | |
|---|---|
| Type | Description |
Promise<{ [name: string]:Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
insert(request, options)
insert(request?:protos.google.cloud.compute.v1.IInsertSubnetworkRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Creates a subnetwork in the specified project using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | IInsertSubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Project ID for this request. */// const project = 'my-project'/** * Name of the region scoping this request. */// const region = 'us-central1'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * The body resource for this request */// const subnetworkResource = {}// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallInsert(){// Construct requestconstrequest={project,region,subnetworkResource,};// Run requestconstresponse=awaitcomputeClient.insert(request);console.log(response);}callInsert();insert(request, options, callback)
insert(request:protos.google.cloud.compute.v1.IInsertSubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IInsertSubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
insert(request, callback)
insert(request:protos.google.cloud.compute.v1.IInsertSubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IInsertSubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
list(request, options)
list(request?:protos.google.cloud.compute.v1.IListSubnetworksRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.ISubnetwork[],protos.google.cloud.compute.v1.IListSubnetworksRequest|null,protos.google.cloud.compute.v1.ISubnetworkList]>;Retrieves a list of subnetworks available to the specified project.
| Parameters | |
|---|---|
| Name | Description |
request | IListSubnetworksRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.ISubnetwork[],protos.google.cloud.compute.v1.IListSubnetworksRequest | null,protos.google.cloud.compute.v1.ISubnetworkList ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
list(request, options, callback)
list(request:protos.google.cloud.compute.v1.IListSubnetworksRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListSubnetworksRequest,protos.google.cloud.compute.v1.ISubnetworkList|null|undefined,protos.google.cloud.compute.v1.ISubnetwork>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListSubnetworksRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListSubnetworksRequest,protos.google.cloud.compute.v1.ISubnetworkList | null | undefined,protos.google.cloud.compute.v1.ISubnetwork> |
| Returns | |
|---|---|
| Type | Description |
void | |
list(request, callback)
list(request:protos.google.cloud.compute.v1.IListSubnetworksRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListSubnetworksRequest,protos.google.cloud.compute.v1.ISubnetworkList|null|undefined,protos.google.cloud.compute.v1.ISubnetwork>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListSubnetworksRequest |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListSubnetworksRequest,protos.google.cloud.compute.v1.ISubnetworkList | null | undefined,protos.google.cloud.compute.v1.ISubnetwork> |
| Returns | |
|---|---|
| Type | Description |
void | |
listAsync(request, options)
listAsync(request?:protos.google.cloud.compute.v1.IListSubnetworksRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.ISubnetwork>;Equivalent tolist, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListSubnetworksRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.ISubnetwork> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: labels.owner:*
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)/ // const filter = 'abc123' /*
- The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults, Compute Engine returns anextPageTokenthat can be used to get the next page of results in subsequent list requests. Acceptable values are0to500, inclusive. (Default:500)/// const maxResults = 1234/* - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc". This sorts results based on thecreationTimestampfield in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting bynameorcreationTimestamp descis supported./// const orderBy = 'abc123'/* - Specifies a page token to use. Set
pageTokento thenextPageTokenreturned by a previous list request to get the next page of results./// const pageToken = 'abc123'/* - Project ID for this request./// const project = 'my-project'/*
- Name of the region scoping this request./// const region = 'us-central1'/*
- Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code./// const returnPartialSuccess = true/*
- Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.
Check the Views enum for the list of possible values.*/// const views = 'abc123'
// Imports the Compute libraryconst {SubnetworksClient} = require('@google-cloud/compute').v1;
// Instantiates a clientconst computeClient = new SubnetworksClient();
async function callList() {// Construct requestconst request = {project,region,};
// Run requestconst iterable = computeClient.listAsync(request);for await (const response of iterable) { console.log(response);}}
callList();
listStream(request, options)
listStream(request?:protos.google.cloud.compute.v1.IListSubnetworksRequest,options?:CallOptions):Transform;Equivalent tolist, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListSubnetworksRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listUsable(request, options)
listUsable(request?:protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IUsableSubnetwork[],protos.google.cloud.compute.v1.IListUsableSubnetworksRequest|null,protos.google.cloud.compute.v1.IUsableSubnetworksAggregatedList]>;Retrieves an aggregated list of all usable subnetworks in the project.
| Parameters | |
|---|---|
| Name | Description |
request | IListUsableSubnetworksRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IUsableSubnetwork[],protos.google.cloud.compute.v1.IListUsableSubnetworksRequest | null,protos.google.cloud.compute.v1.IUsableSubnetworksAggregatedList ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listUsable(request, options, callback)
listUsable(request:protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,protos.google.cloud.compute.v1.IUsableSubnetworksAggregatedList|null|undefined,protos.google.cloud.compute.v1.IUsableSubnetwork>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListUsableSubnetworksRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,protos.google.cloud.compute.v1.IUsableSubnetworksAggregatedList | null | undefined,protos.google.cloud.compute.v1.IUsableSubnetwork> |
| Returns | |
|---|---|
| Type | Description |
void | |
listUsable(request, callback)
listUsable(request:protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,protos.google.cloud.compute.v1.IUsableSubnetworksAggregatedList|null|undefined,protos.google.cloud.compute.v1.IUsableSubnetwork>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListUsableSubnetworksRequest |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,protos.google.cloud.compute.v1.IUsableSubnetworksAggregatedList | null | undefined,protos.google.cloud.compute.v1.IUsableSubnetwork> |
| Returns | |
|---|---|
| Type | Description |
void | |
listUsableAsync(request, options)
listUsableAsync(request?:protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IUsableSubnetwork>;Equivalent tolistUsable, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListUsableSubnetworksRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.IUsableSubnetwork> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: labels.owner:*
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)/ // const filter = 'abc123' /*
- The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults, Compute Engine returns anextPageTokenthat can be used to get the next page of results in subsequent list requests. Acceptable values are0to500, inclusive. (Default:500)/// const maxResults = 1234/* - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc". This sorts results based on thecreationTimestampfield in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting bynameorcreationTimestamp descis supported./// const orderBy = 'abc123'/* - Specifies a page token to use. Set
pageTokento thenextPageTokenreturned by a previous list request to get the next page of results./// const pageToken = 'abc123'/* - Project ID for this request./// const project = 'my-project'/*
- Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code./// const returnPartialSuccess = true/*
The project id or project number in which the subnetwork is intended to be used. Only applied for Shared VPC. See Shared VPC documentation (https://cloud.google.com/vpc/docs/shared-vpc/)*/// const serviceProject = 'abc123'
// Imports the Compute libraryconst {SubnetworksClient} = require('@google-cloud/compute').v1;
// Instantiates a clientconst computeClient = new SubnetworksClient();
async function callListUsable() {// Construct requestconst request = {project,};
// Run requestconst iterable = computeClient.listUsableAsync(request);for await (const response of iterable) { console.log(response);}}
callListUsable();
listUsableStream(request, options)
listUsableStream(request?:protos.google.cloud.compute.v1.IListUsableSubnetworksRequest,options?:CallOptions):Transform;Equivalent tolistUsable, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListUsableSubnetworksRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
patch(request, options)
patch(request?:protos.google.cloud.compute.v1.IPatchSubnetworkRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.
| Parameters | |
|---|---|
| Name | Description |
request | IPatchSubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped. */// const drainTimeoutSeconds = 1234/** * Project ID for this request. */// const project = 'my-project'/** * Name of the region scoping this request. */// const region = 'us-central1'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * Name of the Subnetwork resource to patch. */// const subnetwork = 'abc123'/** * The body resource for this request */// const subnetworkResource = {}// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallPatch(){// Construct requestconstrequest={project,region,subnetwork,subnetworkResource,};// Run requestconstresponse=awaitcomputeClient.patch(request);console.log(response);}callPatch();patch(request, options, callback)
patch(request:protos.google.cloud.compute.v1.IPatchSubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IPatchSubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
patch(request, callback)
patch(request:protos.google.cloud.compute.v1.IPatchSubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IPatchSubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
setIamPolicy(request, options)
setIamPolicy(request?:protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest|undefined,{}|undefined]>;Sets the access control policy on the specified resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request | ISetIamPolicySubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingPolicy. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Project ID for this request. */// const project = 'my-project'/** * The name of the region for this request. */// const region = 'us-central1'/** * The body resource for this request */// const regionSetPolicyRequestResource = {}/** * Name or id of the resource for this request. */// const resource = 'abc123'// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallSetIamPolicy(){// Construct requestconstrequest={project,region,regionSetPolicyRequestResource,resource,};// Run requestconstresponse=awaitcomputeClient.setIamPolicy(request);console.log(response);}callSetIamPolicy();setIamPolicy(request, options, callback)
setIamPolicy(request:protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISetIamPolicySubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
setIamPolicy(request, callback)
setIamPolicy(request:protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISetIamPolicySubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicySubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
setPrivateIpGoogleAccess(request, options)
setPrivateIpGoogleAccess(request?:protos.google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
| Parameters | |
|---|---|
| Name | Description |
request | ISetPrivateIpGoogleAccessSubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Project ID for this request. */// const project = 'my-project'/** * Name of the region scoping this request. */// const region = 'us-central1'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * Name of the Subnetwork resource. */// const subnetwork = 'abc123'/** * The body resource for this request */// const subnetworksSetPrivateIpGoogleAccessRequestResource = {}// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallSetPrivateIpGoogleAccess(){// Construct requestconstrequest={project,region,subnetwork,subnetworksSetPrivateIpGoogleAccessRequestResource,};// Run requestconstresponse=awaitcomputeClient.setPrivateIpGoogleAccess(request);console.log(response);}callSetPrivateIpGoogleAccess();setPrivateIpGoogleAccess(request, options, callback)
setPrivateIpGoogleAccess(request:protos.google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISetPrivateIpGoogleAccessSubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
setPrivateIpGoogleAccess(request, callback)
setPrivateIpGoogleAccess(request:protos.google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISetPrivateIpGoogleAccessSubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetPrivateIpGoogleAccessSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
testIamPermissions(request, options)
testIamPermissions(request?:protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest|undefined,{}|undefined]>;Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request | ITestIamPermissionsSubnetworkRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingTestPermissionsResponse. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Project ID for this request. */// const project = 'my-project'/** * The name of the region for this request. */// const region = 'us-central1'/** * Name or id of the resource for this request. */// const resource = 'abc123'/** * The body resource for this request */// const testPermissionsRequestResource = {}// Imports the Compute libraryconst{SubnetworksClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newSubnetworksClient();asyncfunctioncallTestIamPermissions(){// Construct requestconstrequest={project,region,resource,testPermissionsRequestResource,};// Run requestconstresponse=awaitcomputeClient.testIamPermissions(request);console.log(response);}callTestIamPermissions();testIamPermissions(request, options, callback)
testIamPermissions(request:protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ITestIamPermissionsSubnetworkRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
testIamPermissions(request, callback)
testIamPermissions(request:protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest,callback:Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ITestIamPermissionsSubnetworkRequest |
callback | Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsSubnetworkRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.