@google-cloud/dialogflow-cx
Version:
967 lines (966 loc) • 92.2 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* Service for managing security settings for Dialogflow.
* @class
* @memberof v3
*/
export declare class SecuritySettingsServiceClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
locationsClient: LocationsClient;
pathTemplates: {
[name: string]: gax.PathTemplate;
};
operationsClient: gax.OperationsClient;
securitySettingsServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of SecuritySettingsServiceClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-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 SecuritySettingsServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* 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 {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Create security settings in the specified location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The location to create an
* {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings} for.
* Format: `projects/<ProjectID>/locations/<LocationID>`.
* @param {google.cloud.dialogflow.cx.v3.SecuritySettings} request.securitySettings
* Required. The security settings to create.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/security_settings_service.create_security_settings.js</caption>
* region_tag:dialogflow_v3_generated_SecuritySettingsService_CreateSecuritySettings_async
*/
createSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3.ICreateSecuritySettingsRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.cx.v3.ISecuritySettings,
protos.google.cloud.dialogflow.cx.v3.ICreateSecuritySettingsRequest | undefined,
{} | undefined
]>;
createSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.ICreateSecuritySettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3.ICreateSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;
createSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.ICreateSecuritySettingsRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3.ICreateSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;
/**
* Retrieves the specified
* {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings}. The
* returned settings may be stale by up to 1 minute.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. Resource name of the settings.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/securitySettings/<securitysettingsID>`.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/security_settings_service.get_security_settings.js</caption>
* region_tag:dialogflow_v3_generated_SecuritySettingsService_GetSecuritySettings_async
*/
getSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3.IGetSecuritySettingsRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.cx.v3.ISecuritySettings,
protos.google.cloud.dialogflow.cx.v3.IGetSecuritySettingsRequest | undefined,
{} | undefined
]>;
getSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.IGetSecuritySettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3.IGetSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;
getSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.IGetSecuritySettingsRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3.IGetSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;
/**
* Updates the specified
* {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings}.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.dialogflow.cx.v3.SecuritySettings} request.securitySettings
* Required. [SecuritySettings] object that contains values for each of the
* fields to update.
* @param {google.protobuf.FieldMask} request.updateMask
* Required. The mask to control which fields get updated. If the mask is not
* present, all fields will be updated.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/security_settings_service.update_security_settings.js</caption>
* region_tag:dialogflow_v3_generated_SecuritySettingsService_UpdateSecuritySettings_async
*/
updateSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3.IUpdateSecuritySettingsRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.cx.v3.ISecuritySettings,
protos.google.cloud.dialogflow.cx.v3.IUpdateSecuritySettingsRequest | undefined,
{} | undefined
]>;
updateSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.IUpdateSecuritySettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3.IUpdateSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;
updateSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.IUpdateSecuritySettingsRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3.IUpdateSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes the specified
* {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings}.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the
* {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings} to
* delete. Format:
* `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/security_settings_service.delete_security_settings.js</caption>
* region_tag:dialogflow_v3_generated_SecuritySettingsService_DeleteSecuritySettings_async
*/
deleteSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3.IDeleteSecuritySettingsRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.dialogflow.cx.v3.IDeleteSecuritySettingsRequest | undefined,
{} | undefined
]>;
deleteSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.IDeleteSecuritySettingsRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;
deleteSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.IDeleteSecuritySettingsRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;
/**
* Returns the list of all security settings in the specified location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The location to list all security settings for.
* Format: `projects/<ProjectID>/locations/<LocationID>`.
* @param {number} request.pageSize
* The maximum number of items to return in a single page. By default 20 and
* at most 100.
* @param {string} request.pageToken
* The next_page_token value returned from a previous list request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings}.
* 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 `listSecuritySettingsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.cx.v3.ISecuritySettings[],
protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsRequest | null,
protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsResponse
]>;
listSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsRequest, protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.ISecuritySettings>): void;
listSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsRequest, protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.ISecuritySettings>): void;
/**
* Equivalent to `listSecuritySettings`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The location to list all security settings for.
* Format: `projects/<ProjectID>/locations/<LocationID>`.
* @param {number} request.pageSize
* The maximum number of items to return in a single page. By default 20 and
* at most 100.
* @param {string} request.pageToken
* The next_page_token value returned from a previous list request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings} 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 `listSecuritySettingsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listSecuritySettingsStream(request?: protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listSecuritySettings`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The location to list all security settings for.
* Format: `projects/<ProjectID>/locations/<LocationID>`.
* @param {number} request.pageSize
* The maximum number of items to return in a single page. By default 20 and
* at most 100.
* @param {string} request.pageToken
* The next_page_token value returned from a previous list request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.dialogflow.cx.v3.SecuritySettings|SecuritySettings}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/security_settings_service.list_security_settings.js</caption>
* region_tag:dialogflow_v3_generated_SecuritySettingsService_ListSecuritySettings_async
*/
listSecuritySettingsAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListSecuritySettingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.ISecuritySettings>;
/**
* Gets information about a location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Resource name for the location.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example
* ```
* const [response] = await client.getLocation(request);
* ```
*/
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>;
/**
* 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.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The resource that owns the locations collection, if applicable.
* @param {string} request.filter
* The standard list filter.
* @param {number} request.pageSize
* The standard list page size.
* @param {string} request.pageToken
* The standard list page token.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link google.cloud.location.Location | Location}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example
* ```
* const iterable = client.listLocationsAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
/**
* 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.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback
* The function which will be called with the result of the API call.
*
* The second parameter to the callback is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* const name = '';
* const [response] = await client.getOperation({name});
* // doThingsWith(response)
* ```
*/
getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: 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]>;
/**
* 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.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation collection.
* @param {string} request.filter - The standard list filter.
* @param {number=} request.pageSize -
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*
* @example
* ```
* const client = longrunning.operationsClient();
* for await (const response of client.listOperationsAsync(request));
* // doThingsWith(response)
* ```
*/
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
/**
* 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
* {@link Operations.GetOperation} 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 {@link Operation.error} value with a {@link google.rpc.Status.code} of
* 1, corresponding to `Code.CANCELLED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be cancelled.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.cancelOperation({name: ''});
* ```
*/
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): 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`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be deleted.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.deleteOperation({name: ''});
* ```
*/
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: 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>;
/**
* Return a fully-qualified agent resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @returns {string} Resource name string.
*/
agentPath(project: string, location: string, agent: string): string;
/**
* Parse the project from Agent resource.
*
* @param {string} agentName
* A fully-qualified path representing Agent resource.
* @returns {string} A string representing the project.
*/
matchProjectFromAgentName(agentName: string): string | number;
/**
* Parse the location from Agent resource.
*
* @param {string} agentName
* A fully-qualified path representing Agent resource.
* @returns {string} A string representing the location.
*/
matchLocationFromAgentName(agentName: string): string | number;
/**
* Parse the agent from Agent resource.
*
* @param {string} agentName
* A fully-qualified path representing Agent resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromAgentName(agentName: string): string | number;
/**
* Return a fully-qualified agentGenerativeSettings resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @returns {string} Resource name string.
*/
agentGenerativeSettingsPath(project: string, location: string, agent: string): string;
/**
* Parse the project from AgentGenerativeSettings resource.
*
* @param {string} agentGenerativeSettingsName
* A fully-qualified path representing AgentGenerativeSettings resource.
* @returns {string} A string representing the project.
*/
matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
/**
* Parse the location from AgentGenerativeSettings resource.
*
* @param {string} agentGenerativeSettingsName
* A fully-qualified path representing AgentGenerativeSettings resource.
* @returns {string} A string representing the location.
*/
matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
/**
* Parse the agent from AgentGenerativeSettings resource.
*
* @param {string} agentGenerativeSettingsName
* A fully-qualified path representing AgentGenerativeSettings resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
/**
* Return a fully-qualified agentValidationResult resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @returns {string} Resource name string.
*/
agentValidationResultPath(project: string, location: string, agent: string): string;
/**
* Parse the project from AgentValidationResult resource.
*
* @param {string} agentValidationResultName
* A fully-qualified path representing AgentValidationResult resource.
* @returns {string} A string representing the project.
*/
matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;
/**
* Parse the location from AgentValidationResult resource.
*
* @param {string} agentValidationResultName
* A fully-qualified path representing AgentValidationResult resource.
* @returns {string} A string representing the location.
*/
matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;
/**
* Parse the agent from AgentValidationResult resource.
*
* @param {string} agentValidationResultName
* A fully-qualified path representing AgentValidationResult resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;
/**
* Return a fully-qualified changelog resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} changelog
* @returns {string} Resource name string.
*/
changelogPath(project: string, location: string, agent: string, changelog: string): string;
/**
* Parse the project from Changelog resource.
*
* @param {string} changelogName
* A fully-qualified path representing Changelog resource.
* @returns {string} A string representing the project.
*/
matchProjectFromChangelogName(changelogName: string): string | number;
/**
* Parse the location from Changelog resource.
*
* @param {string} changelogName
* A fully-qualified path representing Changelog resource.
* @returns {string} A string representing the location.
*/
matchLocationFromChangelogName(changelogName: string): string | number;
/**
* Parse the agent from Changelog resource.
*
* @param {string} changelogName
* A fully-qualified path representing Changelog resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromChangelogName(changelogName: string): string | number;
/**
* Parse the changelog from Changelog resource.
*
* @param {string} changelogName
* A fully-qualified path representing Changelog resource.
* @returns {string} A string representing the changelog.
*/
matchChangelogFromChangelogName(changelogName: string): string | number;
/**
* Return a fully-qualified continuousTestResult resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} environment
* @param {string} continuous_test_result
* @returns {string} Resource name string.
*/
continuousTestResultPath(project: string, location: string, agent: string, environment: string, continuousTestResult: string): string;
/**
* Parse the project from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the project.
*/
matchProjectFromContinuousTestResultName(continuousTestResultName: string): string | number;
/**
* Parse the location from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the location.
*/
matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;
/**
* Parse the agent from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;
/**
* Parse the environment from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;
/**
* Parse the continuous_test_result from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the continuous_test_result.
*/
matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName: string): string | number;
/**
* Return a fully-qualified deployment resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} environment
* @param {string} deployment
* @returns {string} Resource name string.
*/
deploymentPath(project: string, location: string, agent: string, environment: string, deployment: string): string;
/**
* Parse the project from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDeploymentName(deploymentName: string): string | number;
/**
* Parse the location from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDeploymentName(deploymentName: string): string | number;
/**
* Parse the agent from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromDeploymentName(deploymentName: string): string | number;
/**
* Parse the environment from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromDeploymentName(deploymentName: string): string | number;
/**
* Parse the deployment from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the deployment.
*/
matchDeploymentFromDeploymentName(deploymentName: string): string | number;
/**
* Return a fully-qualified entityType resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} entity_type
* @returns {string} Resource name string.
*/
entityTypePath(project: string, location: string, agent: string, entityType: string): string;
/**
* Parse the project from EntityType resource.
*
* @param {string} entityTypeName
* A fully-qualified path representing EntityType resource.
* @returns {string} A string representing the project.
*/
matchProjectFromEntityTypeName(entityTypeName: string): string | number;
/**
* Parse the location from EntityType resource.
*
* @param {string} entityTypeName
* A fully-qualified path representing EntityType resource.
* @returns {string} A string representing the location.
*/
matchLocationFromEntityTypeName(entityTypeName: string): string | number;
/**
* Parse the agent from EntityType resource.
*
* @param {string} entityTypeName
* A fully-qualified path representing EntityType resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromEntityTypeName(entityTypeName: string): string | number;
/**
* Parse the entity_type from EntityType resource.
*
* @param {string} entityTypeName
* A fully-qualified path representing EntityType resource.
* @returns {string} A string representing the entity_type.
*/
matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;
/**
* Return a fully-qualified environment resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} environment
* @returns {string} Resource name string.
*/
environmentPath(project: string, location: string, agent: string, environment: string): string;
/**
* Parse the project from Environment resource.
*
* @param {string} environmentName
* A fully-qualified path representing Environment resource.
* @returns {string} A string representing the project.
*/
matchProjectFromEnvironmentName(environmentName: string): string | number;
/**
* Parse the location from Environment resource.
*
* @param {string} environmentName
* A fully-qualified path representing Environment resource.
* @returns {string} A string representing the location.
*/
matchLocationFromEnvironmentName(environmentName: string): string | number;
/**
* Parse the agent from Environment resource.
*
* @param {string} environmentName
* A fully-qualified path representing Environment resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromEnvironmentName(environmentName: string): string | number;
/**
* Parse the environment from Environment resource.
*
* @param {string} environmentName
* A fully-qualified path representing Environment resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromEnvironmentName(environmentName: string): string | number;
/**
* Return a fully-qualified example resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} playbook
* @param {string} example
* @returns {string} Resource name string.
*/
examplePath(project: string, location: string, agent: string, playbook: string, example: string): string;
/**
* Parse the project from Example resource.
*
* @param {string} exampleName
* A fully-qualified path representing Example resource.
* @returns {string} A string representing the project.
*/
matchProjectFromExampleName(exampleName: string): string | number;
/**
* Parse the location from Example resource.
*
* @param {string} exampleName
* A fully-qualified path representing Example resource.
* @returns {string} A string representing the location.
*/
matchLocationFromExampleName(exampleName: string): string | number;
/**
* Parse the agent from Example resource.
*
* @param {string} exampleName
* A fully-qualified path representing Example resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromExampleName(exampleName: string): string | number;
/**
* Parse the playbook from Example resource.
*
* @param {string} exampleName
* A fully-qualified path representing Example resource.
* @returns {string} A string representing the playbook.
*/
matchPlaybookFromExampleName(exampleName: string): string | number;
/**
* Parse the example from Example resource.
*
* @param {string} exampleName
* A fully-qualified path representing Example resource.
* @returns {string} A string representing the example.
*/
matchExampleFromExampleName(exampleName: string): string | number;
/**
* Return a fully-qualified experiment resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} environment
* @param {string} experiment
* @returns {string} Resource name string.
*/
experimentPath(project: string, location: string, agent: string, environment: string, experiment: string): string;
/**
* Parse the project from Experiment resource.
*
* @param {string} experimentName
* A fully-qualified path representing Experiment resource.
* @returns {string} A string representing the project.
*/
matchProjectFromExperimentName(experimentName: string): string | number;
/**
* Parse the location from Experiment resource.
*
* @param {string} experimentName
* A fully-qualified path representing Experiment resource.
* @returns {string} A string representing the location.
*/
matchLocationFromExperimentName(experimentName: string): string | number;
/**
* Parse the agent from Experiment resource.
*
* @param {string} experimentName
* A fully-qualified path representing Experiment resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromExperimentName(experimentName: string): string | number;
/**
* Parse the environment from Experiment resource.
*
* @param {string} experimentName
* A fully-qualified path representing Experiment resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromExperimentName(experimentName: string): string | number;
/**
* Parse the experiment from Experiment resource.
*
* @param {string} experimentName
* A fully-qualified path representing Experiment resource.
* @returns {string} A string representing the experiment.
*/
matchExperimentFromExperimentName(experimentName: string): string | number;
/**
* Return a fully-qualified flow resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} flow
* @returns {string} Resource name string.
*/
flowPath(project: string, location: string, agent: string, flow: string): string;
/**
* Parse the project from Flow resource.
*
* @param {string} flowName
* A fully-qualified path representing Flow resource.
* @returns {string} A string representing the project.
*/
matchProjectFromFlowName(flowName: string): string | number;
/**
* Parse the location from Flow resource.
*
* @param {string} flowName
* A fully-qualified path representing Flow resource.
* @returns {string} A string representing the location.
*/
matchLocationFromFlowName(flowName: string): string | number;
/**
* Parse the agent from Flow resource.
*
* @param {string} flowName
* A fully-qualified path representing Flow resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromFlowName(flowName: string): string | number;
/**
* Parse the flow from Flow resource.
*
* @param {string} flowName
* A fully-qualified path representing Flow resource.
* @returns {string} A string representing the flow.
*/
matchFlowFromFlowName(flowName: string): string | number;
/**
* Return a fully-qualified flowValidationResult resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} flow
* @returns {string} Resource name string.
*/
flowValidationResultPath(project: string, location: string, agent: string, flow: string): string;
/**
* Parse the project from FlowValidationResult resource.
*