The BackendBuckets API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);
Construct an instance of BackendBucketsClient.
| Parameters |
|---|
| Name | Description |
opts | ClientOptions
|
gaxInstance | typeofgax | 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 BackendBucketsClient({fallback: true}, gax); ``` |
Properties
apiEndpoint
The DNS address for this API service.
apiEndpoint
staticgetapiEndpoint():string;
The DNS address for this API service - same as servicePath.
auth
backendBucketsStub
backendBucketsStub?:Promise<{[name:string]:Function;}>;
descriptors
innerApiCalls
innerApiCalls:{[name:string]:Function;};
port
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.IAddSignedUrlKeyBackendBucketRequest,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 bucket.
| 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..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 BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. */// const backendBucket = '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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();asyncfunctioncallAddSignedUrlKey(){// Construct requestconstrequest={backendBucket,project,signedUrlKeyResource,};// Run requestconstresponse=awaitcomputeClient.addSignedUrlKey(request);console.log(response);}callAddSignedUrlKey();
addSignedUrlKey(request, options, callback)
addSignedUrlKey(request:protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
addSignedUrlKey(request, callback)
addSignedUrlKey(request:protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
close()
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.IDeleteBackendBucketRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;
Deletes the specified BackendBucket resource.
| 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..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 BackendBucket resource to delete. */// const backendBucket = '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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();asyncfunctioncallDelete(){// Construct requestconstrequest={backendBucket,project,};// Run requestconstresponse=awaitcomputeClient.delete(request);console.log(response);}callDelete();
delete(request, options, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
delete(request, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
deleteSignedUrlKey(request, options)
deleteSignedUrlKey(request?:protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendBucketRequest,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 bucket.
| 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..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 BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. */// const backendBucket = '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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();asyncfunctioncallDeleteSignedUrlKey(){// Construct requestconstrequest={backendBucket,keyName,project,};// Run requestconstresponse=awaitcomputeClient.deleteSignedUrlKey(request);console.log(response);}callDeleteSignedUrlKey();
deleteSignedUrlKey(request, options, callback)
deleteSignedUrlKey(request:protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
deleteSignedUrlKey(request, callback)
deleteSignedUrlKey(request:protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
get(request, options)
get(request?:protos.google.cloud.compute.v1.IGetBackendBucketRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IBackendBucket,protos.google.cloud.compute.v1.IGetBackendBucketRequest|undefined,{}|undefined]>;
Returns the specified BackendBucket resource.
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 BackendBucket resource to return. */// const backendBucket = 'abc123'/** * Project ID for this request. */// const project = 'my-project'// Imports the Compute libraryconst{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();asyncfunctioncallGet(){// Construct requestconstrequest={backendBucket,project,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();
get(request, options, callback)
get(request:protos.google.cloud.compute.v1.IGetBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IBackendBucket,protos.google.cloud.compute.v1.IGetBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
get(request, callback)
get(request:protos.google.cloud.compute.v1.IGetBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IBackendBucket,protos.google.cloud.compute.v1.IGetBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
getIamPolicy(request, options)
getIamPolicy(request?:protos.google.cloud.compute.v1.IGetIamPolicyBackendBucketRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IPolicy,(protos.google.cloud.compute.v1.IGetIamPolicyBackendBucketRequest|undefined),{}|undefined]>;
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();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.IGetIamPolicyBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
getIamPolicy(request, callback)
getIamPolicy(request:protos.google.cloud.compute.v1.IGetIamPolicyBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| 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.IInsertBackendBucketRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;
Creates a BackendBucket resource in the specified project using the data included in the request.
| 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..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 backendBucketResource = {}/** * 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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();asyncfunctioncallInsert(){// Construct requestconstrequest={backendBucketResource,project,};// Run requestconstresponse=awaitcomputeClient.insert(request);console.log(response);}callInsert();
insert(request, options, callback)
insert(request:protos.google.cloud.compute.v1.IInsertBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
insert(request, callback)
insert(request:protos.google.cloud.compute.v1.IInsertBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
list(request, options)
list(request?:protos.google.cloud.compute.v1.IListBackendBucketsRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IBackendBucket[],protos.google.cloud.compute.v1.IListBackendBucketsRequest|null,protos.google.cloud.compute.v1.IBackendBucketList]>;
Retrieves the list of BackendBucket resources available to the specified project.
list(request, options, callback)
list(request:protos.google.cloud.compute.v1.IListBackendBucketsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListBackendBucketsRequest,protos.google.cloud.compute.v1.IBackendBucketList|null|undefined,protos.google.cloud.compute.v1.IBackendBucket>):void;
| Returns |
|---|
| Type | Description |
void | |
list(request, callback)
list(request:protos.google.cloud.compute.v1.IListBackendBucketsRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListBackendBucketsRequest,protos.google.cloud.compute.v1.IBackendBucketList|null|undefined,protos.google.cloud.compute.v1.IBackendBucket>):void;
| Returns |
|---|
| Type | Description |
void | |
listAsync(request, options)
listAsync(request?:protos.google.cloud.compute.v1.IListBackendBucketsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IBackendBucket>;
Equivalent tolist, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Returns |
|---|
| Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.IBackendBucket> | {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 than
maxResults, 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 using
orderBy="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. Set
pageToken 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 {BackendBucketsClient} = require('@google-cloud/compute').v1;
// Instantiates a clientconst computeClient = new BackendBucketsClient();
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.IListBackendBucketsRequest,options?:CallOptions):Transform;
Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.
| 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 usinglistAsync() 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.IPatchBackendBucketRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;
Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| 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..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 BackendBucket resource to patch. */// const backendBucket = 'abc123'/** * The body resource for this request */// const backendBucketResource = {}/** * 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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();asyncfunctioncallPatch(){// Construct requestconstrequest={backendBucket,backendBucketResource,project,};// Run requestconstresponse=awaitcomputeClient.patch(request);console.log(response);}callPatch();
patch(request, options, callback)
patch(request:protos.google.cloud.compute.v1.IPatchBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
patch(request, callback)
patch(request:protos.google.cloud.compute.v1.IPatchBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
setEdgeSecurityPolicy(request, options)
setEdgeSecurityPolicy(request?:protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendBucketRequest,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 bucket.
| 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..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 BackendBucket resource to which the security policy should be set. The name should conform to RFC1035. */// const backendBucket = '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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();asyncfunctioncallSetEdgeSecurityPolicy(){// Construct requestconstrequest={backendBucket,project,securityPolicyReferenceResource,};// Run requestconstresponse=awaitcomputeClient.setEdgeSecurityPolicy(request);console.log(response);}callSetEdgeSecurityPolicy();
setEdgeSecurityPolicy(request, options, callback)
setEdgeSecurityPolicy(request:protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
setEdgeSecurityPolicy(request, callback)
setEdgeSecurityPolicy(request:protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetEdgeSecurityPolicyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
setIamPolicy(request, options)
setIamPolicy(request?:protos.google.cloud.compute.v1.ISetIamPolicyBackendBucketRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IPolicy,(protos.google.cloud.compute.v1.ISetIamPolicyBackendBucketRequest|undefined),{}|undefined]>;
Sets the access control policy on the specified resource. Replaces any existing policy.
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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();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.ISetIamPolicyBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
setIamPolicy(request, callback)
setIamPolicy(request:protos.google.cloud.compute.v1.ISetIamPolicyBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
testIamPermissions(request, options)
testIamPermissions(request?:protos.google.cloud.compute.v1.ITestIamPermissionsBackendBucketRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.ITestPermissionsResponse,(protos.google.cloud.compute.v1.ITestIamPermissionsBackendBucketRequest|undefined),{}|undefined]>;
Returns permissions that a caller has on the specified resource.
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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();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.ITestIamPermissionsBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
testIamPermissions(request, callback)
testIamPermissions(request:protos.google.cloud.compute.v1.ITestIamPermissionsBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
update(request, options)
update(request?:protos.google.cloud.compute.v1.IUpdateBackendBucketRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;
Updates the specified BackendBucket resource with the data included in the request.
| 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..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 BackendBucket resource to update. */// const backendBucket = 'abc123'/** * The body resource for this request */// const backendBucketResource = {}/** * 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{BackendBucketsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newBackendBucketsClient();asyncfunctioncallUpdate(){// Construct requestconstrequest={backendBucket,backendBucketResource,project,};// Run requestconstresponse=awaitcomputeClient.update(request);console.log(response);}callUpdate();
update(request, options, callback)
update(request:protos.google.cloud.compute.v1.IUpdateBackendBucketRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |
update(request, callback)
update(request:protos.google.cloud.compute.v1.IUpdateBackendBucketRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IUpdateBackendBucketRequest|null|undefined,{}|null|undefined>):void;
| Returns |
|---|
| Type | Description |
void | |