import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, IamClient, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Dataform is a service to develop, create, document, test, and update curated * tables in BigQuery. * @class * @memberof v1 */ export declare class DataformClient { 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; }; iamClient: IamClient; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; dataformStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of DataformClient. * * @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 DataformClient({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; getProjectId(callback: Callback): void; /** * Fetches a single TeamFolder. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The TeamFolder's name. * @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.dataform.v1.TeamFolder|TeamFolder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_team_folder.js * region_tag:dataform_v1_generated_Dataform_GetTeamFolder_async */ getTeamFolder(request?: protos.google.cloud.dataform.v1.IGetTeamFolderRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ITeamFolder, protos.google.cloud.dataform.v1.IGetTeamFolderRequest | undefined, {} | undefined ]>; getTeamFolder(request: protos.google.cloud.dataform.v1.IGetTeamFolderRequest, options: CallOptions, callback: Callback): void; getTeamFolder(request: protos.google.cloud.dataform.v1.IGetTeamFolderRequest, callback: Callback): void; /** * Creates a new TeamFolder in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The location in which to create the TeamFolder. Must be in the * format `projects/* /locations/*`. * @param {google.cloud.dataform.v1.TeamFolder} request.teamFolder * Required. The TeamFolder 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.dataform.v1.TeamFolder|TeamFolder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.create_team_folder.js * region_tag:dataform_v1_generated_Dataform_CreateTeamFolder_async */ createTeamFolder(request?: protos.google.cloud.dataform.v1.ICreateTeamFolderRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ITeamFolder, protos.google.cloud.dataform.v1.ICreateTeamFolderRequest | undefined, {} | undefined ]>; createTeamFolder(request: protos.google.cloud.dataform.v1.ICreateTeamFolderRequest, options: CallOptions, callback: Callback): void; createTeamFolder(request: protos.google.cloud.dataform.v1.ICreateTeamFolderRequest, callback: Callback): void; /** * Updates a single TeamFolder. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Specifies the fields to be updated in the Folder. If left unset, * all fields will be updated. * @param {google.cloud.dataform.v1.TeamFolder} request.teamFolder * Required. The updated TeamFolder. * @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.dataform.v1.TeamFolder|TeamFolder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.update_team_folder.js * region_tag:dataform_v1_generated_Dataform_UpdateTeamFolder_async */ updateTeamFolder(request?: protos.google.cloud.dataform.v1.IUpdateTeamFolderRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ITeamFolder, protos.google.cloud.dataform.v1.IUpdateTeamFolderRequest | undefined, {} | undefined ]>; updateTeamFolder(request: protos.google.cloud.dataform.v1.IUpdateTeamFolderRequest, options: CallOptions, callback: Callback): void; updateTeamFolder(request: protos.google.cloud.dataform.v1.IUpdateTeamFolderRequest, callback: Callback): void; /** * Deletes a single TeamFolder. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The TeamFolder's name. * @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 include:samples/generated/v1/dataform.delete_team_folder.js * region_tag:dataform_v1_generated_Dataform_DeleteTeamFolder_async */ deleteTeamFolder(request?: protos.google.cloud.dataform.v1.IDeleteTeamFolderRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataform.v1.IDeleteTeamFolderRequest | undefined, {} | undefined ]>; deleteTeamFolder(request: protos.google.cloud.dataform.v1.IDeleteTeamFolderRequest, options: CallOptions, callback: Callback): void; deleteTeamFolder(request: protos.google.cloud.dataform.v1.IDeleteTeamFolderRequest, callback: Callback): void; /** * Fetches a single Folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The Folder's name. * @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.dataform.v1.Folder|Folder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_folder.js * region_tag:dataform_v1_generated_Dataform_GetFolder_async */ getFolder(request?: protos.google.cloud.dataform.v1.IGetFolderRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IFolder, protos.google.cloud.dataform.v1.IGetFolderRequest | undefined, {} | undefined ]>; getFolder(request: protos.google.cloud.dataform.v1.IGetFolderRequest, options: CallOptions, callback: Callback): void; getFolder(request: protos.google.cloud.dataform.v1.IGetFolderRequest, callback: Callback): void; /** * Creates a new Folder in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The location in which to create the Folder. Must be in the format * `projects/* /locations/*`. * @param {google.cloud.dataform.v1.Folder} request.folder * Required. The Folder 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.dataform.v1.Folder|Folder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.create_folder.js * region_tag:dataform_v1_generated_Dataform_CreateFolder_async */ createFolder(request?: protos.google.cloud.dataform.v1.ICreateFolderRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IFolder, protos.google.cloud.dataform.v1.ICreateFolderRequest | undefined, {} | undefined ]>; createFolder(request: protos.google.cloud.dataform.v1.ICreateFolderRequest, options: CallOptions, callback: Callback): void; createFolder(request: protos.google.cloud.dataform.v1.ICreateFolderRequest, callback: Callback): void; /** * Updates a single Folder. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Specifies the fields to be updated in the Folder. If left unset, * all fields that can be updated, will be updated. A few fields cannot be * updated and will be ignored if specified in the update_mask (e.g. * parent_name, team_folder_name). * @param {google.cloud.dataform.v1.Folder} request.folder * Required. The updated Folder. * @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.dataform.v1.Folder|Folder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.update_folder.js * region_tag:dataform_v1_generated_Dataform_UpdateFolder_async */ updateFolder(request?: protos.google.cloud.dataform.v1.IUpdateFolderRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IFolder, protos.google.cloud.dataform.v1.IUpdateFolderRequest | undefined, {} | undefined ]>; updateFolder(request: protos.google.cloud.dataform.v1.IUpdateFolderRequest, options: CallOptions, callback: Callback): void; updateFolder(request: protos.google.cloud.dataform.v1.IUpdateFolderRequest, callback: Callback): void; /** * Deletes a single Folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The Folder's name. * @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 include:samples/generated/v1/dataform.delete_folder.js * region_tag:dataform_v1_generated_Dataform_DeleteFolder_async */ deleteFolder(request?: protos.google.cloud.dataform.v1.IDeleteFolderRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataform.v1.IDeleteFolderRequest | undefined, {} | undefined ]>; deleteFolder(request: protos.google.cloud.dataform.v1.IDeleteFolderRequest, options: CallOptions, callback: Callback): void; deleteFolder(request: protos.google.cloud.dataform.v1.IDeleteFolderRequest, callback: Callback): void; /** * Fetches a single Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @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.dataform.v1.Repository|Repository}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_repository.js * region_tag:dataform_v1_generated_Dataform_GetRepository_async */ getRepository(request?: protos.google.cloud.dataform.v1.IGetRepositoryRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IRepository, protos.google.cloud.dataform.v1.IGetRepositoryRequest | undefined, {} | undefined ]>; getRepository(request: protos.google.cloud.dataform.v1.IGetRepositoryRequest, options: CallOptions, callback: Callback): void; getRepository(request: protos.google.cloud.dataform.v1.IGetRepositoryRequest, callback: Callback): void; /** * Creates a new Repository in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The location in which to create the repository. Must be in the * format `projects/* /locations/*`. * @param {google.cloud.dataform.v1.Repository} request.repository * Required. The repository to create. * @param {string} request.repositoryId * Required. The ID to use for the repository, which will become the final * component of the repository's resource name. * @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.dataform.v1.Repository|Repository}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.create_repository.js * region_tag:dataform_v1_generated_Dataform_CreateRepository_async */ createRepository(request?: protos.google.cloud.dataform.v1.ICreateRepositoryRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IRepository, protos.google.cloud.dataform.v1.ICreateRepositoryRequest | undefined, {} | undefined ]>; createRepository(request: protos.google.cloud.dataform.v1.ICreateRepositoryRequest, options: CallOptions, callback: Callback): void; createRepository(request: protos.google.cloud.dataform.v1.ICreateRepositoryRequest, callback: Callback): void; /** * Updates a single Repository. * * **Note:** *This method does not fully implement * [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated * as a bad request, and when the `field_mask` is omitted, the request is * treated as a full update on all modifiable fields.* * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Specifies the fields to be updated in the repository. If left * unset, all fields will be updated. * @param {google.cloud.dataform.v1.Repository} request.repository * Required. The repository to update. * @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.dataform.v1.Repository|Repository}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.update_repository.js * region_tag:dataform_v1_generated_Dataform_UpdateRepository_async */ updateRepository(request?: protos.google.cloud.dataform.v1.IUpdateRepositoryRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IRepository, protos.google.cloud.dataform.v1.IUpdateRepositoryRequest | undefined, {} | undefined ]>; updateRepository(request: protos.google.cloud.dataform.v1.IUpdateRepositoryRequest, options: CallOptions, callback: Callback): void; updateRepository(request: protos.google.cloud.dataform.v1.IUpdateRepositoryRequest, callback: Callback): void; /** * Deletes a single Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @param {boolean} [request.force] * Optional. If set to true, child resources of this repository (compilation * results and workflow invocations) will also be deleted. Otherwise, the * request will only succeed if the repository has no child resources. * * **Note:** *This flag doesn't support deletion of workspaces, release * configs or workflow configs. If any of such resources exists in the * repository, the request will fail.*. * @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 include:samples/generated/v1/dataform.delete_repository.js * region_tag:dataform_v1_generated_Dataform_DeleteRepository_async */ deleteRepository(request?: protos.google.cloud.dataform.v1.IDeleteRepositoryRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataform.v1.IDeleteRepositoryRequest | undefined, {} | undefined ]>; deleteRepository(request: protos.google.cloud.dataform.v1.IDeleteRepositoryRequest, options: CallOptions, callback: Callback): void; deleteRepository(request: protos.google.cloud.dataform.v1.IDeleteRepositoryRequest, callback: Callback): void; /** * Applies a Git commit to a Repository. The Repository must not have a value * for `git_remote_settings.url`. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @param {google.cloud.dataform.v1.CommitMetadata} request.commitMetadata * Required. The changes to commit to the repository. * @param {string} [request.requiredHeadCommitSha] * Optional. The commit SHA which must be the repository's current HEAD before * applying this commit; otherwise this request will fail. If unset, no * validation on the current HEAD commit SHA is performed. * @param {number[]} [request.fileOperations] * Optional. A map to the path of the file to the operation. The path is the * full file path including filename, from repository root. * @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.dataform.v1.CommitRepositoryChangesResponse|CommitRepositoryChangesResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.commit_repository_changes.js * region_tag:dataform_v1_generated_Dataform_CommitRepositoryChanges_async */ commitRepositoryChanges(request?: protos.google.cloud.dataform.v1.ICommitRepositoryChangesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ICommitRepositoryChangesResponse, (protos.google.cloud.dataform.v1.ICommitRepositoryChangesRequest | undefined), {} | undefined ]>; commitRepositoryChanges(request: protos.google.cloud.dataform.v1.ICommitRepositoryChangesRequest, options: CallOptions, callback: Callback): void; commitRepositoryChanges(request: protos.google.cloud.dataform.v1.ICommitRepositoryChangesRequest, callback: Callback): void; /** * Returns the contents of a file (inside a Repository). The Repository * must not have a value for `git_remote_settings.url`. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @param {string} [request.commitSha] * Optional. The commit SHA for the commit to read from. If unset, the file * will be read from HEAD. * @param {string} request.path * Required. Full file path to read including filename, from repository root. * @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.dataform.v1.ReadRepositoryFileResponse|ReadRepositoryFileResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.read_repository_file.js * region_tag:dataform_v1_generated_Dataform_ReadRepositoryFile_async */ readRepositoryFile(request?: protos.google.cloud.dataform.v1.IReadRepositoryFileRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IReadRepositoryFileResponse, protos.google.cloud.dataform.v1.IReadRepositoryFileRequest | undefined, {} | undefined ]>; readRepositoryFile(request: protos.google.cloud.dataform.v1.IReadRepositoryFileRequest, options: CallOptions, callback: Callback): void; readRepositoryFile(request: protos.google.cloud.dataform.v1.IReadRepositoryFileRequest, callback: Callback): void; /** * Computes a Repository's Git access token status. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @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.dataform.v1.ComputeRepositoryAccessTokenStatusResponse|ComputeRepositoryAccessTokenStatusResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.compute_repository_access_token_status.js * region_tag:dataform_v1_generated_Dataform_ComputeRepositoryAccessTokenStatus_async */ computeRepositoryAccessTokenStatus(request?: protos.google.cloud.dataform.v1.IComputeRepositoryAccessTokenStatusRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IComputeRepositoryAccessTokenStatusResponse, (protos.google.cloud.dataform.v1.IComputeRepositoryAccessTokenStatusRequest | undefined), {} | undefined ]>; computeRepositoryAccessTokenStatus(request: protos.google.cloud.dataform.v1.IComputeRepositoryAccessTokenStatusRequest, options: CallOptions, callback: Callback): void; computeRepositoryAccessTokenStatus(request: protos.google.cloud.dataform.v1.IComputeRepositoryAccessTokenStatusRequest, callback: Callback): void; /** * Fetches a Repository's remote branches. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @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.dataform.v1.FetchRemoteBranchesResponse|FetchRemoteBranchesResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.fetch_remote_branches.js * region_tag:dataform_v1_generated_Dataform_FetchRemoteBranches_async */ fetchRemoteBranches(request?: protos.google.cloud.dataform.v1.IFetchRemoteBranchesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IFetchRemoteBranchesResponse, protos.google.cloud.dataform.v1.IFetchRemoteBranchesRequest | undefined, {} | undefined ]>; fetchRemoteBranches(request: protos.google.cloud.dataform.v1.IFetchRemoteBranchesRequest, options: CallOptions, callback: Callback): void; fetchRemoteBranches(request: protos.google.cloud.dataform.v1.IFetchRemoteBranchesRequest, callback: Callback): void; /** * Fetches a single Workspace. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workspace's name. * @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.dataform.v1.Workspace|Workspace}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_workspace.js * region_tag:dataform_v1_generated_Dataform_GetWorkspace_async */ getWorkspace(request?: protos.google.cloud.dataform.v1.IGetWorkspaceRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkspace, protos.google.cloud.dataform.v1.IGetWorkspaceRequest | undefined, {} | undefined ]>; getWorkspace(request: protos.google.cloud.dataform.v1.IGetWorkspaceRequest, options: CallOptions, callback: Callback): void; getWorkspace(request: protos.google.cloud.dataform.v1.IGetWorkspaceRequest, callback: Callback): void; /** * Creates a new Workspace in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to create the workspace. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {google.cloud.dataform.v1.Workspace} request.workspace * Required. The workspace to create. * @param {string} request.workspaceId * Required. The ID to use for the workspace, which will become the final * component of the workspace's resource name. * @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.dataform.v1.Workspace|Workspace}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.create_workspace.js * region_tag:dataform_v1_generated_Dataform_CreateWorkspace_async */ createWorkspace(request?: protos.google.cloud.dataform.v1.ICreateWorkspaceRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkspace, protos.google.cloud.dataform.v1.ICreateWorkspaceRequest | undefined, {} | undefined ]>; createWorkspace(request: protos.google.cloud.dataform.v1.ICreateWorkspaceRequest, options: CallOptions, callback: Callback): void; createWorkspace(request: protos.google.cloud.dataform.v1.ICreateWorkspaceRequest, callback: Callback): void; /** * Deletes a single Workspace. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workspace resource's name. * @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 include:samples/generated/v1/dataform.delete_workspace.js * region_tag:dataform_v1_generated_Dataform_DeleteWorkspace_async */ deleteWorkspace(request?: protos.google.cloud.dataform.v1.IDeleteWorkspaceRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataform.v1.IDeleteWorkspaceRequest | undefined, {} | undefined ]>; deleteWorkspace(request: protos.google.cloud.dataform.v1.IDeleteWorkspaceRequest, options: CallOptions, callback: Callback): void; deleteWorkspace(request: protos.google.cloud.dataform.v1.IDeleteWorkspaceRequest, callback: Callback): void; /** * Installs dependency NPM packages (inside a Workspace). * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {google.cloud.dataform.v1.PipelineConfig} [request.pipelineConfig] * Optional. The pipeline options which defines the pipeline type and path * within the Git repository. * @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.dataform.v1.InstallNpmPackagesResponse|InstallNpmPackagesResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.install_npm_packages.js * region_tag:dataform_v1_generated_Dataform_InstallNpmPackages_async */ installNpmPackages(request?: protos.google.cloud.dataform.v1.IInstallNpmPackagesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IInstallNpmPackagesResponse, protos.google.cloud.dataform.v1.IInstallNpmPackagesRequest | undefined, {} | undefined ]>; installNpmPackages(request: protos.google.cloud.dataform.v1.IInstallNpmPackagesRequest, options: CallOptions, callback: Callback): void; installNpmPackages(request: protos.google.cloud.dataform.v1.IInstallNpmPackagesRequest, callback: Callback): void; /** * Pulls Git commits from the Repository's remote into a Workspace. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workspace's name. * @param {string} [request.remoteBranch] * Optional. The name of the branch in the Git remote from which to pull * commits. If left unset, the repository's default branch name will be used. * @param {google.cloud.dataform.v1.CommitAuthor} request.author * Required. The author of any merge commit which may be created as a result * of merging fetched Git commits into this workspace. * @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.dataform.v1.PullGitCommitsResponse|PullGitCommitsResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.pull_git_commits.js * region_tag:dataform_v1_generated_Dataform_PullGitCommits_async */ pullGitCommits(request?: protos.google.cloud.dataform.v1.IPullGitCommitsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IPullGitCommitsResponse, protos.google.cloud.dataform.v1.IPullGitCommitsRequest | undefined, {} | undefined ]>; pullGitCommits(request: protos.google.cloud.dataform.v1.IPullGitCommitsRequest, options: CallOptions, callback: Callback): void; pullGitCommits(request: protos.google.cloud.dataform.v1.IPullGitCommitsRequest, callback: Callback): void; /** * Pushes Git commits from a Workspace to the Repository's remote. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workspace's name. * @param {string} [request.remoteBranch] * Optional. The name of the branch in the Git remote to which commits should * be pushed. If left unset, the repository's default branch name will be * used. * @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.dataform.v1.PushGitCommitsResponse|PushGitCommitsResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.push_git_commits.js * region_tag:dataform_v1_generated_Dataform_PushGitCommits_async */ pushGitCommits(request?: protos.google.cloud.dataform.v1.IPushGitCommitsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IPushGitCommitsResponse, protos.google.cloud.dataform.v1.IPushGitCommitsRequest | undefined, {} | undefined ]>; pushGitCommits(request: protos.google.cloud.dataform.v1.IPushGitCommitsRequest, options: CallOptions, callback: Callback): void; pushGitCommits(request: protos.google.cloud.dataform.v1.IPushGitCommitsRequest, callback: Callback): void; /** * Fetches Git statuses for the files in a Workspace. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workspace's name. * @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.dataform.v1.FetchFileGitStatusesResponse|FetchFileGitStatusesResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.fetch_file_git_statuses.js * region_tag:dataform_v1_generated_Dataform_FetchFileGitStatuses_async */ fetchFileGitStatuses(request?: protos.google.cloud.dataform.v1.IFetchFileGitStatusesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IFetchFileGitStatusesResponse, protos.google.cloud.dataform.v1.IFetchFileGitStatusesRequest | undefined, {} | undefined ]>; fetchFileGitStatuses(request: protos.google.cloud.dataform.v1.IFetchFileGitStatusesRequest, options: CallOptions, callback: Callback): void; fetchFileGitStatuses(request: protos.google.cloud.dataform.v1.IFetchFileGitStatusesRequest, callback: Callback): void; /** * Fetches Git ahead/behind against a remote branch. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workspace's name. * @param {string} [request.remoteBranch] * Optional. The name of the branch in the Git remote against which this * workspace should be compared. If left unset, the repository's default * branch name will be used. * @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.dataform.v1.FetchGitAheadBehindResponse|FetchGitAheadBehindResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.fetch_git_ahead_behind.js * region_tag:dataform_v1_generated_Dataform_FetchGitAheadBehind_async */ fetchGitAheadBehind(request?: protos.google.cloud.dataform.v1.IFetchGitAheadBehindRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IFetchGitAheadBehindResponse, protos.google.cloud.dataform.v1.IFetchGitAheadBehindRequest | undefined, {} | undefined ]>; fetchGitAheadBehind(request: protos.google.cloud.dataform.v1.IFetchGitAheadBehindRequest, options: CallOptions, callback: Callback): void; fetchGitAheadBehind(request: protos.google.cloud.dataform.v1.IFetchGitAheadBehindRequest, callback: Callback): void; /** * Applies a Git commit for uncommitted files in a Workspace. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workspace's name. * @param {google.cloud.dataform.v1.CommitAuthor} request.author * Required. The commit's author. * @param {string} [request.commitMessage] * Optional. The commit's message. * @param {string[]} [request.paths] * Optional. Full file paths to commit including filename, rooted at workspace * root. If left empty, all files will be committed. * @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.dataform.v1.CommitWorkspaceChangesResponse|CommitWorkspaceChangesResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.commit_workspace_changes.js * region_tag:dataform_v1_generated_Dataform_CommitWorkspaceChanges_async */ commitWorkspaceChanges(request?: protos.google.cloud.dataform.v1.ICommitWorkspaceChangesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ICommitWorkspaceChangesResponse, (protos.google.cloud.dataform.v1.ICommitWorkspaceChangesRequest | undefined), {} | undefined ]>; commitWorkspaceChanges(request: protos.google.cloud.dataform.v1.ICommitWorkspaceChangesRequest, options: CallOptions, callback: Callback): void; commitWorkspaceChanges(request: protos.google.cloud.dataform.v1.ICommitWorkspaceChangesRequest, callback: Callback): void; /** * Performs a Git reset for uncommitted files in a Workspace. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workspace's name. * @param {string[]} [request.paths] * Optional. Full file paths to reset back to their committed state including * filename, rooted at workspace root. If left empty, all files will be reset. * @param {boolean} [request.clean] * Optional. If set to true, untracked files will be deleted. * @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.dataform.v1.ResetWorkspaceChangesResponse|ResetWorkspaceChangesResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.reset_workspace_changes.js * region_tag:dataform_v1_generated_Dataform_ResetWorkspaceChanges_async */ resetWorkspaceChanges(request?: protos.google.cloud.dataform.v1.IResetWorkspaceChangesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IResetWorkspaceChangesResponse, protos.google.cloud.dataform.v1.IResetWorkspaceChangesRequest | undefined, {} | undefined ]>; resetWorkspaceChanges(request: protos.google.cloud.dataform.v1.IResetWorkspaceChangesRequest, options: CallOptions, callback: Callback): void; resetWorkspaceChanges(request: protos.google.cloud.dataform.v1.IResetWorkspaceChangesRequest, callback: Callback): void; /** * Fetches Git diff for an uncommitted file in a Workspace. * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} request.path * Required. The file's full path including filename, relative to the * workspace root. * @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.dataform.v1.FetchFileDiffResponse|FetchFileDiffResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.fetch_file_diff.js * region_tag:dataform_v1_generated_Dataform_FetchFileDiff_async */ fetchFileDiff(request?: protos.google.cloud.dataform.v1.IFetchFileDiffRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IFetchFileDiffResponse, protos.google.cloud.dataform.v1.IFetchFileDiffRequest | undefined, {} | undefined ]>; fetchFileDiff(request: protos.google.cloud.dataform.v1.IFetchFileDiffRequest, options: CallOptions, callback: Callback): void; fetchFileDiff(request: protos.google.cloud.dataform.v1.IFetchFileDiffRequest, callback: Callback): void; /** * Creates a directory inside a Workspace. * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} request.path * Required. The directory's full path including directory name, relative to * the workspace root. * @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.dataform.v1.MakeDirectoryResponse|MakeDirectoryResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.make_directory.js * region_tag:dataform_v1_generated_Dataform_MakeDirectory_async */ makeDirectory(request?: protos.google.cloud.dataform.v1.IMakeDirectoryRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IMakeDirectoryResponse, protos.google.cloud.dataform.v1.IMakeDirectoryRequest | undefined, {} | undefined ]>; makeDirectory(request: protos.google.cloud.dataform.v1.IMakeDirectoryRequest, options: CallOptions, callback: Callback): void; makeDirectory(request: protos.google.cloud.dataform.v1.IMakeDirectoryRequest, callback: Callback): void; /** * Deletes a directory (inside a Workspace) and all of its contents. * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} request.path * Required. The directory's full path including directory name, relative to * the workspace root. * @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.dataform.v1.RemoveDirectoryResponse|RemoveDirectoryResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.remove_directory.js * region_tag:dataform_v1_generated_Dataform_RemoveDirectory_async */ removeDirectory(request?: protos.google.cloud.dataform.v1.IRemoveDirectoryRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IRemoveDirectoryResponse, protos.google.cloud.dataform.v1.IRemoveDirectoryRequest | undefined, {} | undefined ]>; removeDirectory(request: protos.google.cloud.dataform.v1.IRemoveDirectoryRequest, options: CallOptions, callback: Callback): void; removeDirectory(request: protos.google.cloud.dataform.v1.IRemoveDirectoryRequest, callback: Callback): void; /** * Moves a directory (inside a Workspace), and all of its contents, to a new * location. * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} request.path * Required. The directory's full path including directory name, relative to * the workspace root. * @param {string} request.newPath * Required. The new path for the directory including directory name, rooted * at workspace root. * @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.dataform.v1.MoveDirectoryResponse|MoveDirectoryResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.move_directory.js * region_tag:dataform_v1_generated_Dataform_MoveDirectory_async */ moveDirectory(request?: protos.google.cloud.dataform.v1.IMoveDirectoryRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IMoveDirectoryResponse, protos.google.cloud.dataform.v1.IMoveDirectoryRequest | undefined, {} | undefined ]>; moveDirectory(request: protos.google.cloud.dataform.v1.IMoveDirectoryRequest, options: CallOptions, callback: Callback): void; moveDirectory(request: protos.google.cloud.dataform.v1.IMoveDirectoryRequest, callback: Callback): void; /** * Returns the contents of a file (inside a Workspace). * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} request.path * Required. The file's full path including filename, relative to the * workspace root. * @param {string} [request.revision] * Optional. The Git revision of the file to return. If left empty, the * current contents of `path` will be returned. * @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.dataform.v1.ReadFileResponse|ReadFileResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.read_file.js * region_tag:dataform_v1_generated_Dataform_ReadFile_async */ readFile(request?: protos.google.cloud.dataform.v1.IReadFileRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IReadFileResponse, protos.google.cloud.dataform.v1.IReadFileRequest | undefined, {} | undefined ]>; readFile(request: protos.google.cloud.dataform.v1.IReadFileRequest, options: CallOptions, callback: Callback): void; readFile(request: protos.google.cloud.dataform.v1.IReadFileRequest, callback: Callback): void; /** * Deletes a file (inside a Workspace). * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} request.path * Required. The file's full path including filename, relative to the * workspace root. * @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.dataform.v1.RemoveFileResponse|RemoveFileResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.remove_file.js * region_tag:dataform_v1_generated_Dataform_RemoveFile_async */ removeFile(request?: protos.google.cloud.dataform.v1.IRemoveFileRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IRemoveFileResponse, protos.google.cloud.dataform.v1.IRemoveFileRequest | undefined, {} | undefined ]>; removeFile(request: protos.google.cloud.dataform.v1.IRemoveFileRequest, options: CallOptions, callback: Callback): void; removeFile(request: protos.google.cloud.dataform.v1.IRemoveFileRequest, callback: Callback): void; /** * Moves a file (inside a Workspace) to a new location. * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} request.path * Required. The file's full path including filename, relative to the * workspace root. * @param {string} request.newPath * Required. The file's new path including filename, relative to the workspace * root. * @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.dataform.v1.MoveFileResponse|MoveFileResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.move_file.js * region_tag:dataform_v1_generated_Dataform_MoveFile_async */ moveFile(request?: protos.google.cloud.dataform.v1.IMoveFileRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IMoveFileResponse, protos.google.cloud.dataform.v1.IMoveFileRequest | undefined, {} | undefined ]>; moveFile(request: protos.google.cloud.dataform.v1.IMoveFileRequest, options: CallOptions, callback: Callback): void; moveFile(request: protos.google.cloud.dataform.v1.IMoveFileRequest, callback: Callback): void; /** * Writes to a file (inside a Workspace). * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} request.path * Required. The file. * @param {Buffer} request.contents * Required. The file's contents. * @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.dataform.v1.WriteFileResponse|WriteFileResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.write_file.js * region_tag:dataform_v1_generated_Dataform_WriteFile_async */ writeFile(request?: protos.google.cloud.dataform.v1.IWriteFileRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWriteFileResponse, protos.google.cloud.dataform.v1.IWriteFileRequest | undefined, {} | undefined ]>; writeFile(request: protos.google.cloud.dataform.v1.IWriteFileRequest, options: CallOptions, callback: Callback): void; writeFile(request: protos.google.cloud.dataform.v1.IWriteFileRequest, callback: Callback): void; /** * Fetches a single ReleaseConfig. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The release config's name. * @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.dataform.v1.ReleaseConfig|ReleaseConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_release_config.js * region_tag:dataform_v1_generated_Dataform_GetReleaseConfig_async */ getReleaseConfig(request?: protos.google.cloud.dataform.v1.IGetReleaseConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IReleaseConfig, protos.google.cloud.dataform.v1.IGetReleaseConfigRequest | undefined, {} | undefined ]>; getReleaseConfig(request: protos.google.cloud.dataform.v1.IGetReleaseConfigRequest, options: CallOptions, callback: Callback): void; getReleaseConfig(request: protos.google.cloud.dataform.v1.IGetReleaseConfigRequest, callback: Callback): void; /** * Creates a new ReleaseConfig in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to create the release config. Must be in * the format `projects/* /locations/* /repositories/*`. * @param {google.cloud.dataform.v1.ReleaseConfig} request.releaseConfig * Required. The release config to create. * @param {string} request.releaseConfigId * Required. The ID to use for the release config, which will become the final * component of the release config's resource name. * @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.dataform.v1.ReleaseConfig|ReleaseConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.create_release_config.js * region_tag:dataform_v1_generated_Dataform_CreateReleaseConfig_async */ createReleaseConfig(request?: protos.google.cloud.dataform.v1.ICreateReleaseConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IReleaseConfig, protos.google.cloud.dataform.v1.ICreateReleaseConfigRequest | undefined, {} | undefined ]>; createReleaseConfig(request: protos.google.cloud.dataform.v1.ICreateReleaseConfigRequest, options: CallOptions, callback: Callback): void; createReleaseConfig(request: protos.google.cloud.dataform.v1.ICreateReleaseConfigRequest, callback: Callback): void; /** * Updates a single ReleaseConfig. * * **Note:** *This method does not fully implement * [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated * as a bad request, and when the `field_mask` is omitted, the request is * treated as a full update on all modifiable fields.* * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Specifies the fields to be updated in the release config. If left * unset, all fields will be updated. * @param {google.cloud.dataform.v1.ReleaseConfig} request.releaseConfig * Required. The release config to update. * @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.dataform.v1.ReleaseConfig|ReleaseConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.update_release_config.js * region_tag:dataform_v1_generated_Dataform_UpdateReleaseConfig_async */ updateReleaseConfig(request?: protos.google.cloud.dataform.v1.IUpdateReleaseConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IReleaseConfig, protos.google.cloud.dataform.v1.IUpdateReleaseConfigRequest | undefined, {} | undefined ]>; updateReleaseConfig(request: protos.google.cloud.dataform.v1.IUpdateReleaseConfigRequest, options: CallOptions, callback: Callback): void; updateReleaseConfig(request: protos.google.cloud.dataform.v1.IUpdateReleaseConfigRequest, callback: Callback): void; /** * Deletes a single ReleaseConfig. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The release config's name. * @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 include:samples/generated/v1/dataform.delete_release_config.js * region_tag:dataform_v1_generated_Dataform_DeleteReleaseConfig_async */ deleteReleaseConfig(request?: protos.google.cloud.dataform.v1.IDeleteReleaseConfigRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataform.v1.IDeleteReleaseConfigRequest | undefined, {} | undefined ]>; deleteReleaseConfig(request: protos.google.cloud.dataform.v1.IDeleteReleaseConfigRequest, options: CallOptions, callback: Callback): void; deleteReleaseConfig(request: protos.google.cloud.dataform.v1.IDeleteReleaseConfigRequest, callback: Callback): void; /** * Fetches a single CompilationResult. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The compilation result's name. * @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.dataform.v1.CompilationResult|CompilationResult}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_compilation_result.js * region_tag:dataform_v1_generated_Dataform_GetCompilationResult_async */ getCompilationResult(request?: protos.google.cloud.dataform.v1.IGetCompilationResultRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ICompilationResult, protos.google.cloud.dataform.v1.IGetCompilationResultRequest | undefined, {} | undefined ]>; getCompilationResult(request: protos.google.cloud.dataform.v1.IGetCompilationResultRequest, options: CallOptions, callback: Callback): void; getCompilationResult(request: protos.google.cloud.dataform.v1.IGetCompilationResultRequest, callback: Callback): void; /** * Creates a new CompilationResult in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to create the compilation result. Must be * in the format `projects/* /locations/* /repositories/*`. * @param {google.cloud.dataform.v1.CompilationResult} request.compilationResult * Required. The compilation result 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.dataform.v1.CompilationResult|CompilationResult}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.create_compilation_result.js * region_tag:dataform_v1_generated_Dataform_CreateCompilationResult_async */ createCompilationResult(request?: protos.google.cloud.dataform.v1.ICreateCompilationResultRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ICompilationResult, (protos.google.cloud.dataform.v1.ICreateCompilationResultRequest | undefined), {} | undefined ]>; createCompilationResult(request: protos.google.cloud.dataform.v1.ICreateCompilationResultRequest, options: CallOptions, callback: Callback): void; createCompilationResult(request: protos.google.cloud.dataform.v1.ICreateCompilationResultRequest, callback: Callback): void; /** * Fetches a single WorkflowConfig. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workflow config's name. * @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.dataform.v1.WorkflowConfig|WorkflowConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_workflow_config.js * region_tag:dataform_v1_generated_Dataform_GetWorkflowConfig_async */ getWorkflowConfig(request?: protos.google.cloud.dataform.v1.IGetWorkflowConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkflowConfig, protos.google.cloud.dataform.v1.IGetWorkflowConfigRequest | undefined, {} | undefined ]>; getWorkflowConfig(request: protos.google.cloud.dataform.v1.IGetWorkflowConfigRequest, options: CallOptions, callback: Callback): void; getWorkflowConfig(request: protos.google.cloud.dataform.v1.IGetWorkflowConfigRequest, callback: Callback): void; /** * Creates a new WorkflowConfig in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to create the workflow config. Must be in * the format `projects/* /locations/* /repositories/*`. * @param {google.cloud.dataform.v1.WorkflowConfig} request.workflowConfig * Required. The workflow config to create. * @param {string} request.workflowConfigId * Required. The ID to use for the workflow config, which will become the * final component of the workflow config's resource name. * @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.dataform.v1.WorkflowConfig|WorkflowConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.create_workflow_config.js * region_tag:dataform_v1_generated_Dataform_CreateWorkflowConfig_async */ createWorkflowConfig(request?: protos.google.cloud.dataform.v1.ICreateWorkflowConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkflowConfig, protos.google.cloud.dataform.v1.ICreateWorkflowConfigRequest | undefined, {} | undefined ]>; createWorkflowConfig(request: protos.google.cloud.dataform.v1.ICreateWorkflowConfigRequest, options: CallOptions, callback: Callback): void; createWorkflowConfig(request: protos.google.cloud.dataform.v1.ICreateWorkflowConfigRequest, callback: Callback): void; /** * Updates a single WorkflowConfig. * * **Note:** *This method does not fully implement * [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated * as a bad request, and when the `field_mask` is omitted, the request is * treated as a full update on all modifiable fields.* * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Specifies the fields to be updated in the workflow config. If * left unset, all fields will be updated. * @param {google.cloud.dataform.v1.WorkflowConfig} request.workflowConfig * Required. The workflow config to update. * @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.dataform.v1.WorkflowConfig|WorkflowConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.update_workflow_config.js * region_tag:dataform_v1_generated_Dataform_UpdateWorkflowConfig_async */ updateWorkflowConfig(request?: protos.google.cloud.dataform.v1.IUpdateWorkflowConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkflowConfig, protos.google.cloud.dataform.v1.IUpdateWorkflowConfigRequest | undefined, {} | undefined ]>; updateWorkflowConfig(request: protos.google.cloud.dataform.v1.IUpdateWorkflowConfigRequest, options: CallOptions, callback: Callback): void; updateWorkflowConfig(request: protos.google.cloud.dataform.v1.IUpdateWorkflowConfigRequest, callback: Callback): void; /** * Deletes a single WorkflowConfig. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workflow config's name. * @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 include:samples/generated/v1/dataform.delete_workflow_config.js * region_tag:dataform_v1_generated_Dataform_DeleteWorkflowConfig_async */ deleteWorkflowConfig(request?: protos.google.cloud.dataform.v1.IDeleteWorkflowConfigRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dataform.v1.IDeleteWorkflowConfigRequest | undefined, {} | undefined ]>; deleteWorkflowConfig(request: protos.google.cloud.dataform.v1.IDeleteWorkflowConfigRequest, options: CallOptions, callback: Callback): void; deleteWorkflowConfig(request: protos.google.cloud.dataform.v1.IDeleteWorkflowConfigRequest, callback: Callback): void; /** * Fetches a single WorkflowInvocation. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workflow invocation resource's name. * @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.dataform.v1.WorkflowInvocation|WorkflowInvocation}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_workflow_invocation.js * region_tag:dataform_v1_generated_Dataform_GetWorkflowInvocation_async */ getWorkflowInvocation(request?: protos.google.cloud.dataform.v1.IGetWorkflowInvocationRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkflowInvocation, protos.google.cloud.dataform.v1.IGetWorkflowInvocationRequest | undefined, {} | undefined ]>; getWorkflowInvocation(request: protos.google.cloud.dataform.v1.IGetWorkflowInvocationRequest, options: CallOptions, callback: Callback): void; getWorkflowInvocation(request: protos.google.cloud.dataform.v1.IGetWorkflowInvocationRequest, callback: Callback): void; /** * Creates a new WorkflowInvocation in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to create the workflow invocation. Must * be in the format `projects/* /locations/* /repositories/*`. * @param {google.cloud.dataform.v1.WorkflowInvocation} request.workflowInvocation * Required. The workflow invocation resource 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.dataform.v1.WorkflowInvocation|WorkflowInvocation}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.create_workflow_invocation.js * region_tag:dataform_v1_generated_Dataform_CreateWorkflowInvocation_async */ createWorkflowInvocation(request?: protos.google.cloud.dataform.v1.ICreateWorkflowInvocationRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkflowInvocation, (protos.google.cloud.dataform.v1.ICreateWorkflowInvocationRequest | undefined), {} | undefined ]>; createWorkflowInvocation(request: protos.google.cloud.dataform.v1.ICreateWorkflowInvocationRequest, options: CallOptions, callback: Callback): void; createWorkflowInvocation(request: protos.google.cloud.dataform.v1.ICreateWorkflowInvocationRequest, callback: Callback): void; /** * Deletes a single WorkflowInvocation. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workflow invocation resource's name. * @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 include:samples/generated/v1/dataform.delete_workflow_invocation.js * region_tag:dataform_v1_generated_Dataform_DeleteWorkflowInvocation_async */ deleteWorkflowInvocation(request?: protos.google.cloud.dataform.v1.IDeleteWorkflowInvocationRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.dataform.v1.IDeleteWorkflowInvocationRequest | undefined), {} | undefined ]>; deleteWorkflowInvocation(request: protos.google.cloud.dataform.v1.IDeleteWorkflowInvocationRequest, options: CallOptions, callback: Callback): void; deleteWorkflowInvocation(request: protos.google.cloud.dataform.v1.IDeleteWorkflowInvocationRequest, callback: Callback): void; /** * Requests cancellation of a running WorkflowInvocation. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workflow invocation resource's name. * @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.dataform.v1.CancelWorkflowInvocationResponse|CancelWorkflowInvocationResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.cancel_workflow_invocation.js * region_tag:dataform_v1_generated_Dataform_CancelWorkflowInvocation_async */ cancelWorkflowInvocation(request?: protos.google.cloud.dataform.v1.ICancelWorkflowInvocationRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ICancelWorkflowInvocationResponse, (protos.google.cloud.dataform.v1.ICancelWorkflowInvocationRequest | undefined), {} | undefined ]>; cancelWorkflowInvocation(request: protos.google.cloud.dataform.v1.ICancelWorkflowInvocationRequest, options: CallOptions, callback: Callback): void; cancelWorkflowInvocation(request: protos.google.cloud.dataform.v1.ICancelWorkflowInvocationRequest, callback: Callback): void; /** * Get default config for a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The config name. * @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.dataform.v1.Config|Config}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_config.js * region_tag:dataform_v1_generated_Dataform_GetConfig_async */ getConfig(request?: protos.google.cloud.dataform.v1.IGetConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IConfig, protos.google.cloud.dataform.v1.IGetConfigRequest | undefined, {} | undefined ]>; getConfig(request: protos.google.cloud.dataform.v1.IGetConfigRequest, options: CallOptions, callback: Callback): void; getConfig(request: protos.google.cloud.dataform.v1.IGetConfigRequest, callback: Callback): void; /** * Update default config for a given project and location. * * **Note:** *This method does not fully implement * [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated * as a bad request, and when the `field_mask` is omitted, the request is * treated as a full update on all modifiable fields.* * * @param {Object} request * The request object that will be sent. * @param {google.cloud.dataform.v1.Config} request.config * Required. The config to update. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Specifies the fields to be updated in the config. * @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.dataform.v1.Config|Config}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.update_config.js * region_tag:dataform_v1_generated_Dataform_UpdateConfig_async */ updateConfig(request?: protos.google.cloud.dataform.v1.IUpdateConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IConfig, protos.google.cloud.dataform.v1.IUpdateConfigRequest | undefined, {} | undefined ]>; updateConfig(request: protos.google.cloud.dataform.v1.IUpdateConfigRequest, options: CallOptions, callback: Callback): void; updateConfig(request: protos.google.cloud.dataform.v1.IUpdateConfigRequest, callback: Callback): void; /** * Gets the access control policy for a resource. * Returns an empty policy if the resource exists and does not have a policy * set. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.GetPolicyOptions} request.options * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. * @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.iam.v1.Policy|Policy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.get_iam_policy.js * region_tag:dataform_v1_generated_Dataform_GetIamPolicy_async */ getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback): void; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback): void; /** * Sets the access control policy on the specified resource. Replaces any * existing policy. * * Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being specified. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.Policy} request.policy * REQUIRED: The complete policy to be applied to the `resource`. The size of * the policy is limited to a few 10s of KB. An empty policy is a * valid policy but certain Cloud Platform services (such as Projects) * might reject them. * @param {google.protobuf.FieldMask} request.updateMask * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only * the fields in the mask will be modified. If no mask is provided, the * following default mask is used: * * `paths: "bindings, etag"` * @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.iam.v1.Policy|Policy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.set_iam_policy.js * region_tag:dataform_v1_generated_Dataform_SetIamPolicy_async */ setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback): void; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback): void; /** * 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.test_iam_permissions.js * region_tag:dataform_v1_generated_Dataform_TestIamPermissions_async */ testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined ]>; testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback): void; testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback): void; /** * Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, * ReleaseConfigs, and WorkflowConfigs). * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The TeamFolder's name. * Format: projects/{project}/locations/{location}/teamFolders/{team_folder} * @param {boolean} [request.force] * Optional. If `false` (default): The operation will fail if any * Repository within the folder hierarchy has associated Release Configs or * Workflow Configs. * * If `true`: The operation will attempt to delete everything, including any * Release Configs and Workflow Configs linked to Repositories within the * folder hierarchy. This permanently removes schedules and resources. * @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 * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.delete_team_folder_tree.js * region_tag:dataform_v1_generated_Dataform_DeleteTeamFolderTree_async */ deleteTeamFolderTree(request?: protos.google.cloud.dataform.v1.IDeleteTeamFolderTreeRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteTeamFolderTree(request: protos.google.cloud.dataform.v1.IDeleteTeamFolderTreeRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteTeamFolderTree(request: protos.google.cloud.dataform.v1.IDeleteTeamFolderTreeRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteTeamFolderTree()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.delete_team_folder_tree.js * region_tag:dataform_v1_generated_Dataform_DeleteTeamFolderTree_async */ checkDeleteTeamFolderTreeProgress(name: string): Promise>; /** * Deletes a Folder with its contents (Folders, Repositories, Workspaces, * ReleaseConfigs, and WorkflowConfigs). * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The Folder's name. * Format: projects/{project}/locations/{location}/folders/{folder} * @param {boolean} [request.force] * Optional. If `false` (default): The operation will fail if any * Repository within the folder hierarchy has associated Release Configs or * Workflow Configs. * * If `true`: The operation will attempt to delete everything, including any * Release Configs and Workflow Configs linked to Repositories within the * folder hierarchy. This permanently removes schedules and resources. * @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 * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.delete_folder_tree.js * region_tag:dataform_v1_generated_Dataform_DeleteFolderTree_async */ deleteFolderTree(request?: protos.google.cloud.dataform.v1.IDeleteFolderTreeRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteFolderTree(request: protos.google.cloud.dataform.v1.IDeleteFolderTreeRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteFolderTree(request: protos.google.cloud.dataform.v1.IDeleteFolderTreeRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteFolderTree()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.delete_folder_tree.js * region_tag:dataform_v1_generated_Dataform_DeleteFolderTree_async */ checkDeleteFolderTreeProgress(name: string): Promise>; /** * Moves a Folder to a new Folder, TeamFolder, or the root location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The full resource name of the Folder to move. * @param {string} [request.destinationContainingFolder] * Optional. The name of the Folder, TeamFolder, or root location to move the * Folder to. Can be in the format of: "" to move into the root User folder, * `projects/* /locations/* /folders/*`, `projects/* /locations/* /teamFolders/*` * @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 * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.move_folder.js * region_tag:dataform_v1_generated_Dataform_MoveFolder_async */ moveFolder(request?: protos.google.cloud.dataform.v1.IMoveFolderRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; moveFolder(request: protos.google.cloud.dataform.v1.IMoveFolderRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; moveFolder(request: protos.google.cloud.dataform.v1.IMoveFolderRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `moveFolder()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.move_folder.js * region_tag:dataform_v1_generated_Dataform_MoveFolder_async */ checkMoveFolderProgress(name: string): Promise>; /** * Moves a Repository to a new location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The full resource name of the repository to move. * @param {string} [request.destinationContainingFolder] * Optional. The name of the Folder, TeamFolder, or root location to move the * repository to. Can be in the format of: "" to move into the root User * folder, `projects/* /locations/* /folders/*`, * `projects/* /locations/* /teamFolders/*` * @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 * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.move_repository.js * region_tag:dataform_v1_generated_Dataform_MoveRepository_async */ moveRepository(request?: protos.google.cloud.dataform.v1.IMoveRepositoryRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; moveRepository(request: protos.google.cloud.dataform.v1.IMoveRepositoryRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; moveRepository(request: protos.google.cloud.dataform.v1.IMoveRepositoryRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `moveRepository()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataform.move_repository.js * region_tag:dataform_v1_generated_Dataform_MoveRepository_async */ checkMoveRepositoryProgress(name: string): Promise>; /** * Returns the contents of a given TeamFolder. * * @param {Object} request * The request object that will be sent. * @param {string} request.teamFolder * Required. Resource name of the TeamFolder to list contents for. * Format: `projects/* /locations/* /teamFolders/*`. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryTeamFolderContents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryTeamFolderContents`, with the exception of `page_size`, must match * the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: `display_name` (default), `create_time`, * last_modified_time. * Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryTeamFolderContentsResponse.TeamFolderContentsEntry|TeamFolderContentsEntry}. * 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 `queryTeamFolderContentsAsync()` * 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. */ queryTeamFolderContents(request?: protos.google.cloud.dataform.v1.IQueryTeamFolderContentsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.QueryTeamFolderContentsResponse.ITeamFolderContentsEntry[], protos.google.cloud.dataform.v1.IQueryTeamFolderContentsRequest | null, protos.google.cloud.dataform.v1.IQueryTeamFolderContentsResponse ]>; queryTeamFolderContents(request: protos.google.cloud.dataform.v1.IQueryTeamFolderContentsRequest, options: CallOptions, callback: PaginationCallback): void; queryTeamFolderContents(request: protos.google.cloud.dataform.v1.IQueryTeamFolderContentsRequest, callback: PaginationCallback): void; /** * Equivalent to `queryTeamFolderContents`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.teamFolder * Required. Resource name of the TeamFolder to list contents for. * Format: `projects/* /locations/* /teamFolders/*`. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryTeamFolderContents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryTeamFolderContents`, with the exception of `page_size`, must match * the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: `display_name` (default), `create_time`, * last_modified_time. * Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryTeamFolderContentsResponse.TeamFolderContentsEntry|TeamFolderContentsEntry} 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 `queryTeamFolderContentsAsync()` * 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. */ queryTeamFolderContentsStream(request?: protos.google.cloud.dataform.v1.IQueryTeamFolderContentsRequest, options?: CallOptions): Transform; /** * Equivalent to `queryTeamFolderContents`, 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.teamFolder * Required. Resource name of the TeamFolder to list contents for. * Format: `projects/* /locations/* /teamFolders/*`. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryTeamFolderContents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryTeamFolderContents`, with the exception of `page_size`, must match * the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: `display_name` (default), `create_time`, * last_modified_time. * Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryTeamFolderContentsResponse.TeamFolderContentsEntry|TeamFolderContentsEntry}. 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 include:samples/generated/v1/dataform.query_team_folder_contents.js * region_tag:dataform_v1_generated_Dataform_QueryTeamFolderContents_async */ queryTeamFolderContentsAsync(request?: protos.google.cloud.dataform.v1.IQueryTeamFolderContentsRequest, options?: CallOptions): AsyncIterable; /** * Returns all TeamFolders in a given location that the caller has access to * and match the provided filter. * * @param {Object} request * The request object that will be sent. * @param {string} request.location * Required. Location in which to query TeamFolders. * Format: `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Maximum number of `TeamFolders` to return. The server may return * fewer items than requested. If unspecified, the server will pick a default * of `page_size` = 50. * @param {string} [request.pageToken] * Optional. Page token received from a previous `SearchTeamFolders` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `SearchTeamFolders`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Supported keywords: `display_name` (default), `create_time`, * `last_modified_time`. Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.SearchTeamFoldersResponse.TeamFolderSearchResult|TeamFolderSearchResult}. * 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 `searchTeamFoldersAsync()` * 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. */ searchTeamFolders(request?: protos.google.cloud.dataform.v1.ISearchTeamFoldersRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.SearchTeamFoldersResponse.ITeamFolderSearchResult[], protos.google.cloud.dataform.v1.ISearchTeamFoldersRequest | null, protos.google.cloud.dataform.v1.ISearchTeamFoldersResponse ]>; searchTeamFolders(request: protos.google.cloud.dataform.v1.ISearchTeamFoldersRequest, options: CallOptions, callback: PaginationCallback): void; searchTeamFolders(request: protos.google.cloud.dataform.v1.ISearchTeamFoldersRequest, callback: PaginationCallback): void; /** * Equivalent to `searchTeamFolders`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.location * Required. Location in which to query TeamFolders. * Format: `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Maximum number of `TeamFolders` to return. The server may return * fewer items than requested. If unspecified, the server will pick a default * of `page_size` = 50. * @param {string} [request.pageToken] * Optional. Page token received from a previous `SearchTeamFolders` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `SearchTeamFolders`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Supported keywords: `display_name` (default), `create_time`, * `last_modified_time`. Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.SearchTeamFoldersResponse.TeamFolderSearchResult|TeamFolderSearchResult} 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 `searchTeamFoldersAsync()` * 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. */ searchTeamFoldersStream(request?: protos.google.cloud.dataform.v1.ISearchTeamFoldersRequest, options?: CallOptions): Transform; /** * Equivalent to `searchTeamFolders`, 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.location * Required. Location in which to query TeamFolders. * Format: `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Maximum number of `TeamFolders` to return. The server may return * fewer items than requested. If unspecified, the server will pick a default * of `page_size` = 50. * @param {string} [request.pageToken] * Optional. Page token received from a previous `SearchTeamFolders` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `SearchTeamFolders`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Supported keywords: `display_name` (default), `create_time`, * `last_modified_time`. Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.SearchTeamFoldersResponse.TeamFolderSearchResult|TeamFolderSearchResult}. 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 include:samples/generated/v1/dataform.search_team_folders.js * region_tag:dataform_v1_generated_Dataform_SearchTeamFolders_async */ searchTeamFoldersAsync(request?: protos.google.cloud.dataform.v1.ISearchTeamFoldersRequest, options?: CallOptions): AsyncIterable; /** * Returns the contents of a given Folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.folder * Required. Resource name of the Folder to list contents for. * Format: projects/* /locations/* /folders/* * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryFolderContents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryFolderContents`, with the exception of `page_size`, must match the * call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: display_name (default), create_time, * last_modified_time. * Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryFolderContentsResponse.FolderContentsEntry|FolderContentsEntry}. * 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 `queryFolderContentsAsync()` * 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. */ queryFolderContents(request?: protos.google.cloud.dataform.v1.IQueryFolderContentsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.QueryFolderContentsResponse.IFolderContentsEntry[], protos.google.cloud.dataform.v1.IQueryFolderContentsRequest | null, protos.google.cloud.dataform.v1.IQueryFolderContentsResponse ]>; queryFolderContents(request: protos.google.cloud.dataform.v1.IQueryFolderContentsRequest, options: CallOptions, callback: PaginationCallback): void; queryFolderContents(request: protos.google.cloud.dataform.v1.IQueryFolderContentsRequest, callback: PaginationCallback): void; /** * Equivalent to `queryFolderContents`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.folder * Required. Resource name of the Folder to list contents for. * Format: projects/* /locations/* /folders/* * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryFolderContents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryFolderContents`, with the exception of `page_size`, must match the * call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: display_name (default), create_time, * last_modified_time. * Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryFolderContentsResponse.FolderContentsEntry|FolderContentsEntry} 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 `queryFolderContentsAsync()` * 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. */ queryFolderContentsStream(request?: protos.google.cloud.dataform.v1.IQueryFolderContentsRequest, options?: CallOptions): Transform; /** * Equivalent to `queryFolderContents`, 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.folder * Required. Resource name of the Folder to list contents for. * Format: projects/* /locations/* /folders/* * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryFolderContents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryFolderContents`, with the exception of `page_size`, must match the * call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: display_name (default), create_time, * last_modified_time. * Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryFolderContentsResponse.FolderContentsEntry|FolderContentsEntry}. 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 include:samples/generated/v1/dataform.query_folder_contents.js * region_tag:dataform_v1_generated_Dataform_QueryFolderContents_async */ queryFolderContentsAsync(request?: protos.google.cloud.dataform.v1.IQueryFolderContentsRequest, options?: CallOptions): AsyncIterable; /** * Returns the contents of a caller's root folder in a given location. * The root folder contains all resources that are created by the user and not * contained in any other folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.location * Required. Location of the user root folder to list contents for. * Format: projects/* /locations/* * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryUserRootContents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryUserRootFolderContents`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: display_name (default), created_at, * last_modified_at. Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryUserRootContentsResponse.RootContentsEntry|RootContentsEntry}. * 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 `queryUserRootContentsAsync()` * 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. */ queryUserRootContents(request?: protos.google.cloud.dataform.v1.IQueryUserRootContentsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.QueryUserRootContentsResponse.IRootContentsEntry[], protos.google.cloud.dataform.v1.IQueryUserRootContentsRequest | null, protos.google.cloud.dataform.v1.IQueryUserRootContentsResponse ]>; queryUserRootContents(request: protos.google.cloud.dataform.v1.IQueryUserRootContentsRequest, options: CallOptions, callback: PaginationCallback): void; queryUserRootContents(request: protos.google.cloud.dataform.v1.IQueryUserRootContentsRequest, callback: PaginationCallback): void; /** * Equivalent to `queryUserRootContents`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.location * Required. Location of the user root folder to list contents for. * Format: projects/* /locations/* * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryUserRootContents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryUserRootFolderContents`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: display_name (default), created_at, * last_modified_at. Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryUserRootContentsResponse.RootContentsEntry|RootContentsEntry} 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 `queryUserRootContentsAsync()` * 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. */ queryUserRootContentsStream(request?: protos.google.cloud.dataform.v1.IQueryUserRootContentsRequest, options?: CallOptions): Transform; /** * Equivalent to `queryUserRootContents`, 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.location * Required. Location of the user root folder to list contents for. * Format: projects/* /locations/* * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryUserRootContents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryUserRootFolderContents`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.orderBy] * Optional. Field to additionally sort results by. * Will order Folders before Repositories, and then by `order_by` in ascending * order. Supported keywords: display_name (default), created_at, * last_modified_at. Examples: * * * `orderBy="display_name"` * * `orderBy="display_name desc"` * @param {string} [request.filter] * Optional. Optional filtering for the returned list. Filtering is currently * only supported on the `display_name` field. * * Example: * * * `filter="display_name="MyFolder""` * @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.dataform.v1.QueryUserRootContentsResponse.RootContentsEntry|RootContentsEntry}. 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 include:samples/generated/v1/dataform.query_user_root_contents.js * region_tag:dataform_v1_generated_Dataform_QueryUserRootContents_async */ queryUserRootContentsAsync(request?: protos.google.cloud.dataform.v1.IQueryUserRootContentsRequest, options?: CallOptions): AsyncIterable; /** * Lists Repositories in a given project and location. * * **Note:** *This method can return repositories not shown in the [Dataform * UI](https://console.cloud.google.com/bigquery/dataform)*. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The location in which to list repositories. Must be in the format * `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Maximum number of repositories to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListRepositories` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListRepositories`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.Repository|Repository}. * 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 `listRepositoriesAsync()` * 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. */ listRepositories(request?: protos.google.cloud.dataform.v1.IListRepositoriesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IRepository[], protos.google.cloud.dataform.v1.IListRepositoriesRequest | null, protos.google.cloud.dataform.v1.IListRepositoriesResponse ]>; listRepositories(request: protos.google.cloud.dataform.v1.IListRepositoriesRequest, options: CallOptions, callback: PaginationCallback): void; listRepositories(request: protos.google.cloud.dataform.v1.IListRepositoriesRequest, callback: PaginationCallback): void; /** * Equivalent to `listRepositories`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The location in which to list repositories. Must be in the format * `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Maximum number of repositories to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListRepositories` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListRepositories`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.Repository|Repository} 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 `listRepositoriesAsync()` * 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. */ listRepositoriesStream(request?: protos.google.cloud.dataform.v1.IListRepositoriesRequest, options?: CallOptions): Transform; /** * Equivalent to `listRepositories`, 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 in which to list repositories. Must be in the format * `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Maximum number of repositories to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListRepositories` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListRepositories`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.Repository|Repository}. 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 include:samples/generated/v1/dataform.list_repositories.js * region_tag:dataform_v1_generated_Dataform_ListRepositories_async */ listRepositoriesAsync(request?: protos.google.cloud.dataform.v1.IListRepositoriesRequest, options?: CallOptions): AsyncIterable; /** * Returns the contents of a given Repository directory. The Repository must * not have a value for `git_remote_settings.url`. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @param {string} [request.commitSha] * Optional. The Commit SHA for the commit to query from. If unset, the * directory will be queried from HEAD. * @param {string} [request.path] * Optional. The directory's full path including directory name, relative to * root. If left unset, the root is used. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryRepositoryDirectoryContents` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must * match the call that provided the page token. * @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.dataform.v1.DirectoryEntry|DirectoryEntry}. * 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 `queryRepositoryDirectoryContentsAsync()` * 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. */ queryRepositoryDirectoryContents(request?: protos.google.cloud.dataform.v1.IQueryRepositoryDirectoryContentsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IDirectoryEntry[], protos.google.cloud.dataform.v1.IQueryRepositoryDirectoryContentsRequest | null, protos.google.cloud.dataform.v1.IQueryRepositoryDirectoryContentsResponse ]>; queryRepositoryDirectoryContents(request: protos.google.cloud.dataform.v1.IQueryRepositoryDirectoryContentsRequest, options: CallOptions, callback: PaginationCallback): void; queryRepositoryDirectoryContents(request: protos.google.cloud.dataform.v1.IQueryRepositoryDirectoryContentsRequest, callback: PaginationCallback): void; /** * Equivalent to `queryRepositoryDirectoryContents`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @param {string} [request.commitSha] * Optional. The Commit SHA for the commit to query from. If unset, the * directory will be queried from HEAD. * @param {string} [request.path] * Optional. The directory's full path including directory name, relative to * root. If left unset, the root is used. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryRepositoryDirectoryContents` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must * match the call that provided the page token. * @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.dataform.v1.DirectoryEntry|DirectoryEntry} 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 `queryRepositoryDirectoryContentsAsync()` * 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. */ queryRepositoryDirectoryContentsStream(request?: protos.google.cloud.dataform.v1.IQueryRepositoryDirectoryContentsRequest, options?: CallOptions): Transform; /** * Equivalent to `queryRepositoryDirectoryContents`, 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.name * Required. The repository's name. * @param {string} [request.commitSha] * Optional. The Commit SHA for the commit to query from. If unset, the * directory will be queried from HEAD. * @param {string} [request.path] * Optional. The directory's full path including directory name, relative to * root. If left unset, the root is used. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryRepositoryDirectoryContents` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must * match the call that provided the 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 protos.google.cloud.dataform.v1.DirectoryEntry|DirectoryEntry}. 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 include:samples/generated/v1/dataform.query_repository_directory_contents.js * region_tag:dataform_v1_generated_Dataform_QueryRepositoryDirectoryContents_async */ queryRepositoryDirectoryContentsAsync(request?: protos.google.cloud.dataform.v1.IQueryRepositoryDirectoryContentsRequest, options?: CallOptions): AsyncIterable; /** * Fetches a Repository's history of commits. The Repository must not have a * value for `git_remote_settings.url`. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @param {number} [request.pageSize] * Optional. Maximum number of commits to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `FetchRepositoryHistory` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `FetchRepositoryHistory`, * with the exception of `page_size`, must match the call that provided the * page token. * @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.dataform.v1.CommitLogEntry|CommitLogEntry}. * 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 `fetchRepositoryHistoryAsync()` * 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. */ fetchRepositoryHistory(request?: protos.google.cloud.dataform.v1.IFetchRepositoryHistoryRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ICommitLogEntry[], protos.google.cloud.dataform.v1.IFetchRepositoryHistoryRequest | null, protos.google.cloud.dataform.v1.IFetchRepositoryHistoryResponse ]>; fetchRepositoryHistory(request: protos.google.cloud.dataform.v1.IFetchRepositoryHistoryRequest, options: CallOptions, callback: PaginationCallback): void; fetchRepositoryHistory(request: protos.google.cloud.dataform.v1.IFetchRepositoryHistoryRequest, callback: PaginationCallback): void; /** * Equivalent to `fetchRepositoryHistory`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The repository's name. * @param {number} [request.pageSize] * Optional. Maximum number of commits to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `FetchRepositoryHistory` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `FetchRepositoryHistory`, * with the exception of `page_size`, must match the call that provided the * page token. * @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.dataform.v1.CommitLogEntry|CommitLogEntry} 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 `fetchRepositoryHistoryAsync()` * 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. */ fetchRepositoryHistoryStream(request?: protos.google.cloud.dataform.v1.IFetchRepositoryHistoryRequest, options?: CallOptions): Transform; /** * Equivalent to `fetchRepositoryHistory`, 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.name * Required. The repository's name. * @param {number} [request.pageSize] * Optional. Maximum number of commits to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `FetchRepositoryHistory` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `FetchRepositoryHistory`, * with the exception of `page_size`, must match the call that provided the * 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 protos.google.cloud.dataform.v1.CommitLogEntry|CommitLogEntry}. 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 include:samples/generated/v1/dataform.fetch_repository_history.js * region_tag:dataform_v1_generated_Dataform_FetchRepositoryHistory_async */ fetchRepositoryHistoryAsync(request?: protos.google.cloud.dataform.v1.IFetchRepositoryHistoryRequest, options?: CallOptions): AsyncIterable; /** * Lists Workspaces in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to list workspaces. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workspaces to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkspaces` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListWorkspaces`, with * the exception of `page_size`, must match the call that provided the page * token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.Workspace|Workspace}. * 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 `listWorkspacesAsync()` * 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. */ listWorkspaces(request?: protos.google.cloud.dataform.v1.IListWorkspacesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkspace[], protos.google.cloud.dataform.v1.IListWorkspacesRequest | null, protos.google.cloud.dataform.v1.IListWorkspacesResponse ]>; listWorkspaces(request: protos.google.cloud.dataform.v1.IListWorkspacesRequest, options: CallOptions, callback: PaginationCallback): void; listWorkspaces(request: protos.google.cloud.dataform.v1.IListWorkspacesRequest, callback: PaginationCallback): void; /** * Equivalent to `listWorkspaces`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to list workspaces. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workspaces to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkspaces` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListWorkspaces`, with * the exception of `page_size`, must match the call that provided the page * token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.Workspace|Workspace} 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 `listWorkspacesAsync()` * 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. */ listWorkspacesStream(request?: protos.google.cloud.dataform.v1.IListWorkspacesRequest, options?: CallOptions): Transform; /** * Equivalent to `listWorkspaces`, 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 repository in which to list workspaces. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workspaces to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkspaces` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListWorkspaces`, with * the exception of `page_size`, must match the call that provided the page * token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.Workspace|Workspace}. 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 include:samples/generated/v1/dataform.list_workspaces.js * region_tag:dataform_v1_generated_Dataform_ListWorkspaces_async */ listWorkspacesAsync(request?: protos.google.cloud.dataform.v1.IListWorkspacesRequest, options?: CallOptions): AsyncIterable; /** * Returns the contents of a given Workspace directory. * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} [request.path] * Optional. The directory's full path including directory name, relative to * the workspace root. If left unset, the workspace root is used. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryDirectoryContents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryDirectoryContents`, with the exception of `page_size`, must match the * call that provided the page token. * @param {google.cloud.dataform.v1.DirectoryContentsView} [request.view] * Optional. Specifies the metadata to return for each directory entry. * If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`. * Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by * CMEK-protected workspaces. * @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.dataform.v1.DirectoryEntry|DirectoryEntry}. * 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 `queryDirectoryContentsAsync()` * 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. */ queryDirectoryContents(request?: protos.google.cloud.dataform.v1.IQueryDirectoryContentsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IDirectoryEntry[], protos.google.cloud.dataform.v1.IQueryDirectoryContentsRequest | null, protos.google.cloud.dataform.v1.IQueryDirectoryContentsResponse ]>; queryDirectoryContents(request: protos.google.cloud.dataform.v1.IQueryDirectoryContentsRequest, options: CallOptions, callback: PaginationCallback): void; queryDirectoryContents(request: protos.google.cloud.dataform.v1.IQueryDirectoryContentsRequest, callback: PaginationCallback): void; /** * Equivalent to `queryDirectoryContents`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {string} [request.path] * Optional. The directory's full path including directory name, relative to * the workspace root. If left unset, the workspace root is used. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryDirectoryContents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryDirectoryContents`, with the exception of `page_size`, must match the * call that provided the page token. * @param {google.cloud.dataform.v1.DirectoryContentsView} [request.view] * Optional. Specifies the metadata to return for each directory entry. * If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`. * Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by * CMEK-protected workspaces. * @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.dataform.v1.DirectoryEntry|DirectoryEntry} 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 `queryDirectoryContentsAsync()` * 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. */ queryDirectoryContentsStream(request?: protos.google.cloud.dataform.v1.IQueryDirectoryContentsRequest, options?: CallOptions): Transform; /** * Equivalent to `queryDirectoryContents`, 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.workspace * Required. The workspace's name. * @param {string} [request.path] * Optional. The directory's full path including directory name, relative to * the workspace root. If left unset, the workspace root is used. * @param {number} [request.pageSize] * Optional. Maximum number of paths to return. The server may return fewer * items than requested. If unspecified, the server will pick an appropriate * default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `QueryDirectoryContents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `QueryDirectoryContents`, with the exception of `page_size`, must match the * call that provided the page token. * @param {google.cloud.dataform.v1.DirectoryContentsView} [request.view] * Optional. Specifies the metadata to return for each directory entry. * If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`. * Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by * CMEK-protected workspaces. * @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.dataform.v1.DirectoryEntry|DirectoryEntry}. 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 include:samples/generated/v1/dataform.query_directory_contents.js * region_tag:dataform_v1_generated_Dataform_QueryDirectoryContents_async */ queryDirectoryContentsAsync(request?: protos.google.cloud.dataform.v1.IQueryDirectoryContentsRequest, options?: CallOptions): AsyncIterable; /** * Finds the contents of a given Workspace directory by filter. * * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {number} [request.pageSize] * Optional. Maximum number of search results to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `SearchFilesRequest` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `SearchFilesRequest`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.filter] * Optional. Optional filter for the returned list in filtering format. * Filtering is only currently supported on the `path` field. * See https://google.aip.dev/160 for details. * @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.dataform.v1.SearchResult|SearchResult}. * 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 `searchFilesAsync()` * 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. */ searchFiles(request?: protos.google.cloud.dataform.v1.ISearchFilesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ISearchResult[], protos.google.cloud.dataform.v1.ISearchFilesRequest | null, protos.google.cloud.dataform.v1.ISearchFilesResponse ]>; searchFiles(request: protos.google.cloud.dataform.v1.ISearchFilesRequest, options: CallOptions, callback: PaginationCallback): void; searchFiles(request: protos.google.cloud.dataform.v1.ISearchFilesRequest, callback: PaginationCallback): void; /** * Equivalent to `searchFiles`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.workspace * Required. The workspace's name. * @param {number} [request.pageSize] * Optional. Maximum number of search results to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `SearchFilesRequest` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `SearchFilesRequest`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.filter] * Optional. Optional filter for the returned list in filtering format. * Filtering is only currently supported on the `path` field. * See https://google.aip.dev/160 for details. * @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.dataform.v1.SearchResult|SearchResult} 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 `searchFilesAsync()` * 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. */ searchFilesStream(request?: protos.google.cloud.dataform.v1.ISearchFilesRequest, options?: CallOptions): Transform; /** * Equivalent to `searchFiles`, 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.workspace * Required. The workspace's name. * @param {number} [request.pageSize] * Optional. Maximum number of search results to return. The server may return * fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `SearchFilesRequest` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `SearchFilesRequest`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.filter] * Optional. Optional filter for the returned list in filtering format. * Filtering is only currently supported on the `path` field. * See https://google.aip.dev/160 for details. * @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.dataform.v1.SearchResult|SearchResult}. 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 include:samples/generated/v1/dataform.search_files.js * region_tag:dataform_v1_generated_Dataform_SearchFiles_async */ searchFilesAsync(request?: protos.google.cloud.dataform.v1.ISearchFilesRequest, options?: CallOptions): AsyncIterable; /** * Lists ReleaseConfigs in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to list release configs. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of release configs to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListReleaseConfigs` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListReleaseConfigs`, * with the exception of `page_size`, must match the call that provided the * page token. * @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.dataform.v1.ReleaseConfig|ReleaseConfig}. * 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 `listReleaseConfigsAsync()` * 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. */ listReleaseConfigs(request?: protos.google.cloud.dataform.v1.IListReleaseConfigsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IReleaseConfig[], protos.google.cloud.dataform.v1.IListReleaseConfigsRequest | null, protos.google.cloud.dataform.v1.IListReleaseConfigsResponse ]>; listReleaseConfigs(request: protos.google.cloud.dataform.v1.IListReleaseConfigsRequest, options: CallOptions, callback: PaginationCallback): void; listReleaseConfigs(request: protos.google.cloud.dataform.v1.IListReleaseConfigsRequest, callback: PaginationCallback): void; /** * Equivalent to `listReleaseConfigs`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to list release configs. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of release configs to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListReleaseConfigs` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListReleaseConfigs`, * with the exception of `page_size`, must match the call that provided the * page token. * @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.dataform.v1.ReleaseConfig|ReleaseConfig} 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 `listReleaseConfigsAsync()` * 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. */ listReleaseConfigsStream(request?: protos.google.cloud.dataform.v1.IListReleaseConfigsRequest, options?: CallOptions): Transform; /** * Equivalent to `listReleaseConfigs`, 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 repository in which to list release configs. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of release configs to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListReleaseConfigs` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListReleaseConfigs`, * with the exception of `page_size`, must match the call that provided the * 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 protos.google.cloud.dataform.v1.ReleaseConfig|ReleaseConfig}. 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 include:samples/generated/v1/dataform.list_release_configs.js * region_tag:dataform_v1_generated_Dataform_ListReleaseConfigs_async */ listReleaseConfigsAsync(request?: protos.google.cloud.dataform.v1.IListReleaseConfigsRequest, options?: CallOptions): AsyncIterable; /** * Lists CompilationResults in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to list compilation results. Must be in * the format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of compilation results to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListCompilationResults` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListCompilationResults`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name` and `create_time`. * If unspecified, the server will choose the ordering. * If specified, the default order is ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.CompilationResult|CompilationResult}. * 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 `listCompilationResultsAsync()` * 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. */ listCompilationResults(request?: protos.google.cloud.dataform.v1.IListCompilationResultsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ICompilationResult[], protos.google.cloud.dataform.v1.IListCompilationResultsRequest | null, protos.google.cloud.dataform.v1.IListCompilationResultsResponse ]>; listCompilationResults(request: protos.google.cloud.dataform.v1.IListCompilationResultsRequest, options: CallOptions, callback: PaginationCallback): void; listCompilationResults(request: protos.google.cloud.dataform.v1.IListCompilationResultsRequest, callback: PaginationCallback): void; /** * Equivalent to `listCompilationResults`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to list compilation results. Must be in * the format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of compilation results to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListCompilationResults` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListCompilationResults`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name` and `create_time`. * If unspecified, the server will choose the ordering. * If specified, the default order is ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.CompilationResult|CompilationResult} 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 `listCompilationResultsAsync()` * 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. */ listCompilationResultsStream(request?: protos.google.cloud.dataform.v1.IListCompilationResultsRequest, options?: CallOptions): Transform; /** * Equivalent to `listCompilationResults`, 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 repository in which to list compilation results. Must be in * the format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of compilation results to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListCompilationResults` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListCompilationResults`, * with the exception of `page_size`, must match the call that provided the * page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name` and `create_time`. * If unspecified, the server will choose the ordering. * If specified, the default order is ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.CompilationResult|CompilationResult}. 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 include:samples/generated/v1/dataform.list_compilation_results.js * region_tag:dataform_v1_generated_Dataform_ListCompilationResults_async */ listCompilationResultsAsync(request?: protos.google.cloud.dataform.v1.IListCompilationResultsRequest, options?: CallOptions): AsyncIterable; /** * Returns CompilationResultActions in a given CompilationResult. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The compilation result's name. * @param {number} [request.pageSize] * Optional. Maximum number of compilation results to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryCompilationResultActions` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryCompilationResultActions`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.filter] * Optional. Optional filter for the returned list. Filtering is only * currently supported on the `file_path` field. * @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.dataform.v1.CompilationResultAction|CompilationResultAction}. * 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 `queryCompilationResultActionsAsync()` * 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. */ queryCompilationResultActions(request?: protos.google.cloud.dataform.v1.IQueryCompilationResultActionsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.ICompilationResultAction[], protos.google.cloud.dataform.v1.IQueryCompilationResultActionsRequest | null, protos.google.cloud.dataform.v1.IQueryCompilationResultActionsResponse ]>; queryCompilationResultActions(request: protos.google.cloud.dataform.v1.IQueryCompilationResultActionsRequest, options: CallOptions, callback: PaginationCallback): void; queryCompilationResultActions(request: protos.google.cloud.dataform.v1.IQueryCompilationResultActionsRequest, callback: PaginationCallback): void; /** * Equivalent to `queryCompilationResultActions`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The compilation result's name. * @param {number} [request.pageSize] * Optional. Maximum number of compilation results to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryCompilationResultActions` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryCompilationResultActions`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.filter] * Optional. Optional filter for the returned list. Filtering is only * currently supported on the `file_path` field. * @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.dataform.v1.CompilationResultAction|CompilationResultAction} 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 `queryCompilationResultActionsAsync()` * 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. */ queryCompilationResultActionsStream(request?: protos.google.cloud.dataform.v1.IQueryCompilationResultActionsRequest, options?: CallOptions): Transform; /** * Equivalent to `queryCompilationResultActions`, 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.name * Required. The compilation result's name. * @param {number} [request.pageSize] * Optional. Maximum number of compilation results to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryCompilationResultActions` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryCompilationResultActions`, with the exception of `page_size`, must * match the call that provided the page token. * @param {string} [request.filter] * Optional. Optional filter for the returned list. Filtering is only * currently supported on the `file_path` field. * @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.dataform.v1.CompilationResultAction|CompilationResultAction}. 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 include:samples/generated/v1/dataform.query_compilation_result_actions.js * region_tag:dataform_v1_generated_Dataform_QueryCompilationResultActions_async */ queryCompilationResultActionsAsync(request?: protos.google.cloud.dataform.v1.IQueryCompilationResultActionsRequest, options?: CallOptions): AsyncIterable; /** * Lists WorkflowConfigs in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to list workflow configs. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workflow configs to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkflowConfigs` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListWorkflowConfigs`, * with the exception of `page_size`, must match the call that provided the * page token. * @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.dataform.v1.WorkflowConfig|WorkflowConfig}. * 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 `listWorkflowConfigsAsync()` * 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. */ listWorkflowConfigs(request?: protos.google.cloud.dataform.v1.IListWorkflowConfigsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkflowConfig[], protos.google.cloud.dataform.v1.IListWorkflowConfigsRequest | null, protos.google.cloud.dataform.v1.IListWorkflowConfigsResponse ]>; listWorkflowConfigs(request: protos.google.cloud.dataform.v1.IListWorkflowConfigsRequest, options: CallOptions, callback: PaginationCallback): void; listWorkflowConfigs(request: protos.google.cloud.dataform.v1.IListWorkflowConfigsRequest, callback: PaginationCallback): void; /** * Equivalent to `listWorkflowConfigs`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The repository in which to list workflow configs. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workflow configs to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkflowConfigs` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListWorkflowConfigs`, * with the exception of `page_size`, must match the call that provided the * page token. * @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.dataform.v1.WorkflowConfig|WorkflowConfig} 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 `listWorkflowConfigsAsync()` * 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. */ listWorkflowConfigsStream(request?: protos.google.cloud.dataform.v1.IListWorkflowConfigsRequest, options?: CallOptions): Transform; /** * Equivalent to `listWorkflowConfigs`, 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 repository in which to list workflow configs. Must be in the * format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workflow configs to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkflowConfigs` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListWorkflowConfigs`, * with the exception of `page_size`, must match the call that provided the * 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 protos.google.cloud.dataform.v1.WorkflowConfig|WorkflowConfig}. 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 include:samples/generated/v1/dataform.list_workflow_configs.js * region_tag:dataform_v1_generated_Dataform_ListWorkflowConfigs_async */ listWorkflowConfigsAsync(request?: protos.google.cloud.dataform.v1.IListWorkflowConfigsRequest, options?: CallOptions): AsyncIterable; /** * Lists WorkflowInvocations in a given Repository. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource of the WorkflowInvocation type. Must be in * the format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workflow invocations to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkflowInvocations` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListWorkflowInvocations`, with the exception of `page_size`, must match * the call that provided the page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.WorkflowInvocation|WorkflowInvocation}. * 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 `listWorkflowInvocationsAsync()` * 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. */ listWorkflowInvocations(request?: protos.google.cloud.dataform.v1.IListWorkflowInvocationsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkflowInvocation[], protos.google.cloud.dataform.v1.IListWorkflowInvocationsRequest | null, protos.google.cloud.dataform.v1.IListWorkflowInvocationsResponse ]>; listWorkflowInvocations(request: protos.google.cloud.dataform.v1.IListWorkflowInvocationsRequest, options: CallOptions, callback: PaginationCallback): void; listWorkflowInvocations(request: protos.google.cloud.dataform.v1.IListWorkflowInvocationsRequest, callback: PaginationCallback): void; /** * Equivalent to `listWorkflowInvocations`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource of the WorkflowInvocation type. Must be in * the format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workflow invocations to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkflowInvocations` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListWorkflowInvocations`, with the exception of `page_size`, must match * the call that provided the page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.WorkflowInvocation|WorkflowInvocation} 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 `listWorkflowInvocationsAsync()` * 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. */ listWorkflowInvocationsStream(request?: protos.google.cloud.dataform.v1.IListWorkflowInvocationsRequest, options?: CallOptions): Transform; /** * Equivalent to `listWorkflowInvocations`, 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 parent resource of the WorkflowInvocation type. Must be in * the format `projects/* /locations/* /repositories/*`. * @param {number} [request.pageSize] * Optional. Maximum number of workflow invocations to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListWorkflowInvocations` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListWorkflowInvocations`, with the exception of `page_size`, must match * the call that provided the page token. * @param {string} [request.orderBy] * Optional. This field only supports ordering by `name`. If unspecified, the * server will choose the ordering. If specified, the default order is * ascending for the `name` field. * @param {string} [request.filter] * Optional. Filter for the returned list. * @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.dataform.v1.WorkflowInvocation|WorkflowInvocation}. 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 include:samples/generated/v1/dataform.list_workflow_invocations.js * region_tag:dataform_v1_generated_Dataform_ListWorkflowInvocations_async */ listWorkflowInvocationsAsync(request?: protos.google.cloud.dataform.v1.IListWorkflowInvocationsRequest, options?: CallOptions): AsyncIterable; /** * Returns WorkflowInvocationActions in a given WorkflowInvocation. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workflow invocation's name. * @param {number} [request.pageSize] * Optional. Maximum number of workflow invocations to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryWorkflowInvocationActions` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryWorkflowInvocationActions`, with the exception of `page_size`, must * match the call that provided the page token. * @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.dataform.v1.WorkflowInvocationAction|WorkflowInvocationAction}. * 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 `queryWorkflowInvocationActionsAsync()` * 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. */ queryWorkflowInvocationActions(request?: protos.google.cloud.dataform.v1.IQueryWorkflowInvocationActionsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataform.v1.IWorkflowInvocationAction[], protos.google.cloud.dataform.v1.IQueryWorkflowInvocationActionsRequest | null, protos.google.cloud.dataform.v1.IQueryWorkflowInvocationActionsResponse ]>; queryWorkflowInvocationActions(request: protos.google.cloud.dataform.v1.IQueryWorkflowInvocationActionsRequest, options: CallOptions, callback: PaginationCallback): void; queryWorkflowInvocationActions(request: protos.google.cloud.dataform.v1.IQueryWorkflowInvocationActionsRequest, callback: PaginationCallback): void; /** * Equivalent to `queryWorkflowInvocationActions`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The workflow invocation's name. * @param {number} [request.pageSize] * Optional. Maximum number of workflow invocations to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryWorkflowInvocationActions` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryWorkflowInvocationActions`, with the exception of `page_size`, must * match the call that provided the page token. * @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.dataform.v1.WorkflowInvocationAction|WorkflowInvocationAction} 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 `queryWorkflowInvocationActionsAsync()` * 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. */ queryWorkflowInvocationActionsStream(request?: protos.google.cloud.dataform.v1.IQueryWorkflowInvocationActionsRequest, options?: CallOptions): Transform; /** * Equivalent to `queryWorkflowInvocationActions`, 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.name * Required. The workflow invocation's name. * @param {number} [request.pageSize] * Optional. Maximum number of workflow invocations to return. The server may * return fewer items than requested. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Page token received from a previous * `QueryWorkflowInvocationActions` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `QueryWorkflowInvocationActions`, with the exception of `page_size`, must * match the call that provided the 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 protos.google.cloud.dataform.v1.WorkflowInvocationAction|WorkflowInvocationAction}. 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 include:samples/generated/v1/dataform.query_workflow_invocation_actions.js * region_tag:dataform_v1_generated_Dataform_QueryWorkflowInvocationActions_async */ queryWorkflowInvocationActionsAsync(request?: protos.google.cloud.dataform.v1.IQueryWorkflowInvocationActionsRequest, options?: CallOptions): AsyncIterable; /** * Gets the access control policy for a resource. Returns an empty policy * if the resource exists and does not have a policy set. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {Object} [request.options] * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. This field is only used by Cloud IAM. * * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. * @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/interfaces/CallOptions.html | 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.iam.v1.Policy | Policy}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. * The promise has a method named "cancel" which cancels the ongoing API call. */ /** * 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @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/interfaces/CallOptions.html | 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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. */ /** * 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @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/interfaces/CallOptions.html | 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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. * */ /** * 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, callback?: Callback): Promise; /** * 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; /** * 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, callback?: Callback): 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; /** * 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, callback?: Callback): Promise; /** * 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, callback?: Callback): Promise; /** * Return a fully-qualified compilationResult resource name string. * * @param {string} project * @param {string} location * @param {string} repository * @param {string} compilation_result * @returns {string} Resource name string. */ compilationResultPath(project: string, location: string, repository: string, compilationResult: string): string; /** * Parse the project from CompilationResult resource. * * @param {string} compilationResultName * A fully-qualified path representing CompilationResult resource. * @returns {string} A string representing the project. */ matchProjectFromCompilationResultName(compilationResultName: string): string | number; /** * Parse the location from CompilationResult resource. * * @param {string} compilationResultName * A fully-qualified path representing CompilationResult resource. * @returns {string} A string representing the location. */ matchLocationFromCompilationResultName(compilationResultName: string): string | number; /** * Parse the repository from CompilationResult resource. * * @param {string} compilationResultName * A fully-qualified path representing CompilationResult resource. * @returns {string} A string representing the repository. */ matchRepositoryFromCompilationResultName(compilationResultName: string): string | number; /** * Parse the compilation_result from CompilationResult resource. * * @param {string} compilationResultName * A fully-qualified path representing CompilationResult resource. * @returns {string} A string representing the compilation_result. */ matchCompilationResultFromCompilationResultName(compilationResultName: string): string | number; /** * Return a fully-qualified config resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ configPath(project: string, location: string): string; /** * Parse the project from Config resource. * * @param {string} configName * A fully-qualified path representing Config resource. * @returns {string} A string representing the project. */ matchProjectFromConfigName(configName: string): string | number; /** * Parse the location from Config resource. * * @param {string} configName * A fully-qualified path representing Config resource. * @returns {string} A string representing the location. */ matchLocationFromConfigName(configName: string): string | number; /** * Return a fully-qualified cryptoKey resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} crypto_key * @returns {string} Resource name string. */ cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string; /** * Parse the project from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the project. */ matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the location from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the location. */ matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the key_ring from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the crypto_key from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the crypto_key. */ matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Return a fully-qualified cryptoKeyVersion resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} crypto_key * @param {string} crypto_key_version * @returns {string} Resource name string. */ cryptoKeyVersionPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string; /** * Parse the project from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the project. */ matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Parse the location from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the location. */ matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Parse the key_ring from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Parse the crypto_key from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the crypto_key. */ matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Parse the crypto_key_version from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the crypto_key_version. */ matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Return a fully-qualified folder resource name string. * * @param {string} project * @param {string} location * @param {string} folder * @returns {string} Resource name string. */ folderPath(project: string, location: string, folder: string): string; /** * Parse the project from Folder resource. * * @param {string} folderName * A fully-qualified path representing Folder resource. * @returns {string} A string representing the project. */ matchProjectFromFolderName(folderName: string): string | number; /** * Parse the location from Folder resource. * * @param {string} folderName * A fully-qualified path representing Folder resource. * @returns {string} A string representing the location. */ matchLocationFromFolderName(folderName: string): string | number; /** * Parse the folder from Folder resource. * * @param {string} folderName * A fully-qualified path representing Folder resource. * @returns {string} A string representing the folder. */ matchFolderFromFolderName(folderName: string): string | number; /** * Return a fully-qualified location resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ locationPath(project: string, location: string): string; /** * Parse the project from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the project. */ matchProjectFromLocationName(locationName: string): string | number; /** * Parse the location from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the location. */ matchLocationFromLocationName(locationName: string): string | number; /** * Return a fully-qualified notebookRuntimeTemplate resource name string. * * @param {string} project * @param {string} location * @param {string} notebook_runtime_template * @returns {string} Resource name string. */ notebookRuntimeTemplatePath(project: string, location: string, notebookRuntimeTemplate: string): string; /** * Parse the project from NotebookRuntimeTemplate resource. * * @param {string} notebookRuntimeTemplateName * A fully-qualified path representing NotebookRuntimeTemplate resource. * @returns {string} A string representing the project. */ matchProjectFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number; /** * Parse the location from NotebookRuntimeTemplate resource. * * @param {string} notebookRuntimeTemplateName * A fully-qualified path representing NotebookRuntimeTemplate resource. * @returns {string} A string representing the location. */ matchLocationFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number; /** * Parse the notebook_runtime_template from NotebookRuntimeTemplate resource. * * @param {string} notebookRuntimeTemplateName * A fully-qualified path representing NotebookRuntimeTemplate resource. * @returns {string} A string representing the notebook_runtime_template. */ matchNotebookRuntimeTemplateFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number; /** * Return a fully-qualified releaseConfig resource name string. * * @param {string} project * @param {string} location * @param {string} repository * @param {string} release_config * @returns {string} Resource name string. */ releaseConfigPath(project: string, location: string, repository: string, releaseConfig: string): string; /** * Parse the project from ReleaseConfig resource. * * @param {string} releaseConfigName * A fully-qualified path representing ReleaseConfig resource. * @returns {string} A string representing the project. */ matchProjectFromReleaseConfigName(releaseConfigName: string): string | number; /** * Parse the location from ReleaseConfig resource. * * @param {string} releaseConfigName * A fully-qualified path representing ReleaseConfig resource. * @returns {string} A string representing the location. */ matchLocationFromReleaseConfigName(releaseConfigName: string): string | number; /** * Parse the repository from ReleaseConfig resource. * * @param {string} releaseConfigName * A fully-qualified path representing ReleaseConfig resource. * @returns {string} A string representing the repository. */ matchRepositoryFromReleaseConfigName(releaseConfigName: string): string | number; /** * Parse the release_config from ReleaseConfig resource. * * @param {string} releaseConfigName * A fully-qualified path representing ReleaseConfig resource. * @returns {string} A string representing the release_config. */ matchReleaseConfigFromReleaseConfigName(releaseConfigName: string): string | number; /** * Return a fully-qualified repository resource name string. * * @param {string} project * @param {string} location * @param {string} repository * @returns {string} Resource name string. */ repositoryPath(project: string, location: string, repository: string): string; /** * Parse the project from Repository resource. * * @param {string} repositoryName * A fully-qualified path representing Repository resource. * @returns {string} A string representing the project. */ matchProjectFromRepositoryName(repositoryName: string): string | number; /** * Parse the location from Repository resource. * * @param {string} repositoryName * A fully-qualified path representing Repository resource. * @returns {string} A string representing the location. */ matchLocationFromRepositoryName(repositoryName: string): string | number; /** * Parse the repository from Repository resource. * * @param {string} repositoryName * A fully-qualified path representing Repository resource. * @returns {string} A string representing the repository. */ matchRepositoryFromRepositoryName(repositoryName: string): string | number; /** * Return a fully-qualified secretVersion resource name string. * * @param {string} project * @param {string} secret * @param {string} version * @returns {string} Resource name string. */ secretVersionPath(project: string, secret: string, version: string): string; /** * Parse the project from SecretVersion resource. * * @param {string} secretVersionName * A fully-qualified path representing SecretVersion resource. * @returns {string} A string representing the project. */ matchProjectFromSecretVersionName(secretVersionName: string): string | number; /** * Parse the secret from SecretVersion resource. * * @param {string} secretVersionName * A fully-qualified path representing SecretVersion resource. * @returns {string} A string representing the secret. */ matchSecretFromSecretVersionName(secretVersionName: string): string | number; /** * Parse the version from SecretVersion resource. * * @param {string} secretVersionName * A fully-qualified path representing SecretVersion resource. * @returns {string} A string representing the version. */ matchVersionFromSecretVersionName(secretVersionName: string): string | number; /** * Return a fully-qualified teamFolder resource name string. * * @param {string} project * @param {string} location * @param {string} team_folder * @returns {string} Resource name string. */ teamFolderPath(project: string, location: string, teamFolder: string): string; /** * Parse the project from TeamFolder resource. * * @param {string} teamFolderName * A fully-qualified path representing TeamFolder resource. * @returns {string} A string representing the project. */ matchProjectFromTeamFolderName(teamFolderName: string): string | number; /** * Parse the location from TeamFolder resource. * * @param {string} teamFolderName * A fully-qualified path representing TeamFolder resource. * @returns {string} A string representing the location. */ matchLocationFromTeamFolderName(teamFolderName: string): string | number; /** * Parse the team_folder from TeamFolder resource. * * @param {string} teamFolderName * A fully-qualified path representing TeamFolder resource. * @returns {string} A string representing the team_folder. */ matchTeamFolderFromTeamFolderName(teamFolderName: string): string | number; /** * Return a fully-qualified workflowConfig resource name string. * * @param {string} project * @param {string} location * @param {string} repository * @param {string} workflow_config * @returns {string} Resource name string. */ workflowConfigPath(project: string, location: string, repository: string, workflowConfig: string): string; /** * Parse the project from WorkflowConfig resource. * * @param {string} workflowConfigName * A fully-qualified path representing WorkflowConfig resource. * @returns {string} A string representing the project. */ matchProjectFromWorkflowConfigName(workflowConfigName: string): string | number; /** * Parse the location from WorkflowConfig resource. * * @param {string} workflowConfigName * A fully-qualified path representing WorkflowConfig resource. * @returns {string} A string representing the location. */ matchLocationFromWorkflowConfigName(workflowConfigName: string): string | number; /** * Parse the repository from WorkflowConfig resource. * * @param {string} workflowConfigName * A fully-qualified path representing WorkflowConfig resource. * @returns {string} A string representing the repository. */ matchRepositoryFromWorkflowConfigName(workflowConfigName: string): string | number; /** * Parse the workflow_config from WorkflowConfig resource. * * @param {string} workflowConfigName * A fully-qualified path representing WorkflowConfig resource. * @returns {string} A string representing the workflow_config. */ matchWorkflowConfigFromWorkflowConfigName(workflowConfigName: string): string | number; /** * Return a fully-qualified workflowInvocation resource name string. * * @param {string} project * @param {string} location * @param {string} repository * @param {string} workflow_invocation * @returns {string} Resource name string. */ workflowInvocationPath(project: string, location: string, repository: string, workflowInvocation: string): string; /** * Parse the project from WorkflowInvocation resource. * * @param {string} workflowInvocationName * A fully-qualified path representing WorkflowInvocation resource. * @returns {string} A string representing the project. */ matchProjectFromWorkflowInvocationName(workflowInvocationName: string): string | number; /** * Parse the location from WorkflowInvocation resource. * * @param {string} workflowInvocationName * A fully-qualified path representing WorkflowInvocation resource. * @returns {string} A string representing the location. */ matchLocationFromWorkflowInvocationName(workflowInvocationName: string): string | number; /** * Parse the repository from WorkflowInvocation resource. * * @param {string} workflowInvocationName * A fully-qualified path representing WorkflowInvocation resource. * @returns {string} A string representing the repository. */ matchRepositoryFromWorkflowInvocationName(workflowInvocationName: string): string | number; /** * Parse the workflow_invocation from WorkflowInvocation resource. * * @param {string} workflowInvocationName * A fully-qualified path representing WorkflowInvocation resource. * @returns {string} A string representing the workflow_invocation. */ matchWorkflowInvocationFromWorkflowInvocationName(workflowInvocationName: string): string | number; /** * Return a fully-qualified workspace resource name string. * * @param {string} project * @param {string} location * @param {string} repository * @param {string} workspace * @returns {string} Resource name string. */ workspacePath(project: string, location: string, repository: string, workspace: string): string; /** * Parse the project from Workspace resource. * * @param {string} workspaceName * A fully-qualified path representing Workspace resource. * @returns {string} A string representing the project. */ matchProjectFromWorkspaceName(workspaceName: string): string | number; /** * Parse the location from Workspace resource. * * @param {string} workspaceName * A fully-qualified path representing Workspace resource. * @returns {string} A string representing the location. */ matchLocationFromWorkspaceName(workspaceName: string): string | number; /** * Parse the repository from Workspace resource. * * @param {string} workspaceName * A fully-qualified path representing Workspace resource. * @returns {string} A string representing the repository. */ matchRepositoryFromWorkspaceName(workspaceName: string): string | number; /** * Parse the workspace from Workspace resource. * * @param {string} workspaceName * A fully-qualified path representing Workspace resource. * @returns {string} A string representing the workspace. */ matchWorkspaceFromWorkspaceName(workspaceName: string): string | number; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }