@google-cloud/video-transcoder
Version:
Transcoder client for Node.js
581 lines (580 loc) • 34.6 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* Using the Transcoder API, you can queue asynchronous jobs for transcoding
* media into various output formats. Output formats may include different
* streaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive
* Streaming over HTTP (DASH). You can also customize jobs using advanced
* features such as Digital Rights Management (DRM), audio equalization, content
* concatenation, and digital ad-stitch ready content generation.
* @class
* @memberof v1
*/
export declare class TranscoderServiceClient {
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;
};
pathTemplates: {
[name: string]: gax.PathTemplate;
};
transcoderServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of TranscoderServiceClient.
*
* @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 TranscoderServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Creates a job in the specified region.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent location to create and process this job.
* Format: `projects/{project}/locations/{location}`
* @param {google.cloud.video.transcoder.v1.Job} request.job
* Required. Parameters for creating transcoding job.
* @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.video.transcoder.v1.Job|Job}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/transcoder_service.create_job.js</caption>
* region_tag:transcoder_v1_generated_TranscoderService_CreateJob_async
*/
createJob(request?: protos.google.cloud.video.transcoder.v1.ICreateJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.video.transcoder.v1.IJob,
protos.google.cloud.video.transcoder.v1.ICreateJobRequest | undefined,
{} | undefined
]>;
createJob(request: protos.google.cloud.video.transcoder.v1.ICreateJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.transcoder.v1.IJob, protos.google.cloud.video.transcoder.v1.ICreateJobRequest | null | undefined, {} | null | undefined>): void;
createJob(request: protos.google.cloud.video.transcoder.v1.ICreateJobRequest, callback: Callback<protos.google.cloud.video.transcoder.v1.IJob, protos.google.cloud.video.transcoder.v1.ICreateJobRequest | null | undefined, {} | null | undefined>): void;
/**
* Returns the job data.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the job to retrieve.
* Format: `projects/{project}/locations/{location}/jobs/{job}`
* @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.video.transcoder.v1.Job|Job}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/transcoder_service.get_job.js</caption>
* region_tag:transcoder_v1_generated_TranscoderService_GetJob_async
*/
getJob(request?: protos.google.cloud.video.transcoder.v1.IGetJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.video.transcoder.v1.IJob,
protos.google.cloud.video.transcoder.v1.IGetJobRequest | undefined,
{} | undefined
]>;
getJob(request: protos.google.cloud.video.transcoder.v1.IGetJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.transcoder.v1.IJob, protos.google.cloud.video.transcoder.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;
getJob(request: protos.google.cloud.video.transcoder.v1.IGetJobRequest, callback: Callback<protos.google.cloud.video.transcoder.v1.IJob, protos.google.cloud.video.transcoder.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes a job.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the job to delete.
* Format: `projects/{project}/locations/{location}/jobs/{job}`
* @param {boolean} request.allowMissing
* If set to true, and the job is not found, the request will succeed but no
* action will be taken on the server.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/transcoder_service.delete_job.js</caption>
* region_tag:transcoder_v1_generated_TranscoderService_DeleteJob_async
*/
deleteJob(request?: protos.google.cloud.video.transcoder.v1.IDeleteJobRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.video.transcoder.v1.IDeleteJobRequest | undefined,
{} | undefined
]>;
deleteJob(request: protos.google.cloud.video.transcoder.v1.IDeleteJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.transcoder.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>): void;
deleteJob(request: protos.google.cloud.video.transcoder.v1.IDeleteJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.transcoder.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a job template in the specified region.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent location to create this job template.
* Format: `projects/{project}/locations/{location}`
* @param {google.cloud.video.transcoder.v1.JobTemplate} request.jobTemplate
* Required. Parameters for creating job template.
* @param {string} request.jobTemplateId
* Required. The ID to use for the job template, which will become the final
* component of the job template's resource name.
*
* This value should be 4-63 characters, and valid characters must match the
* regular expression `{@link protos.a-zA-Z0-9_-|a-zA-Z}*`.
* @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.video.transcoder.v1.JobTemplate|JobTemplate}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/transcoder_service.create_job_template.js</caption>
* region_tag:transcoder_v1_generated_TranscoderService_CreateJobTemplate_async
*/
createJobTemplate(request?: protos.google.cloud.video.transcoder.v1.ICreateJobTemplateRequest, options?: CallOptions): Promise<[
protos.google.cloud.video.transcoder.v1.IJobTemplate,
protos.google.cloud.video.transcoder.v1.ICreateJobTemplateRequest | undefined,
{} | undefined
]>;
createJobTemplate(request: protos.google.cloud.video.transcoder.v1.ICreateJobTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.transcoder.v1.IJobTemplate, protos.google.cloud.video.transcoder.v1.ICreateJobTemplateRequest | null | undefined, {} | null | undefined>): void;
createJobTemplate(request: protos.google.cloud.video.transcoder.v1.ICreateJobTemplateRequest, callback: Callback<protos.google.cloud.video.transcoder.v1.IJobTemplate, protos.google.cloud.video.transcoder.v1.ICreateJobTemplateRequest | null | undefined, {} | null | undefined>): void;
/**
* Returns the job template data.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the job template to retrieve.
* Format:
* `projects/{project}/locations/{location}/jobTemplates/{job_template}`
* @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.video.transcoder.v1.JobTemplate|JobTemplate}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/transcoder_service.get_job_template.js</caption>
* region_tag:transcoder_v1_generated_TranscoderService_GetJobTemplate_async
*/
getJobTemplate(request?: protos.google.cloud.video.transcoder.v1.IGetJobTemplateRequest, options?: CallOptions): Promise<[
protos.google.cloud.video.transcoder.v1.IJobTemplate,
protos.google.cloud.video.transcoder.v1.IGetJobTemplateRequest | undefined,
{} | undefined
]>;
getJobTemplate(request: protos.google.cloud.video.transcoder.v1.IGetJobTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.transcoder.v1.IJobTemplate, protos.google.cloud.video.transcoder.v1.IGetJobTemplateRequest | null | undefined, {} | null | undefined>): void;
getJobTemplate(request: protos.google.cloud.video.transcoder.v1.IGetJobTemplateRequest, callback: Callback<protos.google.cloud.video.transcoder.v1.IJobTemplate, protos.google.cloud.video.transcoder.v1.IGetJobTemplateRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes a job template.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the job template to delete.
* `projects/{project}/locations/{location}/jobTemplates/{job_template}`
* @param {boolean} request.allowMissing
* If set to true, and the job template is not found, the request will succeed
* but no action will be taken on the server.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/transcoder_service.delete_job_template.js</caption>
* region_tag:transcoder_v1_generated_TranscoderService_DeleteJobTemplate_async
*/
deleteJobTemplate(request?: protos.google.cloud.video.transcoder.v1.IDeleteJobTemplateRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.video.transcoder.v1.IDeleteJobTemplateRequest | undefined,
{} | undefined
]>;
deleteJobTemplate(request: protos.google.cloud.video.transcoder.v1.IDeleteJobTemplateRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.transcoder.v1.IDeleteJobTemplateRequest | null | undefined, {} | null | undefined>): void;
deleteJobTemplate(request: protos.google.cloud.video.transcoder.v1.IDeleteJobTemplateRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.transcoder.v1.IDeleteJobTemplateRequest | null | undefined, {} | null | undefined>): void;
/**
* Lists jobs in the specified region.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. Format: `projects/{project}/locations/{location}`
* @param {number} request.pageSize
* The maximum number of items to return.
* @param {string} request.pageToken
* The `next_page_token` value returned from a previous List request, if
* any.
* @param {string} request.filter
* The filter expression, following the syntax outlined in
* https://google.aip.dev/160.
* @param {string} request.orderBy
* One or more fields to compare and use to sort the output.
* See https://google.aip.dev/132#ordering.
* @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.video.transcoder.v1.Job|Job}.
* 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 `listJobsAsync()`
* 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.
*/
listJobs(request?: protos.google.cloud.video.transcoder.v1.IListJobsRequest, options?: CallOptions): Promise<[
protos.google.cloud.video.transcoder.v1.IJob[],
protos.google.cloud.video.transcoder.v1.IListJobsRequest | null,
protos.google.cloud.video.transcoder.v1.IListJobsResponse
]>;
listJobs(request: protos.google.cloud.video.transcoder.v1.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.video.transcoder.v1.IListJobsRequest, protos.google.cloud.video.transcoder.v1.IListJobsResponse | null | undefined, protos.google.cloud.video.transcoder.v1.IJob>): void;
listJobs(request: protos.google.cloud.video.transcoder.v1.IListJobsRequest, callback: PaginationCallback<protos.google.cloud.video.transcoder.v1.IListJobsRequest, protos.google.cloud.video.transcoder.v1.IListJobsResponse | null | undefined, protos.google.cloud.video.transcoder.v1.IJob>): void;
/**
* Equivalent to `listJobs`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. Format: `projects/{project}/locations/{location}`
* @param {number} request.pageSize
* The maximum number of items to return.
* @param {string} request.pageToken
* The `next_page_token` value returned from a previous List request, if
* any.
* @param {string} request.filter
* The filter expression, following the syntax outlined in
* https://google.aip.dev/160.
* @param {string} request.orderBy
* One or more fields to compare and use to sort the output.
* See https://google.aip.dev/132#ordering.
* @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.video.transcoder.v1.Job|Job} 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 `listJobsAsync()`
* 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.
*/
listJobsStream(request?: protos.google.cloud.video.transcoder.v1.IListJobsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listJobs`, 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. Format: `projects/{project}/locations/{location}`
* @param {number} request.pageSize
* The maximum number of items to return.
* @param {string} request.pageToken
* The `next_page_token` value returned from a previous List request, if
* any.
* @param {string} request.filter
* The filter expression, following the syntax outlined in
* https://google.aip.dev/160.
* @param {string} request.orderBy
* One or more fields to compare and use to sort the output.
* See https://google.aip.dev/132#ordering.
* @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.video.transcoder.v1.Job|Job}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/transcoder_service.list_jobs.js</caption>
* region_tag:transcoder_v1_generated_TranscoderService_ListJobs_async
*/
listJobsAsync(request?: protos.google.cloud.video.transcoder.v1.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.video.transcoder.v1.IJob>;
/**
* Lists job templates in the specified region.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent location from which to retrieve the collection of job
* templates. Format: `projects/{project}/locations/{location}`
* @param {number} request.pageSize
* The maximum number of items to return.
* @param {string} request.pageToken
* The `next_page_token` value returned from a previous List request, if
* any.
* @param {string} request.filter
* The filter expression, following the syntax outlined in
* https://google.aip.dev/160.
* @param {string} request.orderBy
* One or more fields to compare and use to sort the output.
* See https://google.aip.dev/132#ordering.
* @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.video.transcoder.v1.JobTemplate|JobTemplate}.
* 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 `listJobTemplatesAsync()`
* 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.
*/
listJobTemplates(request?: protos.google.cloud.video.transcoder.v1.IListJobTemplatesRequest, options?: CallOptions): Promise<[
protos.google.cloud.video.transcoder.v1.IJobTemplate[],
protos.google.cloud.video.transcoder.v1.IListJobTemplatesRequest | null,
protos.google.cloud.video.transcoder.v1.IListJobTemplatesResponse
]>;
listJobTemplates(request: protos.google.cloud.video.transcoder.v1.IListJobTemplatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.video.transcoder.v1.IListJobTemplatesRequest, protos.google.cloud.video.transcoder.v1.IListJobTemplatesResponse | null | undefined, protos.google.cloud.video.transcoder.v1.IJobTemplate>): void;
listJobTemplates(request: protos.google.cloud.video.transcoder.v1.IListJobTemplatesRequest, callback: PaginationCallback<protos.google.cloud.video.transcoder.v1.IListJobTemplatesRequest, protos.google.cloud.video.transcoder.v1.IListJobTemplatesResponse | null | undefined, protos.google.cloud.video.transcoder.v1.IJobTemplate>): void;
/**
* Equivalent to `listJobTemplates`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent location from which to retrieve the collection of job
* templates. Format: `projects/{project}/locations/{location}`
* @param {number} request.pageSize
* The maximum number of items to return.
* @param {string} request.pageToken
* The `next_page_token` value returned from a previous List request, if
* any.
* @param {string} request.filter
* The filter expression, following the syntax outlined in
* https://google.aip.dev/160.
* @param {string} request.orderBy
* One or more fields to compare and use to sort the output.
* See https://google.aip.dev/132#ordering.
* @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.video.transcoder.v1.JobTemplate|JobTemplate} 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 `listJobTemplatesAsync()`
* 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.
*/
listJobTemplatesStream(request?: protos.google.cloud.video.transcoder.v1.IListJobTemplatesRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listJobTemplates`, 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 location from which to retrieve the collection of job
* templates. Format: `projects/{project}/locations/{location}`
* @param {number} request.pageSize
* The maximum number of items to return.
* @param {string} request.pageToken
* The `next_page_token` value returned from a previous List request, if
* any.
* @param {string} request.filter
* The filter expression, following the syntax outlined in
* https://google.aip.dev/160.
* @param {string} request.orderBy
* One or more fields to compare and use to sort the output.
* See https://google.aip.dev/132#ordering.
* @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.video.transcoder.v1.JobTemplate|JobTemplate}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/transcoder_service.list_job_templates.js</caption>
* region_tag:transcoder_v1_generated_TranscoderService_ListJobTemplates_async
*/
listJobTemplatesAsync(request?: protos.google.cloud.video.transcoder.v1.IListJobTemplatesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.video.transcoder.v1.IJobTemplate>;
/**
* Return a fully-qualified job resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} job
* @returns {string} Resource name string.
*/
jobPath(project: string, location: string, job: string): string;
/**
* Parse the project from Job resource.
*
* @param {string} jobName
* A fully-qualified path representing Job resource.
* @returns {string} A string representing the project.
*/
matchProjectFromJobName(jobName: string): string | number;
/**
* Parse the location from Job resource.
*
* @param {string} jobName
* A fully-qualified path representing Job resource.
* @returns {string} A string representing the location.
*/
matchLocationFromJobName(jobName: string): string | number;
/**
* Parse the job from Job resource.
*
* @param {string} jobName
* A fully-qualified path representing Job resource.
* @returns {string} A string representing the job.
*/
matchJobFromJobName(jobName: string): string | number;
/**
* Return a fully-qualified jobTemplate resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} job_template
* @returns {string} Resource name string.
*/
jobTemplatePath(project: string, location: string, jobTemplate: string): string;
/**
* Parse the project from JobTemplate resource.
*
* @param {string} jobTemplateName
* A fully-qualified path representing JobTemplate resource.
* @returns {string} A string representing the project.
*/
matchProjectFromJobTemplateName(jobTemplateName: string): string | number;
/**
* Parse the location from JobTemplate resource.
*
* @param {string} jobTemplateName
* A fully-qualified path representing JobTemplate resource.
* @returns {string} A string representing the location.
*/
matchLocationFromJobTemplateName(jobTemplateName: string): string | number;
/**
* Parse the job_template from JobTemplate resource.
*
* @param {string} jobTemplateName
* A fully-qualified path representing JobTemplate resource.
* @returns {string} A string representing the job_template.
*/
matchJobTemplateFromJobTemplateName(jobTemplateName: 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;
/**
* 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<void>;
}