@google-cloud/vision
Version:
Google Cloud Vision API client for Node.js
581 lines (580 loc) • 32.2 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation } from 'google-gax';
import * as protos from '../../protos/protos';
/**
* Service that performs Google Cloud Vision API detection tasks over client
* images, such as face, landmark, logo, label, and text detection. The
* ImageAnnotator service returns detected entities from the images.
* @class
* @memberof v1
*/
export declare class ImageAnnotatorClient {
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;
};
operationsClient: gax.OperationsClient;
imageAnnotatorStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of ImageAnnotatorClient.
*
* @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 ImageAnnotatorClient({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;
/**
* Run image detection and annotation for a batch of images.
*
* @param {Object} request
* The request object that will be sent.
* @param {number[]} request.requests
* Required. Individual image annotation requests for this batch.
* @param {string} request.parent
* Optional. Target project and location to make a call.
*
* Format: `projects/{project-id}/locations/{location-id}`.
*
* If no parent is specified, a region will be chosen automatically.
*
* Supported location-ids:
* `us`: USA country only,
* `asia`: East asia areas, like Japan, Taiwan,
* `eu`: The European Union.
*
* Example: `projects/project-A/locations/eu`.
* @param {number[]} [request.labels]
* Optional. The labels with user-defined metadata for the request.
*
* Label keys and values can be no longer than 63 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* @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.vision.v1.BatchAnnotateImagesResponse|BatchAnnotateImagesResponse}.
* 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/image_annotator.batch_annotate_images.js</caption>
* region_tag:vision_v1_generated_ImageAnnotator_BatchAnnotateImages_async
*/
batchAnnotateImages(request?: protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vision.v1.IBatchAnnotateImagesResponse,
protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest | undefined,
{} | undefined
]>;
batchAnnotateImages(request: protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void;
batchAnnotateImages(request: protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest, callback: Callback<protos.google.cloud.vision.v1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void;
/**
* Service that performs image detection and annotation for a batch of files.
* Now only "application/pdf", "image/tiff" and "image/gif" are supported.
*
* This service will extract at most 5 (customers can specify which 5 in
* AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each
* file provided and perform detection and annotation for each image
* extracted.
*
* @param {Object} request
* The request object that will be sent.
* @param {number[]} request.requests
* Required. The list of file annotation requests. Right now we support only
* one AnnotateFileRequest in BatchAnnotateFilesRequest.
* @param {string} request.parent
* Optional. Target project and location to make a call.
*
* Format: `projects/{project-id}/locations/{location-id}`.
*
* If no parent is specified, a region will be chosen automatically.
*
* Supported location-ids:
* `us`: USA country only,
* `asia`: East asia areas, like Japan, Taiwan,
* `eu`: The European Union.
*
* Example: `projects/project-A/locations/eu`.
* @param {number[]} [request.labels]
* Optional. The labels with user-defined metadata for the request.
*
* Label keys and values can be no longer than 63 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* @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.vision.v1.BatchAnnotateFilesResponse|BatchAnnotateFilesResponse}.
* 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/image_annotator.batch_annotate_files.js</caption>
* region_tag:vision_v1_generated_ImageAnnotator_BatchAnnotateFiles_async
*/
batchAnnotateFiles(request?: protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vision.v1.IBatchAnnotateFilesResponse,
protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest | undefined,
{} | undefined
]>;
batchAnnotateFiles(request: protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1.IBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest | null | undefined, {} | null | undefined>): void;
batchAnnotateFiles(request: protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest, callback: Callback<protos.google.cloud.vision.v1.IBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest | null | undefined, {} | null | undefined>): void;
/**
* Run asynchronous image detection and annotation for a list of images.
*
* Progress and results can be retrieved through the
* `google.longrunning.Operations` interface.
* `Operation.metadata` contains `OperationMetadata` (metadata).
* `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).
*
* This service will write image annotation outputs to json files in customer
* GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
*
* @param {Object} request
* The request object that will be sent.
* @param {number[]} request.requests
* Required. Individual image annotation requests for this batch.
* @param {google.cloud.vision.v1.OutputConfig} request.outputConfig
* Required. The desired output location and metadata (e.g. format).
* @param {string} request.parent
* Optional. Target project and location to make a call.
*
* Format: `projects/{project-id}/locations/{location-id}`.
*
* If no parent is specified, a region will be chosen automatically.
*
* Supported location-ids:
* `us`: USA country only,
* `asia`: East asia areas, like Japan, Taiwan,
* `eu`: The European Union.
*
* Example: `projects/project-A/locations/eu`.
* @param {number[]} [request.labels]
* Optional. The labels with user-defined metadata for the request.
*
* Label keys and values can be no longer than 63 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* @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 <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_images.js</caption>
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateImages_async
*/
asyncBatchAnnotateImages(request?: protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
asyncBatchAnnotateImages(request: protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
asyncBatchAnnotateImages(request: protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesRequest, callback: Callback<LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `asyncBatchAnnotateImages()`.
* @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 <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_images.js</caption>
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateImages_async
*/
checkAsyncBatchAnnotateImagesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.OperationMetadata>>;
/**
* Run asynchronous image detection and annotation for a list of generic
* files, such as PDF files, which may contain multiple pages and multiple
* images per page. Progress and results can be retrieved through the
* `google.longrunning.Operations` interface.
* `Operation.metadata` contains `OperationMetadata` (metadata).
* `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
*
* @param {Object} request
* The request object that will be sent.
* @param {number[]} request.requests
* Required. Individual async file annotation requests for this batch.
* @param {string} request.parent
* Optional. Target project and location to make a call.
*
* Format: `projects/{project-id}/locations/{location-id}`.
*
* If no parent is specified, a region will be chosen automatically.
*
* Supported location-ids:
* `us`: USA country only,
* `asia`: East asia areas, like Japan, Taiwan,
* `eu`: The European Union.
*
* Example: `projects/project-A/locations/eu`.
* @param {number[]} [request.labels]
* Optional. The labels with user-defined metadata for the request.
*
* Label keys and values can be no longer than 63 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* @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 <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_files.js</caption>
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async
*/
asyncBatchAnnotateFiles(request?: protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
asyncBatchAnnotateFiles(request: protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
asyncBatchAnnotateFiles(request: protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesRequest, callback: Callback<LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `asyncBatchAnnotateFiles()`.
* @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 <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_files.js</caption>
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async
*/
checkAsyncBatchAnnotateFilesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.OperationMetadata>>;
/**
* Gets the latest state of a long-running operation. Clients can use this
* method to poll the operation result at intervals as recommended by the API
* service.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback
* The function which will be called with the result of the API call.
*
* The second parameter to the callback is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* const name = '';
* const [response] = await client.getOperation({name});
* // doThingsWith(response)
* ```
*/
getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
/**
* Lists operations that match the specified filter in the request. If the
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
*
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation collection.
* @param {string} request.filter - The standard list filter.
* @param {number=} request.pageSize -
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*
* @example
* ```
* const client = longrunning.operationsClient();
* for await (const response of client.listOperationsAsync(request));
* // doThingsWith(response)
* ```
*/
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
/**
* Starts asynchronous cancellation on a long-running operation. The server
* makes a best effort to cancel the operation, but success is not
* guaranteed. If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use
* {@link Operations.GetOperation} or
* other methods to check whether the cancellation succeeded or whether the
* operation completed despite cancellation. On successful cancellation,
* the operation is not deleted; instead, it becomes an operation with
* an {@link Operation.error} value with a {@link google.rpc.Status.code} of
* 1, corresponding to `Code.CANCELLED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be cancelled.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.cancelOperation({name: ''});
* ```
*/
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
/**
* Deletes a long-running operation. This method indicates that the client is
* no longer interested in the operation result. It does not cancel the
* operation. If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be deleted.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.deleteOperation({name: ''});
* ```
*/
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
/**
* Return a fully-qualified product resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} product
* @returns {string} Resource name string.
*/
productPath(project: string, location: string, product: string): string;
/**
* Parse the project from Product resource.
*
* @param {string} productName
* A fully-qualified path representing Product resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProductName(productName: string): string | number;
/**
* Parse the location from Product resource.
*
* @param {string} productName
* A fully-qualified path representing Product resource.
* @returns {string} A string representing the location.
*/
matchLocationFromProductName(productName: string): string | number;
/**
* Parse the product from Product resource.
*
* @param {string} productName
* A fully-qualified path representing Product resource.
* @returns {string} A string representing the product.
*/
matchProductFromProductName(productName: string): string | number;
/**
* Return a fully-qualified productSet resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} product_set
* @returns {string} Resource name string.
*/
productSetPath(project: string, location: string, productSet: string): string;
/**
* Parse the project from ProductSet resource.
*
* @param {string} productSetName
* A fully-qualified path representing ProductSet resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProductSetName(productSetName: string): string | number;
/**
* Parse the location from ProductSet resource.
*
* @param {string} productSetName
* A fully-qualified path representing ProductSet resource.
* @returns {string} A string representing the location.
*/
matchLocationFromProductSetName(productSetName: string): string | number;
/**
* Parse the product_set from ProductSet resource.
*
* @param {string} productSetName
* A fully-qualified path representing ProductSet resource.
* @returns {string} A string representing the product_set.
*/
matchProductSetFromProductSetName(productSetName: string): string | number;
/**
* Return a fully-qualified referenceImage resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} product
* @param {string} reference_image
* @returns {string} Resource name string.
*/
referenceImagePath(project: string, location: string, product: string, referenceImage: string): string;
/**
* Parse the project from ReferenceImage resource.
*
* @param {string} referenceImageName
* A fully-qualified path representing ReferenceImage resource.
* @returns {string} A string representing the project.
*/
matchProjectFromReferenceImageName(referenceImageName: string): string | number;
/**
* Parse the location from ReferenceImage resource.
*
* @param {string} referenceImageName
* A fully-qualified path representing ReferenceImage resource.
* @returns {string} A string representing the location.
*/
matchLocationFromReferenceImageName(referenceImageName: string): string | number;
/**
* Parse the product from ReferenceImage resource.
*
* @param {string} referenceImageName
* A fully-qualified path representing ReferenceImage resource.
* @returns {string} A string representing the product.
*/
matchProductFromReferenceImageName(referenceImageName: string): string | number;
/**
* Parse the reference_image from ReferenceImage resource.
*
* @param {string} referenceImageName
* A fully-qualified path representing ReferenceImage resource.
* @returns {string} A string representing the reference_image.
*/
matchReferenceImageFromReferenceImageName(referenceImageName: 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>;
}
import { FeaturesMethod } from '../helpers';
export interface ImageAnnotatorClient extends FeaturesMethod {
}