Class v2.CatalogServiceClient (1.2.2)

Service for managing catalog configuration. v2

Package

@google-cloud/retail!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CatalogServiceClient.

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
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

catalogServiceStub

catalogServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

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
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

branchPath(project, location, catalog, branch)

branchPath(project: string, location: string, catalog: string, branch: string): string;

Return a fully-qualified branch resource name string.

Parameters
Name Description
project string
location string
catalog string
branch string
Returns
Type Description
string

{string} Resource name string.

catalogPath(project, location, catalog)

catalogPath(project: string, location: string, catalog: string): string;

Return a fully-qualified catalog resource name string.

Parameters
Name Description
project string
location string
catalog string
Returns
Type Description
string

{string} Resource name string.

close()

close(): Promise<void>;

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.

getDefaultBranch(request, options)

getDefaultBranch(request?: protos.google.cloud.retail.v2.IGetDefaultBranchRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.IGetDefaultBranchResponse,
        protos.google.cloud.retail.v2.IGetDefaultBranchRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2.IGetDefaultBranchRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2.IGetDefaultBranchResponse, protos.google.cloud.retail.v2.IGetDefaultBranchRequest | undefined, {} | undefined ]>

getDefaultBranch(request, options, callback)

getDefaultBranch(request: protos.google.cloud.retail.v2.IGetDefaultBranchRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.IGetDefaultBranchResponse, protos.google.cloud.retail.v2.IGetDefaultBranchRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2.IGetDefaultBranchRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2.IGetDefaultBranchResponse, protos.google.cloud.retail.v2.IGetDefaultBranchRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDefaultBranch(request, callback)

getDefaultBranch(request: protos.google.cloud.retail.v2.IGetDefaultBranchRequest, callback: Callback<protos.google.cloud.retail.v2.IGetDefaultBranchResponse, protos.google.cloud.retail.v2.IGetDefaultBranchRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2.IGetDefaultBranchRequest
callback Callback<protos.google.cloud.retail.v2.IGetDefaultBranchResponse, protos.google.cloud.retail.v2.IGetDefaultBranchRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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
Type Description
void

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.

listCatalogs(request, options)

listCatalogs(request?: protos.google.cloud.retail.v2.IListCatalogsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.ICatalog[],
        protos.google.cloud.retail.v2.IListCatalogsRequest | null,
        protos.google.cloud.retail.v2.IListCatalogsResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2.IListCatalogsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2.ICatalog[], protos.google.cloud.retail.v2.IListCatalogsRequest | null, protos.google.cloud.retail.v2.IListCatalogsResponse ]>

listCatalogs(request, options, callback)

listCatalogs(request: protos.google.cloud.retail.v2.IListCatalogsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.retail.v2.IListCatalogsRequest, protos.google.cloud.retail.v2.IListCatalogsResponse | null | undefined, protos.google.cloud.retail.v2.ICatalog>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2.IListCatalogsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.retail.v2.IListCatalogsRequest, protos.google.cloud.retail.v2.IListCatalogsResponse | null | undefined, protos.google.cloud.retail.v2.ICatalog>
Returns
Type Description
void

listCatalogs(request, callback)

listCatalogs(request: protos.google.cloud.retail.v2.IListCatalogsRequest, callback: PaginationCallback<protos.google.cloud.retail.v2.IListCatalogsRequest, protos.google.cloud.retail.v2.IListCatalogsResponse | null | undefined, protos.google.cloud.retail.v2.ICatalog>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2.IListCatalogsRequest
callback PaginationCallback<protos.google.cloud.retail.v2.IListCatalogsRequest, protos.google.cloud.retail.v2.IListCatalogsResponse | null | undefined, protos.google.cloud.retail.v2.ICatalog>
Returns
Type Description
void

listCatalogsAsync(request, options)

listCatalogsAsync(request?: protos.google.cloud.retail.v2.IListCatalogsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.retail.v2.ICatalog>;

Equivalent to listCatalogs, 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.retail.v2.IListCatalogsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.retail.v2.ICatalog>

{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 [Catalog]. 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.

listCatalogsStream(request, options)

listCatalogsStream(request?: protos.google.cloud.retail.v2.IListCatalogsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.retail.v2.IListCatalogsRequest

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 [Catalog] 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 listCatalogsAsync() 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.

matchBranchFromBranchName(branchName)

matchBranchFromBranchName(branchName: string): string | number;

Parse the branch from Branch resource.

Parameter
Name Description
branchName string

A fully-qualified path representing Branch resource.

Returns
Type Description
string | number

{string} A string representing the branch.

matchBranchFromProductName(productName)

matchBranchFromProductName(productName: string): string | number;

Parse the branch 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 branch.

matchCatalogFromBranchName(branchName)

matchCatalogFromBranchName(branchName: string): string | number;

Parse the catalog from Branch resource.

Parameter
Name Description
branchName string

A fully-qualified path representing Branch resource.

Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName: string): string | number;

Parse the catalog from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.

Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName: string): string | number;

Parse the catalog 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 catalog.

matchLocationFromBranchName(branchName)

matchLocationFromBranchName(branchName: string): string | number;

Parse the location from Branch resource.

Parameter
Name Description
branchName string

A fully-qualified path representing Branch resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName: string): string | number;

Parse the location from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.

Returns
Type Description
string | number

{string} A string representing the location.

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.

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.

matchProjectFromBranchName(branchName)

matchProjectFromBranchName(branchName: string): string | number;

Parse the project from Branch resource.

Parameter
Name Description
branchName string

A fully-qualified path representing Branch resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName: string): string | number;

Parse the project from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.

Returns
Type Description
string | number

{string} A string representing the project.

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.

productPath(project, location, catalog, branch, product)

productPath(project: string, location: string, catalog: string, branch: string, product: string): string;

Return a fully-qualified product resource name string.

Parameters
Name Description
project string
location string
catalog string
branch string
product string
Returns
Type Description
string

{string} Resource name string.

setDefaultBranch(request, options)

setDefaultBranch(request?: protos.google.cloud.retail.v2.ISetDefaultBranchRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.retail.v2.ISetDefaultBranchRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2.ISetDefaultBranchRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2.ISetDefaultBranchRequest | undefined, {} | undefined ]>

setDefaultBranch(request, options, callback)

setDefaultBranch(request: protos.google.cloud.retail.v2.ISetDefaultBranchRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2.ISetDefaultBranchRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2.ISetDefaultBranchRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2.ISetDefaultBranchRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

setDefaultBranch(request, callback)

setDefaultBranch(request: protos.google.cloud.retail.v2.ISetDefaultBranchRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2.ISetDefaultBranchRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2.ISetDefaultBranchRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2.ISetDefaultBranchRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCatalog(request, options)

updateCatalog(request?: protos.google.cloud.retail.v2.IUpdateCatalogRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.ICatalog,
        protos.google.cloud.retail.v2.IUpdateCatalogRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2.IUpdateCatalogRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2.ICatalog, protos.google.cloud.retail.v2.IUpdateCatalogRequest | undefined, {} | undefined ]>

updateCatalog(request, options, callback)

updateCatalog(request: protos.google.cloud.retail.v2.IUpdateCatalogRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.ICatalog, protos.google.cloud.retail.v2.IUpdateCatalogRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2.IUpdateCatalogRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2.ICatalog, protos.google.cloud.retail.v2.IUpdateCatalogRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCatalog(request, callback)

updateCatalog(request: protos.google.cloud.retail.v2.IUpdateCatalogRequest, callback: Callback<protos.google.cloud.retail.v2.ICatalog, protos.google.cloud.retail.v2.IUpdateCatalogRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2.IUpdateCatalogRequest
callback Callback<protos.google.cloud.retail.v2.ICatalog, protos.google.cloud.retail.v2.IUpdateCatalogRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void