Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:
- The API has a collection of resources, named
projects/* /locations/* /productSets/*
, which acts as a way to put different products into groups to limit identification.
In parallel,
The API has a collection of resources, named projects/* /locations/* /products/*
Each has a collection of resources, named projects/* /locations/* /products/* /referenceImages/*
v1p4beta1
Package
@google-cloud/vision!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of ProductSearchClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
gax.OperationsClient | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
productSearchStub
productSearchStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
addProductToProductSet(request, options)
addProductToProductSet(request?: protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest | undefined), {} | undefined]> | |
addProductToProductSet(request, options, callback)
addProductToProductSet(request: protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
addProductToProductSet(request, callback)
addProductToProductSet(request: protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IAddProductToProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
checkImportProductSetsProgress(name)
checkImportProductSetsProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1p4beta1.ImportProductSetsResponse, protos.google.cloud.vision.v1p4beta1.BatchOperationMetadata>>;
Check the status of the long running operation returned by importProductSets()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.vision.v1p4beta1.ImportProductSetsResponse, protos.google.cloud.vision.v1p4beta1.BatchOperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkPurgeProductsProgress(name)
checkPurgeProductsProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vision.v1p4beta1.BatchOperationMetadata>>;
Check the status of the long running operation returned by purgeProducts()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vision.v1p4beta1.BatchOperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed.
|
createProduct(request, options)
createProduct(request?: protos.google.cloud.vision.v1p4beta1.ICreateProductRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.ICreateProductRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateProductRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.ICreateProductRequest | undefined, {} | undefined]> | |
createProduct(request, options, callback)
createProduct(request: protos.google.cloud.vision.v1p4beta1.ICreateProductRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.ICreateProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateProductRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.ICreateProductRequest | null | undefined, {} | null | undefined>
|
Returns
createProduct(request, callback)
createProduct(request: protos.google.cloud.vision.v1p4beta1.ICreateProductRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.ICreateProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateProductRequest
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.ICreateProductRequest | null | undefined, {} | null | undefined>
|
Returns
createProductSet(request, options)
createProductSet(request?: protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest | undefined, {} | undefined]> | |
createProductSet(request, options, callback)
createProductSet(request: protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
createProductSet(request, callback)
createProductSet(request: protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.ICreateProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
createReferenceImage(request, options)
createReferenceImage(request?: protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IReferenceImage, (protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IReferenceImage, (protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest | undefined), {} | undefined]> | |
createReferenceImage(request, options, callback)
createReferenceImage(request: protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IReferenceImage, protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IReferenceImage, protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest | null | undefined, {} | null | undefined>
|
Returns
createReferenceImage(request, callback)
createReferenceImage(request: protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IReferenceImage, protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IReferenceImage, protos.google.cloud.vision.v1p4beta1.ICreateReferenceImageRequest | null | undefined, {} | null | undefined>
|
Returns
deleteProduct(request, options)
deleteProduct(request?: protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest | undefined, {} | undefined]> | |
deleteProduct(request, options, callback)
deleteProduct(request: protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest | null | undefined, {} | null | undefined>
|
Returns
deleteProduct(request, callback)
deleteProduct(request: protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductRequest | null | undefined, {} | null | undefined>
|
Returns
deleteProductSet(request, options)
deleteProductSet(request?: protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest | undefined, {} | undefined]> | |
deleteProductSet(request, options, callback)
deleteProductSet(request: protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
deleteProductSet(request, callback)
deleteProductSet(request: protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
deleteReferenceImage(request, options)
deleteReferenceImage(request?: protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest | undefined), {} | undefined]> | |
deleteReferenceImage(request, options, callback)
deleteReferenceImage(request: protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest | null | undefined, {} | null | undefined>
|
Returns
deleteReferenceImage(request, callback)
deleteReferenceImage(request: protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IDeleteReferenceImageRequest | null | undefined, {} | null | undefined>
|
Returns
getProduct(request, options)
getProduct(request?: protos.google.cloud.vision.v1p4beta1.IGetProductRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IGetProductRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetProductRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IGetProductRequest | undefined, {} | undefined]> | |
getProduct(request, options, callback)
getProduct(request: protos.google.cloud.vision.v1p4beta1.IGetProductRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IGetProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetProductRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IGetProductRequest | null | undefined, {} | null | undefined>
|
Returns
getProduct(request, callback)
getProduct(request: protos.google.cloud.vision.v1p4beta1.IGetProductRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IGetProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetProductRequest
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IGetProductRequest | null | undefined, {} | null | undefined>
|
Returns
getProductSet(request, options)
getProductSet(request?: protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest | undefined, {} | undefined]> | |
getProductSet(request, options, callback)
getProductSet(request: protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
getProductSet(request, callback)
getProductSet(request: protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IGetProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
getReferenceImage(request, options)
getReferenceImage(request?: protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IReferenceImage, (protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IReferenceImage, (protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest | undefined), {} | undefined]> | |
getReferenceImage(request, options, callback)
getReferenceImage(request: protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IReferenceImage, protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IReferenceImage, protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest | null | undefined, {} | null | undefined>
|
Returns
getReferenceImage(request, callback)
getReferenceImage(request: protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IReferenceImage, protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IReferenceImage, protos.google.cloud.vision.v1p4beta1.IGetReferenceImageRequest | null | undefined, {} | null | undefined>
|
Returns
importProductSets(request, options)
importProductSets(request?: protos.google.cloud.vision.v1p4beta1.IImportProductSetsRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.vision.v1p4beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IImportProductSetsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.vision.v1p4beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
importProductSets(request, options, callback)
importProductSets(request: protos.google.cloud.vision.v1p4beta1.IImportProductSetsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1p4beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IImportProductSetsRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.vision.v1p4beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
importProductSets(request, callback)
importProductSets(request: protos.google.cloud.vision.v1p4beta1.IImportProductSetsRequest, callback: Callback<LROperation<protos.google.cloud.vision.v1p4beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IImportProductSetsRequest
|
callback |
Callback<LROperation<protos.google.cloud.vision.v1p4beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listProducts(request, options)
listProducts(request?: protos.google.cloud.vision.v1p4beta1.IListProductsRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProduct[], protos.google.cloud.vision.v1p4beta1.IListProductsRequest | null, protos.google.cloud.vision.v1p4beta1.IListProductsResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProduct[], protos.google.cloud.vision.v1p4beta1.IListProductsRequest | null, protos.google.cloud.vision.v1p4beta1.IListProductsResponse]> | |
listProducts(request, options, callback)
listProducts(request: protos.google.cloud.vision.v1p4beta1.IListProductsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductsRequest, protos.google.cloud.vision.v1p4beta1.IListProductsResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProduct>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductsRequest, protos.google.cloud.vision.v1p4beta1.IListProductsResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProduct>
|
Returns
listProducts(request, callback)
listProducts(request: protos.google.cloud.vision.v1p4beta1.IListProductsRequest, callback: PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductsRequest, protos.google.cloud.vision.v1p4beta1.IListProductsResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProduct>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsRequest
|
callback |
PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductsRequest, protos.google.cloud.vision.v1p4beta1.IListProductsResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProduct>
|
Returns
listProductsAsync(request, options)
listProductsAsync(request?: protos.google.cloud.vision.v1p4beta1.IListProductsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vision.v1p4beta1.IProduct>;
Equivalent to listProducts
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.vision.v1p4beta1.IProduct> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Product]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProductSets(request, options)
listProductSets(request?: protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProductSet[], protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest | null, protos.google.cloud.vision.v1p4beta1.IListProductSetsResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProductSet[], protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest | null, protos.google.cloud.vision.v1p4beta1.IListProductSetsResponse]> | |
listProductSets(request, options, callback)
listProductSets(request: protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, protos.google.cloud.vision.v1p4beta1.IListProductSetsResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProductSet>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, protos.google.cloud.vision.v1p4beta1.IListProductSetsResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProductSet>
|
Returns
listProductSets(request, callback)
listProductSets(request: protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, callback: PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, protos.google.cloud.vision.v1p4beta1.IListProductSetsResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProductSet>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest
|
callback |
PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, protos.google.cloud.vision.v1p4beta1.IListProductSetsResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProductSet>
|
Returns
listProductSetsAsync(request, options)
listProductSetsAsync(request?: protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vision.v1p4beta1.IProductSet>;
Equivalent to listProductSets
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.vision.v1p4beta1.IProductSet> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ProductSet]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProductSetsStream(request, options)
listProductSetsStream(request?: protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductSetsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [ProductSet] 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 listProductSetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProductsInProductSet(request, options)
listProductsInProductSet(request?: protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProduct[], protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest | null, protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProduct[], protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest | null, protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetResponse]> | |
listProductsInProductSet(request, options, callback)
listProductsInProductSet(request: protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProduct>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProduct>
|
Returns
listProductsInProductSet(request, callback)
listProductsInProductSet(request: protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, callback: PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProduct>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest
|
callback |
PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IProduct>
|
Returns
listProductsInProductSetAsync(request, options)
listProductsInProductSetAsync(request?: protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vision.v1p4beta1.IProduct>;
Equivalent to listProductsInProductSet
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.vision.v1p4beta1.IProduct> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Product]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProductsInProductSetStream(request, options)
listProductsInProductSetStream(request?: protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsInProductSetRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Product] 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 listProductsInProductSetAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProductsStream(request, options)
listProductsStream(request?: protos.google.cloud.vision.v1p4beta1.IListProductsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListProductsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Product] 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 listProductsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listReferenceImages(request, options)
listReferenceImages(request?: protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IReferenceImage[], protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest | null, protos.google.cloud.vision.v1p4beta1.IListReferenceImagesResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IReferenceImage[], protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest | null, protos.google.cloud.vision.v1p4beta1.IListReferenceImagesResponse]> | |
listReferenceImages(request, options, callback)
listReferenceImages(request: protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, protos.google.cloud.vision.v1p4beta1.IListReferenceImagesResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IReferenceImage>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, protos.google.cloud.vision.v1p4beta1.IListReferenceImagesResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IReferenceImage>
|
Returns
listReferenceImages(request, callback)
listReferenceImages(request: protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, callback: PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, protos.google.cloud.vision.v1p4beta1.IListReferenceImagesResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IReferenceImage>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest
|
callback |
PaginationCallback<protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, protos.google.cloud.vision.v1p4beta1.IListReferenceImagesResponse | null | undefined, protos.google.cloud.vision.v1p4beta1.IReferenceImage>
|
Returns
listReferenceImagesAsync(request, options)
listReferenceImagesAsync(request?: protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vision.v1p4beta1.IReferenceImage>;
Equivalent to listReferenceImages
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.vision.v1p4beta1.IReferenceImage> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ReferenceImage]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listReferenceImagesStream(request, options)
listReferenceImagesStream(request?: protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IListReferenceImagesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [ReferenceImage] 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 listReferenceImagesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromProductName(productName)
matchLocationFromProductName(productName: string): string | number;
Parse the location from Product resource.
Parameter
Name | Description |
productName |
string
A fully-qualified path representing Product resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromProductSetName(productSetName)
matchLocationFromProductSetName(productSetName: string): string | number;
Parse the location from ProductSet resource.
Parameter
Name | Description |
productSetName |
string
A fully-qualified path representing ProductSet resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromReferenceImageName(referenceImageName)
matchLocationFromReferenceImageName(referenceImageName: string): string | number;
Parse the location from ReferenceImage resource.
Parameter
Name | Description |
referenceImageName |
string
A fully-qualified path representing ReferenceImage resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchProductFromProductName(productName)
matchProductFromProductName(productName: string): string | number;
Parse the product from Product resource.
Parameter
Name | Description |
productName |
string
A fully-qualified path representing Product resource.
|
Returns
Type | Description |
string | number | {string} A string representing the product.
|
matchProductFromReferenceImageName(referenceImageName)
matchProductFromReferenceImageName(referenceImageName: string): string | number;
Parse the product from ReferenceImage resource.
Parameter
Name | Description |
referenceImageName |
string
A fully-qualified path representing ReferenceImage resource.
|
Returns
Type | Description |
string | number | {string} A string representing the product.
|
matchProductSetFromProductSetName(productSetName)
matchProductSetFromProductSetName(productSetName: string): string | number;
Parse the product_set from ProductSet resource.
Parameter
Name | Description |
productSetName |
string
A fully-qualified path representing ProductSet resource.
|
Returns
Type | Description |
string | number | {string} A string representing the product_set.
|
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProductName(productName)
matchProjectFromProductName(productName: string): string | number;
Parse the project from Product resource.
Parameter
Name | Description |
productName |
string
A fully-qualified path representing Product resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProductSetName(productSetName)
matchProjectFromProductSetName(productSetName: string): string | number;
Parse the project from ProductSet resource.
Parameter
Name | Description |
productSetName |
string
A fully-qualified path representing ProductSet resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromReferenceImageName(referenceImageName)
matchProjectFromReferenceImageName(referenceImageName: string): string | number;
Parse the project from ReferenceImage resource.
Parameter
Name | Description |
referenceImageName |
string
A fully-qualified path representing ReferenceImage resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchReferenceImageFromReferenceImageName(referenceImageName)
matchReferenceImageFromReferenceImageName(referenceImageName: string): string | number;
Parse the reference_image from ReferenceImage resource.
Parameter
Name | Description |
referenceImageName |
string
A fully-qualified path representing ReferenceImage resource.
|
Returns
Type | Description |
string | number | {string} A string representing the reference_image.
|
productPath(project, location, product)
productPath(project: string, location: string, product: string): string;
Return a fully-qualified product resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
product |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
productSetPath(project, location, productSet)
productSetPath(project: string, location: string, productSet: string): string;
Return a fully-qualified productSet resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
productSet |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
purgeProducts(request, options)
purgeProducts(request?: protos.google.cloud.vision.v1p4beta1.IPurgeProductsRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IPurgeProductsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
purgeProducts(request, options, callback)
purgeProducts(request: protos.google.cloud.vision.v1p4beta1.IPurgeProductsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IPurgeProductsRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
purgeProducts(request, callback)
purgeProducts(request: protos.google.cloud.vision.v1p4beta1.IPurgeProductsRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IPurgeProductsRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
referenceImagePath(project, location, product, referenceImage)
referenceImagePath(project: string, location: string, product: string, referenceImage: string): string;
Return a fully-qualified referenceImage resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
product |
string
|
referenceImage |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
removeProductFromProductSet(request, options)
removeProductFromProductSet(request?: protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest | undefined), {} | undefined]> | |
removeProductFromProductSet(request, options, callback)
removeProductFromProductSet(request: protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
removeProductFromProductSet(request, callback)
removeProductFromProductSet(request: protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p4beta1.IRemoveProductFromProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
updateProduct(request, options)
updateProduct(request?: protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest | undefined, {} | undefined]> | |
updateProduct(request, options, callback)
updateProduct(request: protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest | null | undefined, {} | null | undefined>
|
Returns
updateProduct(request, callback)
updateProduct(request: protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProduct, protos.google.cloud.vision.v1p4beta1.IUpdateProductRequest | null | undefined, {} | null | undefined>
|
Returns
updateProductSet(request, options)
updateProductSet(request?: protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest | undefined, {} | undefined]> | |
updateProductSet(request, options, callback)
updateProductSet(request: protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest | null | undefined, {} | null | undefined>
|
Returns
updateProductSet(request, callback)
updateProductSet(request: protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest
|
callback |
Callback<protos.google.cloud.vision.v1p4beta1.IProductSet, protos.google.cloud.vision.v1p4beta1.IUpdateProductSetRequest | null | undefined, {} | null | undefined>
|
Returns