Class v2beta.ControlServiceClient

Service for modifying Control. v2beta

Package

@google-cloud/retail

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ControlServiceClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

controlServiceStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

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

Methods

attributesConfigPath(project, location, catalog)

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

Return a fully-qualified attributesConfig resource name string.

Parameters
NameDescription
project string
location string
catalog string
Returns
TypeDescription
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
NameDescription
project string
location string
catalog string
Returns
TypeDescription
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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

completionConfigPath(project, location, catalog)

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

Return a fully-qualified completionConfig resource name string.

Parameters
NameDescription
project string
location string
catalog string
Returns
TypeDescription
string

{string} Resource name string.

controlPath(project, location, catalog, control)

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

Return a fully-qualified control resource name string.

Parameters
NameDescription
project string
location string
catalog string
control string
Returns
TypeDescription
string

{string} Resource name string.

createControl(request, options)

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

Creates a Control.

If the to create already exists, an ALREADY_EXISTS error is returned.

Parameters
NameDescription
request protos.google.cloud.retail.v2beta.ICreateControlRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.ICreateControlRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Control]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

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

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

  async function callCreateControl() {
    // Construct request
    const request = {
      parent,
      control,
      controlId,
    };

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

  callCreateControl();

createControl(request, options, callback)

createControl(request: protos.google.cloud.retail.v2beta.ICreateControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.ICreateControlRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.ICreateControlRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.ICreateControlRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createControl(request, callback)

createControl(request: protos.google.cloud.retail.v2beta.ICreateControlRequest, callback: Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.ICreateControlRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.ICreateControlRequest
callback Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.ICreateControlRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteControl(request, options)

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

Deletes a Control.

If the to delete does not exist, a NOT_FOUND error is returned.

Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IDeleteControlRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2beta.IDeleteControlRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

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

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

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

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

  callDeleteControl();

deleteControl(request, options, callback)

deleteControl(request: protos.google.cloud.retail.v2beta.IDeleteControlRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2beta.IDeleteControlRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IDeleteControlRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2beta.IDeleteControlRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteControl(request, callback)

deleteControl(request: protos.google.cloud.retail.v2beta.IDeleteControlRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2beta.IDeleteControlRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IDeleteControlRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2beta.IDeleteControlRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getControl(request, options)

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

Gets a Control.

Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IGetControlRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IGetControlRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Control]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

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

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

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

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

  callGetControl();

getControl(request, options, callback)

getControl(request: protos.google.cloud.retail.v2beta.IGetControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IGetControlRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IGetControlRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IGetControlRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getControl(request, callback)

getControl(request: protos.google.cloud.retail.v2beta.IGetControlRequest, callback: Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IGetControlRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IGetControlRequest
callback Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IGetControlRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listControls(request, options)

listControls(request?: protos.google.cloud.retail.v2beta.IListControlsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2beta.IControl[],
        protos.google.cloud.retail.v2beta.IListControlsRequest | null,
        protos.google.cloud.retail.v2beta.IListControlsResponse
    ]>;

Lists all Controls linked to this catalog.

Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IListControlsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.retail.v2beta.IControl[], protos.google.cloud.retail.v2beta.IListControlsRequest | null, protos.google.cloud.retail.v2beta.IListControlsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Control]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listControlsAsync() 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.

listControls(request, options, callback)

listControls(request: protos.google.cloud.retail.v2beta.IListControlsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.retail.v2beta.IListControlsRequest, protos.google.cloud.retail.v2beta.IListControlsResponse | null | undefined, protos.google.cloud.retail.v2beta.IControl>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IListControlsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.retail.v2beta.IListControlsRequest, protos.google.cloud.retail.v2beta.IListControlsResponse | null | undefined, protos.google.cloud.retail.v2beta.IControl>
Returns
TypeDescription
void

listControls(request, callback)

listControls(request: protos.google.cloud.retail.v2beta.IListControlsRequest, callback: PaginationCallback<protos.google.cloud.retail.v2beta.IListControlsRequest, protos.google.cloud.retail.v2beta.IListControlsResponse | null | undefined, protos.google.cloud.retail.v2beta.IControl>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IListControlsRequest
callback PaginationCallback<protos.google.cloud.retail.v2beta.IListControlsRequest, protos.google.cloud.retail.v2beta.IListControlsResponse | null | undefined, protos.google.cloud.retail.v2beta.IControl>
Returns
TypeDescription
void

listControlsAsync(request, options)

listControlsAsync(request?: protos.google.cloud.retail.v2beta.IListControlsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.retail.v2beta.IControl>;

Equivalent to listControls, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IListControlsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.retail.v2beta.IControl>

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

Example

  /**
   * 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 50. Max allowed value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListControls` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter to apply on the list results. Supported features:
   *  * List all the products under the parent branch if
   *  filter google.cloud.retail.v2beta.ListControlsRequest.filter  is unset.
   *  * List controls that are used in a single ServingConfig:
   *      'serving_config = "boosted_home_page_cvr"'
   */
  // const filter = 'abc123'

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

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

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

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

  callListControls();

listControlsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IListControlsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Control] 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 listControlsAsync() 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.

matchBranchFromProductName(productName)

matchBranchFromProductName(productName: string): string | number;

Parse the branch from Product resource.

Parameter
NameDescription
productName string

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the branch.

matchCatalogFromAttributesConfigName(attributesConfigName)

matchCatalogFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the catalog from AttributesConfig resource.

Parameter
NameDescription
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName: string): string | number;

Parse the catalog from Catalog resource.

Parameter
NameDescription
catalogName string

A fully-qualified path representing Catalog resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromCompletionConfigName(completionConfigName)

matchCatalogFromCompletionConfigName(completionConfigName: string): string | number;

Parse the catalog from CompletionConfig resource.

Parameter
NameDescription
completionConfigName string

A fully-qualified path representing CompletionConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromControlName(controlName)

matchCatalogFromControlName(controlName: string): string | number;

Parse the catalog from Control resource.

Parameter
NameDescription
controlName string

A fully-qualified path representing Control resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName: string): string | number;

Parse the catalog from Product resource.

Parameter
NameDescription
productName string

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromServingConfigName(servingConfigName)

matchCatalogFromServingConfigName(servingConfigName: string): string | number;

Parse the catalog from ServingConfig resource.

Parameter
NameDescription
servingConfigName string

A fully-qualified path representing ServingConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchControlFromControlName(controlName)

matchControlFromControlName(controlName: string): string | number;

Parse the control from Control resource.

Parameter
NameDescription
controlName string

A fully-qualified path representing Control resource.

Returns
TypeDescription
string | number

{string} A string representing the control.

matchLocationFromAttributesConfigName(attributesConfigName)

matchLocationFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the location from AttributesConfig resource.

Parameter
NameDescription
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName: string): string | number;

Parse the location from Catalog resource.

Parameter
NameDescription
catalogName string

A fully-qualified path representing Catalog resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCompletionConfigName(completionConfigName)

matchLocationFromCompletionConfigName(completionConfigName: string): string | number;

Parse the location from CompletionConfig resource.

Parameter
NameDescription
completionConfigName string

A fully-qualified path representing CompletionConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromControlName(controlName)

matchLocationFromControlName(controlName: string): string | number;

Parse the location from Control resource.

Parameter
NameDescription
controlName string

A fully-qualified path representing Control resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProductName(productName)

matchLocationFromProductName(productName: string): string | number;

Parse the location from Product resource.

Parameter
NameDescription
productName string

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromServingConfigName(servingConfigName)

matchLocationFromServingConfigName(servingConfigName: string): string | number;

Parse the location from ServingConfig resource.

Parameter
NameDescription
servingConfigName string

A fully-qualified path representing ServingConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

Parse the product from Product resource.

Parameter
NameDescription
productName string

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the product.

matchProjectFromAttributesConfigName(attributesConfigName)

matchProjectFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the project from AttributesConfig resource.

Parameter
NameDescription
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName: string): string | number;

Parse the project from Catalog resource.

Parameter
NameDescription
catalogName string

A fully-qualified path representing Catalog resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCompletionConfigName(completionConfigName)

matchProjectFromCompletionConfigName(completionConfigName: string): string | number;

Parse the project from CompletionConfig resource.

Parameter
NameDescription
completionConfigName string

A fully-qualified path representing CompletionConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromControlName(controlName)

matchProjectFromControlName(controlName: string): string | number;

Parse the project from Control resource.

Parameter
NameDescription
controlName string

A fully-qualified path representing Control resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProductName(productName)

matchProjectFromProductName(productName: string): string | number;

Parse the project from Product resource.

Parameter
NameDescription
productName string

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromServingConfigName(servingConfigName)

matchProjectFromServingConfigName(servingConfigName: string): string | number;

Parse the project from ServingConfig resource.

Parameter
NameDescription
servingConfigName string

A fully-qualified path representing ServingConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchServingConfigFromServingConfigName(servingConfigName)

matchServingConfigFromServingConfigName(servingConfigName: string): string | number;

Parse the serving_config from ServingConfig resource.

Parameter
NameDescription
servingConfigName string

A fully-qualified path representing ServingConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the serving_config.

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
NameDescription
project string
location string
catalog string
branch string
product string
Returns
TypeDescription
string

{string} Resource name string.

servingConfigPath(project, location, catalog, servingConfig)

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

Return a fully-qualified servingConfig resource name string.

Parameters
NameDescription
project string
location string
catalog string
servingConfig string
Returns
TypeDescription
string

{string} Resource name string.

updateControl(request, options)

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

Updates a Control.

cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the to delete does not exist, a NOT_FOUND error is returned.

Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IUpdateControlRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IUpdateControlRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Control]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

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

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

  async function callUpdateControl() {
    // Construct request
    const request = {
      control,
    };

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

  callUpdateControl();

updateControl(request, options, callback)

updateControl(request: protos.google.cloud.retail.v2beta.IUpdateControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IUpdateControlRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IUpdateControlRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IUpdateControlRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateControl(request, callback)

updateControl(request: protos.google.cloud.retail.v2beta.IUpdateControlRequest, callback: Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IUpdateControlRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.retail.v2beta.IUpdateControlRequest
callback Callback<protos.google.cloud.retail.v2beta.IControl, protos.google.cloud.retail.v2beta.IUpdateControlRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void