Package
@google-cloud/compute
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of SnapshotsClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
snapshotsStub
snapshotsStub?: Promise<{
[name: string]: Function;
}>;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
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.IDeleteSnapshotRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteSnapshotRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* Name of the Snapshot resource to delete.
*/
// const snapshot = 'abc123'
// Imports the Compute library
const {SnapshotsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new SnapshotsClient();
async function callDelete() {
// Construct request
const request = {
project,
snapshot,
};
// Run request
const response = await computeClient.delete(request);
console.log(response);
}
callDelete();
delete(request, options, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteSnapshotRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteSnapshotRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
delete(request, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteSnapshotRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteSnapshotRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
get(request, options)
get(request?: protos.google.cloud.compute.v1.IGetSnapshotRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ISnapshot,
protos.google.cloud.compute.v1.IGetSnapshotRequest | undefined,
{} | undefined
]>;
Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetSnapshotRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ISnapshot,
protos.google.cloud.compute.v1.IGetSnapshotRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Snapshot]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the Snapshot resource to return.
*/
// const snapshot = 'abc123'
// Imports the Compute library
const {SnapshotsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new SnapshotsClient();
async function callGet() {
// Construct request
const request = {
project,
snapshot,
};
// Run request
const response = await computeClient.get(request);
console.log(response);
}
callGet();
get(request, options, callback)
get(request: protos.google.cloud.compute.v1.IGetSnapshotRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ISnapshot, protos.google.cloud.compute.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetSnapshotRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.ISnapshot, protos.google.cloud.compute.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
get(request, callback)
get(request: protos.google.cloud.compute.v1.IGetSnapshotRequest, callback: Callback<protos.google.cloud.compute.v1.ISnapshot, protos.google.cloud.compute.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetSnapshotRequest
|
callback |
Callback<protos.google.cloud.compute.v1.ISnapshot, protos.google.cloud.compute.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, options)
getIamPolicy(request?: protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IPolicy,
protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest | undefined,
{} | undefined
]>;
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.IPolicy,
protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
|
Example
/**
* 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 library
const {SnapshotsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new SnapshotsClient();
async function callGetIamPolicy() {
// Construct request
const request = {
project,
resource,
};
// Run request
const response = await computeClient.getIamPolicy(request);
console.log(response);
}
callGetIamPolicy();
getIamPolicy(request, options, callback)
getIamPolicy(request: protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, callback)
getIamPolicy(request: protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicySnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
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
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.IInsertSnapshotRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IInsertSnapshotRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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 snapshotResource = {}
// Imports the Compute library
const {SnapshotsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new SnapshotsClient();
async function callInsert() {
// Construct request
const request = {
project,
snapshotResource,
};
// Run request
const response = await computeClient.insert(request);
console.log(response);
}
callInsert();
insert(request, options, callback)
insert(request: protos.google.cloud.compute.v1.IInsertSnapshotRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IInsertSnapshotRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
insert(request, callback)
insert(request: protos.google.cloud.compute.v1.IInsertSnapshotRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IInsertSnapshotRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
list(request, options)
list(request?: protos.google.cloud.compute.v1.IListSnapshotsRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ISnapshot[],
protos.google.cloud.compute.v1.IListSnapshotsRequest | null,
protos.google.cloud.compute.v1.ISnapshotList
]>;
Retrieves the list of Snapshot resources contained within the specified project.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListSnapshotsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ISnapshot[],
protos.google.cloud.compute.v1.IListSnapshotsRequest | null,
protos.google.cloud.compute.v1.ISnapshotList
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Snapshot]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
list(request, options, callback)
list(request: protos.google.cloud.compute.v1.IListSnapshotsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListSnapshotsRequest, protos.google.cloud.compute.v1.ISnapshotList | null | undefined, protos.google.cloud.compute.v1.ISnapshot>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListSnapshotsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.compute.v1.IListSnapshotsRequest, protos.google.cloud.compute.v1.ISnapshotList | null | undefined, protos.google.cloud.compute.v1.ISnapshot>
|
Returns
list(request, callback)
list(request: protos.google.cloud.compute.v1.IListSnapshotsRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListSnapshotsRequest, protos.google.cloud.compute.v1.ISnapshotList | null | undefined, protos.google.cloud.compute.v1.ISnapshot>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListSnapshotsRequest
|
callback |
PaginationCallback<protos.google.cloud.compute.v1.IListSnapshotsRequest, protos.google.cloud.compute.v1.ISnapshotList | null | undefined, protos.google.cloud.compute.v1.ISnapshot>
|
Returns
listAsync(request, options)
listAsync(request?: protos.google.cloud.compute.v1.IListSnapshotsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.ISnapshot>;
Equivalent to list
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListSnapshotsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.ISnapshot> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Snapshot]. 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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. 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) ```
*/
// 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 a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, 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 the `creationTimestamp` 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 by `name` or `creationTimestamp desc` is supported.
*/
// const orderBy = 'abc123'
/**
* Specifies a page token to use. Set `pageToken` to the `nextPageToken` 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.
*/
// const returnPartialSuccess = true
// Imports the Compute library
const {SnapshotsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new SnapshotsClient();
async function callList() {
// Construct request
const request = {
project,
};
// Run request
const iterable = await computeClient.listAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callList();
listStream(request, options)
listStream(request?: protos.google.cloud.compute.v1.IListSnapshotsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListSnapshotsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Snapshot] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
setIamPolicy(request, options)
setIamPolicy(request?: protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IPolicy,
protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest | undefined,
{} | undefined
]>;
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.IPolicy,
protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
|
Example
/**
* 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 library
const {SnapshotsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new SnapshotsClient();
async function callSetIamPolicy() {
// Construct request
const request = {
globalSetPolicyRequestResource,
project,
resource,
};
// Run request
const response = await computeClient.setIamPolicy(request);
console.log(response);
}
callSetIamPolicy();
setIamPolicy(request, options, callback)
setIamPolicy(request: protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, callback)
setIamPolicy(request: protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicySnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
setLabels(request, options)
setLabels(request?: protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The body resource for this request
*/
// const globalSetLabelsRequestResource = {}
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name or id of the resource for this request.
*/
// const resource = 'abc123'
// Imports the Compute library
const {SnapshotsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new SnapshotsClient();
async function callSetLabels() {
// Construct request
const request = {
globalSetLabelsRequestResource,
project,
resource,
};
// Run request
const response = await computeClient.setLabels(request);
console.log(response);
}
callSetLabels();
setLabels(request, options, callback)
setLabels(request: protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
setLabels(request, callback)
setLabels(request: protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, options)
testIamPermissions(request?: protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ITestPermissionsResponse,
(protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest | undefined),
{} | undefined
]>;
Returns permissions that a caller has on the specified resource.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ITestPermissionsResponse,
(protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestPermissionsResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
|
Example
/**
* 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 library
const {SnapshotsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new SnapshotsClient();
async function callTestIamPermissions() {
// Construct request
const request = {
project,
resource,
testPermissionsRequestResource,
};
// Run request
const response = await computeClient.testIamPermissions(request);
console.log(response);
}
callTestIamPermissions();
testIamPermissions(request, options, callback)
testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, callback)
testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest
|
callback |
Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest | null | undefined, {} | null | undefined>
|
Returns