Class v2beta.ServingConfigServiceClient (1.8.0)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

servingConfigServiceStub

servingConfigServiceStub?: Promise<{
        [name: string]: Function;
    }>;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

addControl(request, options)

addControl(request?: protos.google.cloud.retail.v2beta.IAddControlRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2beta.IServingConfig,
        protos.google.cloud.retail.v2beta.IAddControlRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The source ServingConfig resource name . Format:
   *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
   */
  // const servingConfig = 'abc123'
  /**
   *  Required. The id of the control to apply. Assumed to be in the same catalog
   *  as the serving config - if id is not found a NOT_FOUND error is returned.
   */
  // const controlId = 'abc123'

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

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

  async function callAddControl() {
    // Construct request
    const request = {
      servingConfig,
      controlId,
    };

    // Run request
    const response = await retailClient.addControl(request);
    console.log(response);
  }

  callAddControl();

addControl(request, options, callback)

addControl(request: protos.google.cloud.retail.v2beta.IAddControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.IAddControlRequest | null | undefined, {} | null | undefined>): void;

addControl(request, callback)

addControl(request: protos.google.cloud.retail.v2beta.IAddControlRequest, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.IAddControlRequest | null | undefined, {} | null | undefined>): void;

attributesConfigPath(project, location, catalog)

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

catalogPath(project, location, catalog)

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

close()

close(): Promise<void>;

completionConfigPath(project, location, catalog)

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

controlPath(project, location, catalog, control)

controlPath(project: string, location: string, catalog: string, control: string): string;

createServingConfig(request, options)

createServingConfig(request?: protos.google.cloud.retail.v2beta.ICreateServingConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2beta.IServingConfig,
        protos.google.cloud.retail.v2beta.ICreateServingConfigRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of parent. Format:
   *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
   */
  // const parent = 'abc123'
  /**
   *  Required. The ServingConfig to create.
   */
  // const servingConfig = {}
  /**
   *  Required. The ID to use for the ServingConfig, which will become the final
   *  component of the ServingConfig's resource name.
   *  This value should be 4-63 characters, and valid characters
   *  are /[a-z][0-9]-_/.
   */
  // const servingConfigId = 'abc123'

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

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

  async function callCreateServingConfig() {
    // Construct request
    const request = {
      parent,
      servingConfig,
      servingConfigId,
    };

    // Run request
    const response = await retailClient.createServingConfig(request);
    console.log(response);
  }

  callCreateServingConfig();

createServingConfig(request, options, callback)

createServingConfig(request: protos.google.cloud.retail.v2beta.ICreateServingConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.ICreateServingConfigRequest | null | undefined, {} | null | undefined>): void;

createServingConfig(request, callback)

createServingConfig(request: protos.google.cloud.retail.v2beta.ICreateServingConfigRequest, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.ICreateServingConfigRequest | null | undefined, {} | null | undefined>): void;

deleteServingConfig(request, options)

deleteServingConfig(request?: protos.google.cloud.retail.v2beta.IDeleteServingConfigRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.retail.v2beta.IDeleteServingConfigRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the ServingConfig to delete. Format:
   *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
   */
  // const name = 'abc123'

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

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

  async function callDeleteServingConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await retailClient.deleteServingConfig(request);
    console.log(response);
  }

  callDeleteServingConfig();

deleteServingConfig(request, options, callback)

deleteServingConfig(request: protos.google.cloud.retail.v2beta.IDeleteServingConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2beta.IDeleteServingConfigRequest | null | undefined, {} | null | undefined>): void;

deleteServingConfig(request, callback)

deleteServingConfig(request: protos.google.cloud.retail.v2beta.IDeleteServingConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2beta.IDeleteServingConfigRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

getServingConfig(request, options)

getServingConfig(request?: protos.google.cloud.retail.v2beta.IGetServingConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2beta.IServingConfig,
        protos.google.cloud.retail.v2beta.IGetServingConfigRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the ServingConfig to get. Format:
   *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
   */
  // const name = 'abc123'

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

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

  async function callGetServingConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await retailClient.getServingConfig(request);
    console.log(response);
  }

  callGetServingConfig();

getServingConfig(request, options, callback)

getServingConfig(request: protos.google.cloud.retail.v2beta.IGetServingConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.IGetServingConfigRequest | null | undefined, {} | null | undefined>): void;

getServingConfig(request, callback)

getServingConfig(request: protos.google.cloud.retail.v2beta.IGetServingConfigRequest, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.IGetServingConfigRequest | null | undefined, {} | null | undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

listServingConfigs(request, options)

listServingConfigs(request?: protos.google.cloud.retail.v2beta.IListServingConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2beta.IServingConfig[],
        protos.google.cloud.retail.v2beta.IListServingConfigsRequest | null,
        protos.google.cloud.retail.v2beta.IListServingConfigsResponse
    ]>;

listServingConfigs(request, options, callback)

listServingConfigs(request: protos.google.cloud.retail.v2beta.IListServingConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.retail.v2beta.IListServingConfigsRequest, protos.google.cloud.retail.v2beta.IListServingConfigsResponse | null | undefined, protos.google.cloud.retail.v2beta.IServingConfig>): void;

listServingConfigs(request, callback)

listServingConfigs(request: protos.google.cloud.retail.v2beta.IListServingConfigsRequest, callback: PaginationCallback<protos.google.cloud.retail.v2beta.IListServingConfigsRequest, protos.google.cloud.retail.v2beta.IListServingConfigsResponse | null | undefined, protos.google.cloud.retail.v2beta.IServingConfig>): void;

listServingConfigsAsync(request, options)

listServingConfigsAsync(request?: protos.google.cloud.retail.v2beta.IListServingConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.retail.v2beta.IServingConfig>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The catalog resource name. Format:
   *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of results to return. If unspecified, defaults
   *  to 100. If a value greater than 100 is provided, at most 100 results are
   *  returned.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListServingConfigs` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListServingConfigs();

listServingConfigsStream(request, options)

listServingConfigsStream(request?: protos.google.cloud.retail.v2beta.IListServingConfigsRequest, options?: CallOptions): Transform;

matchBranchFromProductName(productName)

matchBranchFromProductName(productName: string): string | number;

matchCatalogFromAttributesConfigName(attributesConfigName)

matchCatalogFromAttributesConfigName(attributesConfigName: string): string | number;

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName: string): string | number;

matchCatalogFromCompletionConfigName(completionConfigName)

matchCatalogFromCompletionConfigName(completionConfigName: string): string | number;

matchCatalogFromControlName(controlName)

matchCatalogFromControlName(controlName: string): string | number;

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName: string): string | number;

matchCatalogFromServingConfigName(servingConfigName)

matchCatalogFromServingConfigName(servingConfigName: string): string | number;

matchControlFromControlName(controlName)

matchControlFromControlName(controlName: string): string | number;

matchLocationFromAttributesConfigName(attributesConfigName)

matchLocationFromAttributesConfigName(attributesConfigName: string): string | number;

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName: string): string | number;

matchLocationFromCompletionConfigName(completionConfigName)

matchLocationFromCompletionConfigName(completionConfigName: string): string | number;

matchLocationFromControlName(controlName)

matchLocationFromControlName(controlName: string): string | number;

matchLocationFromProductName(productName)

matchLocationFromProductName(productName: string): string | number;

matchLocationFromServingConfigName(servingConfigName)

matchLocationFromServingConfigName(servingConfigName: string): string | number;

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

matchProjectFromAttributesConfigName(attributesConfigName)

matchProjectFromAttributesConfigName(attributesConfigName: string): string | number;

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName: string): string | number;

matchProjectFromCompletionConfigName(completionConfigName)

matchProjectFromCompletionConfigName(completionConfigName: string): string | number;

matchProjectFromControlName(controlName)

matchProjectFromControlName(controlName: string): string | number;

matchProjectFromProductName(productName)

matchProjectFromProductName(productName: string): string | number;

matchProjectFromServingConfigName(servingConfigName)

matchProjectFromServingConfigName(servingConfigName: string): string | number;

matchServingConfigFromServingConfigName(servingConfigName)

matchServingConfigFromServingConfigName(servingConfigName: string): string | number;

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

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

removeControl(request, options)

removeControl(request?: protos.google.cloud.retail.v2beta.IRemoveControlRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2beta.IServingConfig,
        protos.google.cloud.retail.v2beta.IRemoveControlRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The source ServingConfig resource name . Format:
   *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
   */
  // const servingConfig = 'abc123'
  /**
   *  Required. The id of the control to apply. Assumed to be in the same catalog
   *  as the serving config.
   */
  // const controlId = 'abc123'

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

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

  async function callRemoveControl() {
    // Construct request
    const request = {
      servingConfig,
      controlId,
    };

    // Run request
    const response = await retailClient.removeControl(request);
    console.log(response);
  }

  callRemoveControl();

removeControl(request, options, callback)

removeControl(request: protos.google.cloud.retail.v2beta.IRemoveControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.IRemoveControlRequest | null | undefined, {} | null | undefined>): void;

removeControl(request, callback)

removeControl(request: protos.google.cloud.retail.v2beta.IRemoveControlRequest, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.IRemoveControlRequest | null | undefined, {} | null | undefined>): void;

servingConfigPath(project, location, catalog, servingConfig)

servingConfigPath(project: string, location: string, catalog: string, servingConfig: string): string;

updateServingConfig(request, options)

updateServingConfig(request?: protos.google.cloud.retail.v2beta.IUpdateServingConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2beta.IServingConfig,
        protos.google.cloud.retail.v2beta.IUpdateServingConfigRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ServingConfig to update.
   */
  // const servingConfig = {}
  /**
   *  Indicates which fields in the provided
   *  ServingConfig google.cloud.retail.v2beta.ServingConfig  to update. The
   *  following are NOT supported:
   *  * ServingConfig.name google.cloud.retail.v2beta.ServingConfig.name 
   *  If not set, all supported fields are updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateServingConfig() {
    // Construct request
    const request = {
      servingConfig,
    };

    // Run request
    const response = await retailClient.updateServingConfig(request);
    console.log(response);
  }

  callUpdateServingConfig();

updateServingConfig(request, options, callback)

updateServingConfig(request: protos.google.cloud.retail.v2beta.IUpdateServingConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.IUpdateServingConfigRequest | null | undefined, {} | null | undefined>): void;

updateServingConfig(request, callback)

updateServingConfig(request: protos.google.cloud.retail.v2beta.IUpdateServingConfigRequest, callback: Callback<protos.google.cloud.retail.v2beta.IServingConfig, protos.google.cloud.retail.v2beta.IUpdateServingConfigRequest | null | undefined, {} | null | undefined>): void;