CatalogServiceClient

CatalogServiceClient

Service for managing catalog configuration.

Constructor

new CatalogServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of CatalogServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

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.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

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 Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

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 CatalogServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

alertConfigPath(project) → {string}

Return a fully-qualified alertConfig resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

attributesConfigPath(project, location, catalog) → {string}

Return a fully-qualified attributesConfig resource name string.

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

Resource name string.

branchPath(project, location, catalog, branch) → {string}

Return a fully-qualified branch resource name string.

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

Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

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 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 Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
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: ''});
```

catalogPath(project, location, catalog) → {string}

Return a fully-qualified catalog resource name string.

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

Resource name string.

close() → {Promise}

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

A promise that resolves when the client is closed.

completionConfigPath(project, location, catalog) → {string}

Return a fully-qualified completionConfig resource name string.

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

Resource name string.

controlPath(project, location, catalog, control) → {string}

Return a fully-qualified control resource name string.

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

Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
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: ''});
```

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing 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)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listCatalogsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The account resource name with an associated location.

If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
pageSize number

Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT is returned.
pageToken string

A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The account resource name with an associated location.
   *  If the caller does not have permission to list
   *  Catalog google.cloud.retail.v2beta.Catalog s under this location,
   *  regardless of whether or not this location exists, a PERMISSION_DENIED
   *  error is returned.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of Catalog google.cloud.retail.v2beta.Catalog s to return.
   *  If unspecified, defaults to 50. The maximum allowed value is 1000. Values
   *  above 1000 will be coerced to 1000.
   *  If this field is negative, an INVALID_ARGUMENT is returned.
   */
  // const pageSize = 1234
  /**
   *  A page token
   *  ListCatalogsResponse.next_page_token google.cloud.retail.v2beta.ListCatalogsResponse.next_page_token,
   *  received from a previous
   *  CatalogService.ListCatalogs google.cloud.retail.v2beta.CatalogService.ListCatalogs 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  CatalogService.ListCatalogs google.cloud.retail.v2beta.CatalogService.ListCatalogs 
   *  must match the call that provided the page token. Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   */
  // const pageToken = 'abc123'

  // Imports the Retail library
  const {CatalogServiceClient} = require('@google-cloud/retail').v2beta;

  // Instantiates a client
  const retailClient = new CatalogServiceClient();

  async function callListCatalogs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = retailClient.listCatalogsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCatalogs();

listCatalogsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The account resource name with an associated location.

If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
pageSize number

Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT is returned.
pageToken string

A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listOperationsAsync(request, optionsopt) → {Object}

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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

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.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

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

Resource name string.

matchBranchFromBranchName(branchName) → {string}

Parse the branch from Branch resource.

Parameters:
Name Type Description
branchName string

A fully-qualified path representing Branch resource.
Returns:
Type Description
string

A string representing the branch.

matchBranchFromProductName(productName) → {string}

Parse the branch from Product resource.

Parameters:
Name Type Description
productName string

A fully-qualified path representing Product resource.
Returns:
Type Description
string

A string representing the branch.

matchCatalogFromAttributesConfigName(attributesConfigName) → {string}

Parse the catalog from AttributesConfig resource.

Parameters:
Name Type Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromBranchName(branchName) → {string}

Parse the catalog from Branch resource.

Parameters:
Name Type Description
branchName string

A fully-qualified path representing Branch resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromCatalogName(catalogName) → {string}

Parse the catalog from Catalog resource.

Parameters:
Name Type Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromCompletionConfigName(completionConfigName) → {string}

Parse the catalog from CompletionConfig resource.

Parameters:
Name Type Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromControlName(controlName) → {string}

Parse the catalog from Control resource.

Parameters:
Name Type Description
controlName string

A fully-qualified path representing Control resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromModelName(modelName) → {string}

Parse the catalog from Model resource.

Parameters:
Name Type Description
modelName string

A fully-qualified path representing Model resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromProductName(productName) → {string}

Parse the catalog from Product resource.

Parameters:
Name Type Description
productName string

A fully-qualified path representing Product resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromServingConfigName(servingConfigName) → {string}

Parse the catalog from ServingConfig resource.

Parameters:
Name Type Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns:
Type Description
string

A string representing the catalog.

matchControlFromControlName(controlName) → {string}

Parse the control from Control resource.

Parameters:
Name Type Description
controlName string

A fully-qualified path representing Control resource.
Returns:
Type Description
string

A string representing the control.

matchLocationFromAttributesConfigName(attributesConfigName) → {string}

Parse the location from AttributesConfig resource.

Parameters:
Name Type Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromBranchName(branchName) → {string}

Parse the location from Branch resource.

Parameters:
Name Type Description
branchName string

A fully-qualified path representing Branch resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromCatalogName(catalogName) → {string}

Parse the location from Catalog resource.

Parameters:
Name Type Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromCompletionConfigName(completionConfigName) → {string}

Parse the location from CompletionConfig resource.

Parameters:
Name Type Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromControlName(controlName) → {string}

Parse the location from Control resource.

Parameters:
Name Type Description
controlName string

A fully-qualified path representing Control resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromModelName(modelName) → {string}

Parse the location from Model resource.

Parameters:
Name Type Description
modelName string

A fully-qualified path representing Model resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProductName(productName) → {string}

Parse the location from Product resource.

Parameters:
Name Type Description
productName string

A fully-qualified path representing Product resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromServingConfigName(servingConfigName) → {string}

Parse the location from ServingConfig resource.

Parameters:
Name Type Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns:
Type Description
string

A string representing the location.

matchModelFromModelName(modelName) → {string}

Parse the model from Model resource.

Parameters:
Name Type Description
modelName string

A fully-qualified path representing Model resource.
Returns:
Type Description
string

A string representing the model.

matchProductFromProductName(productName) → {string}

Parse the product from Product resource.

Parameters:
Name Type Description
productName string

A fully-qualified path representing Product resource.
Returns:
Type Description
string

A string representing the product.

matchProjectFromAlertConfigName(alertConfigName) → {string}

Parse the project from AlertConfig resource.

Parameters:
Name Type Description
alertConfigName string

A fully-qualified path representing AlertConfig resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromAttributesConfigName(attributesConfigName) → {string}

Parse the project from AttributesConfig resource.

Parameters:
Name Type Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromBranchName(branchName) → {string}

Parse the project from Branch resource.

Parameters:
Name Type Description
branchName string

A fully-qualified path representing Branch resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromCatalogName(catalogName) → {string}

Parse the project from Catalog resource.

Parameters:
Name Type Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromCompletionConfigName(completionConfigName) → {string}

Parse the project from CompletionConfig resource.

Parameters:
Name Type Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromControlName(controlName) → {string}

Parse the project from Control resource.

Parameters:
Name Type Description
controlName string

A fully-qualified path representing Control resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromModelName(modelName) → {string}

Parse the project from Model resource.

Parameters:
Name Type Description
modelName string

A fully-qualified path representing Model resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProductName(productName) → {string}

Parse the project from Product resource.

Parameters:
Name Type Description
productName string

A fully-qualified path representing Product resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromServingConfigName(servingConfigName) → {string}

Parse the project from ServingConfig resource.

Parameters:
Name Type Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns:
Type Description
string

A string representing the project.

matchServingConfigFromServingConfigName(servingConfigName) → {string}

Parse the serving_config from ServingConfig resource.

Parameters:
Name Type Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns:
Type Description
string

A string representing the serving_config.

modelPath(project, location, catalog, model) → {string}

Return a fully-qualified model resource name string.

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

Resource name string.

productPath(project, location, catalog, branch, product) → {string}

Return a fully-qualified product resource name string.

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

Resource name string.

servingConfigPath(project, location, catalog, serving_config) → {string}

Return a fully-qualified servingConfig resource name string.

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

Resource name string.