Class v1.BackendServicesClient (4.11.0)

The BackendServices API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);

Construct an instance of BackendServicesClient.

Parameters
NameDescription
optsClientOptions
gaxInstancetypeofgax | typeoffallback

: loaded instance ofgoogle-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new BackendServicesClient({fallback: true}, gax); ```

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;

backendServicesStub

backendServicesStub?:Promise<{[name:string]:Function;}>;

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.

universeDomain

getuniverseDomain():string;

warn

warn:(code:string,message:string,warnType?:string)=>void;

Methods

addSignedUrlKey(request, options)

addSignedUrlKey(request?:protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Adds a key for validating requests with signed URLs for this backend service.

Parameters
NameDescription
requestIAddSignedUrlKeyBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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..promise() is not supported yet.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.   */// const backendService = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  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 signedUrlKeyResource = {}// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallAddSignedUrlKey(){// Construct requestconstrequest={backendService,project,signedUrlKeyResource,};// Run requestconstresponse=awaitcomputeClient.addSignedUrlKey(request);console.log(response);}callAddSignedUrlKey();

addSignedUrlKey(request, options, callback)

addSignedUrlKey(request:protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIAddSignedUrlKeyBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addSignedUrlKey(request, callback)

addSignedUrlKey(request:protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIAddSignedUrlKeyBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

aggregatedListAsync(request, options)

aggregatedListAsync(request?:protos.google.cloud.compute.v1.IAggregatedListBackendServicesRequest,options?:CallOptions):AsyncIterable<[string,protos.google.cloud.compute.v1.IBackendServicesScopedList]>;

Retrieves the list of all BackendService resources, regional and global, available to the specified project. 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
NameDescription
requestIAggregatedListBackendServicesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<[ string,protos.google.cloud.compute.v1.IBackendServicesScopedList ]>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing as tuple [string,BackendServicesScopedList]. 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.

Example
/**   * 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:*
You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // 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 thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, 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 usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field 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 byname orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to get the next page of results./// const pageToken = 'abc123'/*
  • Name of the project scoping 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 {BackendServicesClient} = require('@google-cloud/compute').v1;

    // Instantiates a clientconst computeClient = new BackendServicesClient();

    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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

delete(request, options)

delete(request?:protos.google.cloud.compute.v1.IDeleteBackendServiceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Deletes the specified BackendService resource.

Parameters
NameDescription
requestIDeleteBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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..promise() is not supported yet.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to delete.   */// const backendService = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  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'// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallDelete(){// Construct requestconstrequest={backendService,project,};// Run requestconstresponse=awaitcomputeClient.delete(request);console.log(response);}callDelete();

delete(request, options, callback)

delete(request:protos.google.cloud.compute.v1.IDeleteBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

delete(request, callback)

delete(request:protos.google.cloud.compute.v1.IDeleteBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteSignedUrlKey(request, options)

deleteSignedUrlKey(request?:protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Deletes a key for validating requests with signed URLs for this backend service.

Parameters
NameDescription
requestIDeleteSignedUrlKeyBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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..promise() is not supported yet.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.   */// const backendService = 'abc123'/**   *  The name of the Signed URL Key to delete.   */// const keyName = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  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'// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallDeleteSignedUrlKey(){// Construct requestconstrequest={backendService,keyName,project,};// Run requestconstresponse=awaitcomputeClient.deleteSignedUrlKey(request);console.log(response);}callDeleteSignedUrlKey();

deleteSignedUrlKey(request, options, callback)

deleteSignedUrlKey(request:protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteSignedUrlKeyBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteSignedUrlKey(request, callback)

deleteSignedUrlKey(request:protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteSignedUrlKeyBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, options)

get(request?:protos.google.cloud.compute.v1.IGetBackendServiceRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IBackendService,protos.google.cloud.compute.v1.IGetBackendServiceRequest|undefined,{}|undefined]>;

Returns the specified BackendService resource.

Parameters
NameDescription
requestIGetBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IBackendService,protos.google.cloud.compute.v1.IGetBackendServiceRequest | 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.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to return.   */// const backendService = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallGet(){// Construct requestconstrequest={backendService,project,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();

get(request, options, callback)

get(request:protos.google.cloud.compute.v1.IGetBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IBackendService,protos.google.cloud.compute.v1.IGetBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IBackendService,protos.google.cloud.compute.v1.IGetBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

get(request:protos.google.cloud.compute.v1.IGetBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IBackendService,protos.google.cloud.compute.v1.IGetBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IBackendService,protos.google.cloud.compute.v1.IGetBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getHealth(request, options)

getHealth(request?:protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IBackendServiceGroupHealth,(protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest|undefined),{}|undefined]>;

Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

Parameters
NameDescription
requestIGetHealthBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IBackendServiceGroupHealth, (protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingBackendServiceGroupHealth. Please see thedocumentation for more details and examples.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to which the queried instance belongs.   */// const backendService = 'abc123'/**   */// const project = 'my-project'/**   *  The body resource for this request   */// const resourceGroupReferenceResource = {}// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallGetHealth(){// Construct requestconstrequest={backendService,project,resourceGroupReferenceResource,};// Run requestconstresponse=awaitcomputeClient.getHealth(request);console.log(response);}callGetHealth();

getHealth(request, options, callback)

getHealth(request:protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IBackendServiceGroupHealth,protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetHealthBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IBackendServiceGroupHealth,protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getHealth(request, callback)

getHealth(request:protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IBackendServiceGroupHealth,protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetHealthBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IBackendServiceGroupHealth,protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, options)

getIamPolicy(request?:protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IPolicy,(protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest|undefined),{}|undefined]>;

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestIGetIamPolicyBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IPolicy, (protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest | 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.

Example
/**   * 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'/**   *  Name or id of the resource for this request.   */// const resource = 'abc123'// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallGetIamPolicy(){// Construct requestconstrequest={project,resource,};// Run requestconstresponse=awaitcomputeClient.getIamPolicy(request);console.log(response);}callGetIamPolicy();

getIamPolicy(request, options, callback)

getIamPolicy(request:protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetIamPolicyBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, callback)

getIamPolicy(request:protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetIamPolicyBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId():Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback:Callback<string,undefined,undefined>):void;
Parameter
NameDescription
callbackCallback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]:Function; }>

{Promise} A promise that resolves to an authenticated service stub.

insert(request, options)

insert(request?:protos.google.cloud.compute.v1.IInsertBackendServiceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .

Parameters
NameDescription
requestIInsertBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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..promise() is not supported yet.

Example
/**   * 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 body resource for this request   */// const backendServiceResource = {}/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  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'// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallInsert(){// Construct requestconstrequest={backendServiceResource,project,};// Run requestconstresponse=awaitcomputeClient.insert(request);console.log(response);}callInsert();

insert(request, options, callback)

insert(request:protos.google.cloud.compute.v1.IInsertBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIInsertBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

insert(request, callback)

insert(request:protos.google.cloud.compute.v1.IInsertBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIInsertBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

list(request, options)

list(request?:protos.google.cloud.compute.v1.IListBackendServicesRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IBackendService[],protos.google.cloud.compute.v1.IListBackendServicesRequest|null,protos.google.cloud.compute.v1.IBackendServiceList]>;

Retrieves the list of BackendService resources available to the specified project.

Parameters
NameDescription
requestIListBackendServicesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IBackendService[],protos.google.cloud.compute.v1.IListBackendServicesRequest | null,protos.google.cloud.compute.v1.IBackendServiceList ]>

{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 usinglistAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

list(request, options, callback)

list(request:protos.google.cloud.compute.v1.IListBackendServicesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListBackendServicesRequest,protos.google.cloud.compute.v1.IBackendServiceList|null|undefined,protos.google.cloud.compute.v1.IBackendService>):void;
Parameters
NameDescription
requestIListBackendServicesRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.compute.v1.IListBackendServicesRequest,protos.google.cloud.compute.v1.IBackendServiceList | null | undefined,protos.google.cloud.compute.v1.IBackendService>
Returns
TypeDescription
void

list(request, callback)

list(request:protos.google.cloud.compute.v1.IListBackendServicesRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListBackendServicesRequest,protos.google.cloud.compute.v1.IBackendServiceList|null|undefined,protos.google.cloud.compute.v1.IBackendService>):void;
Parameters
NameDescription
requestIListBackendServicesRequest
callbackPaginationCallback<protos.google.cloud.compute.v1.IListBackendServicesRequest,protos.google.cloud.compute.v1.IBackendServiceList | null | undefined,protos.google.cloud.compute.v1.IBackendService>
Returns
TypeDescription
void

listAsync(request, options)

listAsync(request?:protos.google.cloud.compute.v1.IListBackendServicesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IBackendService>;

Equivalent tolist, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListBackendServicesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IBackendService>

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

Example
/**   * 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:*
You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, 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 usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field 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 byname orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken returned 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

    // Imports the Compute libraryconst {BackendServicesClient} = require('@google-cloud/compute').v1;

    // Instantiates a clientconst computeClient = new BackendServicesClient();

    async function callList() {// Construct requestconst request = {project,};

    // 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.IListBackendServicesRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListBackendServicesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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 usinglistAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listUsable(request, options)

listUsable(request?:protos.google.cloud.compute.v1.IListUsableBackendServicesRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IBackendService[],protos.google.cloud.compute.v1.IListUsableBackendServicesRequest|null,protos.google.cloud.compute.v1.IBackendServiceListUsable]>;

Retrieves a list of all usable backend services in the specified project.

Parameters
NameDescription
requestIListUsableBackendServicesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IBackendService[],protos.google.cloud.compute.v1.IListUsableBackendServicesRequest | null,protos.google.cloud.compute.v1.IBackendServiceListUsable ]>

{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 usinglistUsableAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listUsable(request, options, callback)

listUsable(request:protos.google.cloud.compute.v1.IListUsableBackendServicesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListUsableBackendServicesRequest,protos.google.cloud.compute.v1.IBackendServiceListUsable|null|undefined,protos.google.cloud.compute.v1.IBackendService>):void;
Parameters
NameDescription
requestIListUsableBackendServicesRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.compute.v1.IListUsableBackendServicesRequest,protos.google.cloud.compute.v1.IBackendServiceListUsable | null | undefined,protos.google.cloud.compute.v1.IBackendService>
Returns
TypeDescription
void

listUsable(request, callback)

listUsable(request:protos.google.cloud.compute.v1.IListUsableBackendServicesRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListUsableBackendServicesRequest,protos.google.cloud.compute.v1.IBackendServiceListUsable|null|undefined,protos.google.cloud.compute.v1.IBackendService>):void;
Parameters
NameDescription
requestIListUsableBackendServicesRequest
callbackPaginationCallback<protos.google.cloud.compute.v1.IListUsableBackendServicesRequest,protos.google.cloud.compute.v1.IBackendServiceListUsable | null | undefined,protos.google.cloud.compute.v1.IBackendService>
Returns
TypeDescription
void

listUsableAsync(request, options)

listUsableAsync(request?:protos.google.cloud.compute.v1.IListUsableBackendServicesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IBackendService>;

Equivalent tolistUsable, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListUsableBackendServicesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IBackendService>

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

Example
/**   * 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:*
You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")
By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

/ // const filter = 'abc123' /*

  • The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, 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 usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp field 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 byname orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken returned 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

    // Imports the Compute libraryconst {BackendServicesClient} = require('@google-cloud/compute').v1;

    // Instantiates a clientconst computeClient = new BackendServicesClient();

    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.IListUsableBackendServicesRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListUsableBackendServicesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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 usinglistUsableAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

patch(request, options)

patch(request?:protos.google.cloud.compute.v1.IPatchBackendServiceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestIPatchBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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..promise() is not supported yet.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to patch.   */// const backendService = 'abc123'/**   *  The body resource for this request   */// const backendServiceResource = {}/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  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'// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallPatch(){// Construct requestconstrequest={backendService,backendServiceResource,project,};// Run requestconstresponse=awaitcomputeClient.patch(request);console.log(response);}callPatch();

patch(request, options, callback)

patch(request:protos.google.cloud.compute.v1.IPatchBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIPatchBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

patch(request, callback)

patch(request:protos.google.cloud.compute.v1.IPatchBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIPatchBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setEdgeSecurityPolicy(request, options)

setEdgeSecurityPolicy(request?:protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendServiceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Sets the edge security policy for the specified backend service.

Parameters
NameDescription
requestISetEdgeSecurityPolicyBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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..promise() is not supported yet.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.   */// const backendService = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  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 securityPolicyReferenceResource = {}// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallSetEdgeSecurityPolicy(){// Construct requestconstrequest={backendService,project,securityPolicyReferenceResource,};// Run requestconstresponse=awaitcomputeClient.setEdgeSecurityPolicy(request);console.log(response);}callSetEdgeSecurityPolicy();

setEdgeSecurityPolicy(request, options, callback)

setEdgeSecurityPolicy(request:protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestISetEdgeSecurityPolicyBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setEdgeSecurityPolicy(request, callback)

setEdgeSecurityPolicy(request:protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestISetEdgeSecurityPolicyBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setIamPolicy(request, options)

setIamPolicy(request?:protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IPolicy,(protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest|undefined),{}|undefined]>;

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestISetIamPolicyBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IPolicy, (protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest | 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.

Example
/**   * 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 body resource for this request   */// const globalSetPolicyRequestResource = {}/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name or id of the resource for this request.   */// const resource = 'abc123'// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallSetIamPolicy(){// Construct requestconstrequest={globalSetPolicyRequestResource,project,resource,};// Run requestconstresponse=awaitcomputeClient.setIamPolicy(request);console.log(response);}callSetIamPolicy();

setIamPolicy(request, options, callback)

setIamPolicy(request:protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestISetIamPolicyBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setIamPolicy(request, callback)

setIamPolicy(request:protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestISetIamPolicyBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setSecurityPolicy(request, options)

setSecurityPolicy(request?:protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

Parameters
NameDescription
requestISetSecurityPolicyBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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..promise() is not supported yet.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.   */// const backendService = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  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 securityPolicyReferenceResource = {}// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallSetSecurityPolicy(){// Construct requestconstrequest={backendService,project,securityPolicyReferenceResource,};// Run requestconstresponse=awaitcomputeClient.setSecurityPolicy(request);console.log(response);}callSetSecurityPolicy();

setSecurityPolicy(request, options, callback)

setSecurityPolicy(request:protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestISetSecurityPolicyBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setSecurityPolicy(request, callback)

setSecurityPolicy(request:protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestISetSecurityPolicyBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, options)

testIamPermissions(request?:protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.ITestPermissionsResponse,(protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest|undefined),{}|undefined]>;

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestITestIamPermissionsBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.ITestPermissionsResponse, (protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest | 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.

Example
/**   * 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 or id of the resource for this request.   */// const resource = 'abc123'/**   *  The body resource for this request   */// const testPermissionsRequestResource = {}// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallTestIamPermissions(){// Construct requestconstrequest={project,resource,testPermissionsRequestResource,};// Run requestconstresponse=awaitcomputeClient.testIamPermissions(request);console.log(response);}callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request:protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestITestIamPermissionsBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, callback)

testIamPermissions(request:protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestITestIamPermissionsBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

update(request, options)

update(request?:protos.google.cloud.compute.v1.IUpdateBackendServiceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;

Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.

Parameters
NameDescription
requestIUpdateBackendServiceRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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..promise() is not supported yet.

Example
/**   * 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.   *//**   *  Name of the BackendService resource to update.   */// const backendService = 'abc123'/**   *  The body resource for this request   */// const backendServiceResource = {}/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  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'// Imports the Compute libraryconst{BackendServicesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendServicesClient();asyncfunctioncallUpdate(){// Construct requestconstrequest={backendService,backendServiceResource,project,};// Run requestconstresponse=awaitcomputeClient.update(request);console.log(response);}callUpdate();

update(request, options, callback)

update(request:protos.google.cloud.compute.v1.IUpdateBackendServiceRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateBackendServiceRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

update(request, callback)

update(request:protos.google.cloud.compute.v1.IUpdateBackendServiceRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateBackendServiceRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateBackendServiceRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateBackendServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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.