API Overview:
The beyondcorp.googleapis.com
service implements the Google Cloud BeyondCorp API.
Data Model:
The ClientGatewaysService exposes the following resources:
* Client Gateways, named as follows: projects/{project_id}/locations/{location_id}/clientGateways/{client_gateway_id}
. v1
Package
@google-cloud/clientgatewaysConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of ClientGatewaysServiceClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof gax.fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
clientGatewaysServiceStub
clientGatewaysServiceStub?: Promise<{
[name: string]: Function;
}>;
descriptors
descriptors: Descriptors;
iamClient
iamClient: IamClient;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
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.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
protos.google.longrunning.CancelOperationRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkCreateClientGatewayProgress(name)
checkCreateClientGatewayProgress(name: string): Promise<LROperation<protos.google.cloud.beyondcorp.clientgateways.v1.ClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.ClientGatewayOperationMetadata>>;
Check the status of the long running operation returned by createClientGateway()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.beyondcorp.clientgateways.v1.ClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.ClientGatewayOperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Optional. User-settable client gateway resource ID.
* * Must start with a letter.
* * Must contain between 4-63 characters from `/[a-z][0-9]-/`.
* * Must end with a number or a letter.
*/
// const clientGatewayId = 'abc123'
/**
* Required. The resource being created.
*/
// const clientGateway = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and t
* he 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'
/**
* Optional. If set, validates request by executing a dry-run which would not
* alter the resource in any way.
*/
// const validateOnly = true
// Imports the Clientgateways library
const {ClientGatewaysServiceClient} = require('@google-cloud/clientgateways').v1;
// Instantiates a client
const clientgatewaysClient = new ClientGatewaysServiceClient();
async function callCreateClientGateway() {
// Construct request
const request = {
parent,
clientGateway,
};
// Run request
const [operation] = await clientgatewaysClient.createClientGateway(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateClientGateway();
checkDeleteClientGatewayProgress(name)
checkDeleteClientGatewayProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.beyondcorp.clientgateways.v1.ClientGatewayOperationMetadata>>;
Check the status of the long running operation returned by deleteClientGateway()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.beyondcorp.clientgateways.v1.ClientGatewayOperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and t
* he 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'
/**
* Optional. If set, validates request by executing a dry-run which would not
* alter the resource in any way.
*/
// const validateOnly = true
// Imports the Clientgateways library
const {ClientGatewaysServiceClient} = require('@google-cloud/clientgateways').v1;
// Instantiates a client
const clientgatewaysClient = new ClientGatewaysServiceClient();
async function callDeleteClientGateway() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await clientgatewaysClient.deleteClientGateway(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteClientGateway();
clientGatewayPath(project, location, clientGateway)
clientGatewayPath(project: string, location: string, clientGateway: string): string;
Return a fully-qualified clientGateway resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
clientGateway |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createClientGateway(request, options)
createClientGateway(request?: protos.google.cloud.beyondcorp.clientgateways.v1.ICreateClientGatewayRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new ClientGateway in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.ICreateClientGatewayRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* 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.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Optional. User-settable client gateway resource ID.
* * Must start with a letter.
* * Must contain between 4-63 characters from `/[a-z][0-9]-/`.
* * Must end with a number or a letter.
*/
// const clientGatewayId = 'abc123'
/**
* Required. The resource being created.
*/
// const clientGateway = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and t
* he 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'
/**
* Optional. If set, validates request by executing a dry-run which would not
* alter the resource in any way.
*/
// const validateOnly = true
// Imports the Clientgateways library
const {ClientGatewaysServiceClient} = require('@google-cloud/clientgateways').v1;
// Instantiates a client
const clientgatewaysClient = new ClientGatewaysServiceClient();
async function callCreateClientGateway() {
// Construct request
const request = {
parent,
clientGateway,
};
// Run request
const [operation] = await clientgatewaysClient.createClientGateway(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateClientGateway();
createClientGateway(request, options, callback)
createClientGateway(request: protos.google.cloud.beyondcorp.clientgateways.v1.ICreateClientGatewayRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.ICreateClientGatewayRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createClientGateway(request, callback)
createClientGateway(request: protos.google.cloud.beyondcorp.clientgateways.v1.ICreateClientGatewayRequest, callback: Callback<LROperation<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.ICreateClientGatewayRequest
|
callback |
Callback<LROperation<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteClientGateway(request, options)
deleteClientGateway(request?: protos.google.cloud.beyondcorp.clientgateways.v1.IDeleteClientGatewayRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a single ClientGateway.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IDeleteClientGatewayRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* 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.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and t
* he 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'
/**
* Optional. If set, validates request by executing a dry-run which would not
* alter the resource in any way.
*/
// const validateOnly = true
// Imports the Clientgateways library
const {ClientGatewaysServiceClient} = require('@google-cloud/clientgateways').v1;
// Instantiates a client
const clientgatewaysClient = new ClientGatewaysServiceClient();
async function callDeleteClientGateway() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await clientgatewaysClient.deleteClientGateway(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteClientGateway();
deleteClientGateway(request, options, callback)
deleteClientGateway(request: protos.google.cloud.beyondcorp.clientgateways.v1.IDeleteClientGatewayRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IDeleteClientGatewayRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteClientGateway(request, callback)
deleteClientGateway(request: protos.google.cloud.beyondcorp.clientgateways.v1.IDeleteClientGatewayRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IDeleteClientGatewayRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
protos.google.longrunning.DeleteOperationRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
getClientGateway(request, options)
getClientGateway(request?: protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest, options?: CallOptions): Promise<[
protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway,
(protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest | undefined),
{} | undefined
]>;
Gets details of a single ClientGateway.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway,
(protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
// Imports the Clientgateways library
const {ClientGatewaysServiceClient} = require('@google-cloud/clientgateways').v1;
// Instantiates a client
const clientgatewaysClient = new ClientGatewaysServiceClient();
async function callGetClientGateway() {
// Construct request
const request = {
name,
};
// Run request
const response = await clientgatewaysClient.getClientGateway(request);
console.log(response);
}
callGetClientGateway();
getClientGateway(request, options, callback)
getClientGateway(request: protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest, options: CallOptions, callback: Callback<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getClientGateway(request, callback)
getClientGateway(request: protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest, callback: Callback<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest
|
callback |
Callback<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway, protos.google.cloud.beyondcorp.clientgateways.v1.IGetClientGatewayRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getIamPolicy(request, options, callback)
getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.Policy>;
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
request |
IamProtos.google.iam.v1.GetIamPolicyRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
Returns | |
---|---|
Type | Description |
Promise<IamProtos.google.iam.v1.Policy> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details. |
callback |
Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
Promise<LocationProtos.google.cloud.location.ILocation> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
const [response] = await client.getLocation(request);
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
protos.google.longrunning.GetOperationRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
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. |
listClientGateways(request, options)
listClientGateways(request?: protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, options?: CallOptions): Promise<[
protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway[],
protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest | null,
protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysResponse
]>;
Lists ClientGateways in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway[],
protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest | null,
protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listClientGateways(request, options, callback)
listClientGateways(request: protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysResponse | null | undefined, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysResponse | null | undefined, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway>
|
Returns | |
---|---|
Type | Description |
void |
listClientGateways(request, callback)
listClientGateways(request: protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, callback: PaginationCallback<protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysResponse | null | undefined, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest
|
callback |
PaginationCallback<protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysResponse | null | undefined, protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway>
|
Returns | |
---|---|
Type | Description |
void |
listClientGatewaysAsync(request, options)
listClientGatewaysAsync(request?: protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway>;
Equivalent to listClientGateways
, 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.beyondcorp.clientgateways.v1.IListClientGatewaysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.beyondcorp.clientgateways.v1.IClientGateway> | {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 . 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. |
/**
* 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.
*/
/**
* Required. Parent value for ListClientGatewaysRequest.
*/
// const parent = 'abc123'
/**
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* Optional. A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
/**
* Optional. Filtering results.
*/
// const filter = 'abc123'
/**
* Optional. Hint for how to order the results.
*/
// const orderBy = 'abc123'
// Imports the Clientgateways library
const {ClientGatewaysServiceClient} = require('@google-cloud/clientgateways').v1;
// Instantiates a client
const clientgatewaysClient = new ClientGatewaysServiceClient();
async function callListClientGateways() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await clientgatewaysClient.listClientGatewaysAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListClientGateways();
listClientGatewaysStream(request, options)
listClientGatewaysStream(request?: protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.beyondcorp.clientgateways.v1.IListClientGatewaysRequest
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 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 |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
Lists information about the supported locations for this service. Returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<LocationProtos.google.cloud.location.ILocation> | {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 . 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. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters | |
---|---|
Name | Description |
request |
protos.google.longrunning.ListOperationsRequest
The request object that will be sent. |
options |
gax.CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> | {Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
matchClientGatewayFromClientGatewayName(clientGatewayName)
matchClientGatewayFromClientGatewayName(clientGatewayName: string): string | number;
Parse the client_gateway from ClientGateway resource.
Parameter | |
---|---|
Name | Description |
clientGatewayName |
string
A fully-qualified path representing ClientGateway resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the client_gateway. |
matchLocationFromClientGatewayName(clientGatewayName)
matchLocationFromClientGatewayName(clientGatewayName: string): string | number;
Parse the location from ClientGateway resource.
Parameter | |
---|---|
Name | Description |
clientGatewayName |
string
A fully-qualified path representing ClientGateway resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter | |
---|---|
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchProjectFromClientGatewayName(clientGatewayName)
matchProjectFromClientGatewayName(clientGatewayName: string): string | number;
Parse the project from ClientGateway resource.
Parameter | |
---|---|
Name | Description |
clientGatewayName |
string
A fully-qualified path representing ClientGateway resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter | |
---|---|
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Parameter | |
---|---|
Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
setIamPolicy(request, options, callback)
setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.Policy>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
IamProtos.google.iam.v1.SetIamPolicyRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
Returns | |
---|---|
Type | Description |
Promise<IamProtos.google.iam.v1.Policy> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
testIamPermissions(request, options, callback)
testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.TestIamPermissionsResponse>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
IamProtos.google.iam.v1.TestIamPermissionsRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
Returns | |
---|---|
Type | Description |
Promise<IamProtos.google.iam.v1.TestIamPermissionsResponse> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |