Class protos.google.cloud.retail.v2.CatalogService (2.1.1)

Version 2.1.1

• 3.5.0 (latest)
• 3.1.0
• 2.4.1
• 2.3.1
• 2.1.1
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.6

Represents a CatalogService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.retail.v2.CatalogService

Package

@google-cloud/retail

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new CatalogService service.

Parameters

Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

addCatalogAttribute(request, callback)

public addCatalogAttribute(request: google.cloud.retail.v2.IAddCatalogAttributeRequest, callback: google.cloud.retail.v2.CatalogService.AddCatalogAttributeCallback): void;

Calls AddCatalogAttribute.

Parameters

Name	Description
request	IAddCatalogAttributeRequest AddCatalogAttributeRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.AddCatalogAttributeCallback Node-style callback called with the error, if any, and AttributesConfig

Returns

Type	Description
void

addCatalogAttribute(request)

public addCatalogAttribute(request: google.cloud.retail.v2.IAddCatalogAttributeRequest): Promise<google.cloud.retail.v2.AttributesConfig>;

Calls AddCatalogAttribute.

Parameter

Name	Description
request	IAddCatalogAttributeRequest AddCatalogAttributeRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.AttributesConfig>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CatalogService;

Creates new CatalogService service using the specified rpc implementation.

Parameters

Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns

Type	Description
CatalogService	RPC service. Useful where requests and/or responses are streamed.

getAttributesConfig(request, callback)

public getAttributesConfig(request: google.cloud.retail.v2.IGetAttributesConfigRequest, callback: google.cloud.retail.v2.CatalogService.GetAttributesConfigCallback): void;

Calls GetAttributesConfig.

Parameters

Name	Description
request	IGetAttributesConfigRequest GetAttributesConfigRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.GetAttributesConfigCallback Node-style callback called with the error, if any, and AttributesConfig

Returns

Type	Description
void

getAttributesConfig(request)

public getAttributesConfig(request: google.cloud.retail.v2.IGetAttributesConfigRequest): Promise<google.cloud.retail.v2.AttributesConfig>;

Calls GetAttributesConfig.

Parameter

Name	Description
request	IGetAttributesConfigRequest GetAttributesConfigRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.AttributesConfig>	Promise

getCompletionConfig(request, callback)

public getCompletionConfig(request: google.cloud.retail.v2.IGetCompletionConfigRequest, callback: google.cloud.retail.v2.CatalogService.GetCompletionConfigCallback): void;

Calls GetCompletionConfig.

Parameters

Name	Description
request	IGetCompletionConfigRequest GetCompletionConfigRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.GetCompletionConfigCallback Node-style callback called with the error, if any, and CompletionConfig

Returns

Type	Description
void

getCompletionConfig(request)

public getCompletionConfig(request: google.cloud.retail.v2.IGetCompletionConfigRequest): Promise<google.cloud.retail.v2.CompletionConfig>;

Calls GetCompletionConfig.

Parameter

Name	Description
request	IGetCompletionConfigRequest GetCompletionConfigRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.CompletionConfig>	Promise

getDefaultBranch(request, callback)

public getDefaultBranch(request: google.cloud.retail.v2.IGetDefaultBranchRequest, callback: google.cloud.retail.v2.CatalogService.GetDefaultBranchCallback): void;

Calls GetDefaultBranch.

Parameters

Name	Description
request	IGetDefaultBranchRequest GetDefaultBranchRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.GetDefaultBranchCallback Node-style callback called with the error, if any, and GetDefaultBranchResponse

Returns

Type	Description
void

getDefaultBranch(request)

public getDefaultBranch(request: google.cloud.retail.v2.IGetDefaultBranchRequest): Promise<google.cloud.retail.v2.GetDefaultBranchResponse>;

Calls GetDefaultBranch.

Parameter

Name	Description
request	IGetDefaultBranchRequest GetDefaultBranchRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.GetDefaultBranchResponse>	Promise

listCatalogs(request, callback)

public listCatalogs(request: google.cloud.retail.v2.IListCatalogsRequest, callback: google.cloud.retail.v2.CatalogService.ListCatalogsCallback): void;

Calls ListCatalogs.

Parameters

Name	Description
request	google.cloud.retail.v2.IListCatalogsRequest ListCatalogsRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.ListCatalogsCallback Node-style callback called with the error, if any, and ListCatalogsResponse

Returns

Type	Description
void

listCatalogs(request)

public listCatalogs(request: google.cloud.retail.v2.IListCatalogsRequest): Promise<google.cloud.retail.v2.ListCatalogsResponse>;

Calls ListCatalogs.

Parameter

Name	Description
request	google.cloud.retail.v2.IListCatalogsRequest ListCatalogsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.ListCatalogsResponse>	Promise

removeCatalogAttribute(request, callback)

public removeCatalogAttribute(request: google.cloud.retail.v2.IRemoveCatalogAttributeRequest, callback: google.cloud.retail.v2.CatalogService.RemoveCatalogAttributeCallback): void;

Calls RemoveCatalogAttribute.

Parameters

Name	Description
request	google.cloud.retail.v2.IRemoveCatalogAttributeRequest RemoveCatalogAttributeRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.RemoveCatalogAttributeCallback Node-style callback called with the error, if any, and AttributesConfig

Returns

Type	Description
void

removeCatalogAttribute(request)

public removeCatalogAttribute(request: google.cloud.retail.v2.IRemoveCatalogAttributeRequest): Promise<google.cloud.retail.v2.AttributesConfig>;

Calls RemoveCatalogAttribute.

Parameter

Name	Description
request	google.cloud.retail.v2.IRemoveCatalogAttributeRequest RemoveCatalogAttributeRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.AttributesConfig>	Promise

replaceCatalogAttribute(request, callback)

public replaceCatalogAttribute(request: google.cloud.retail.v2.IReplaceCatalogAttributeRequest, callback: google.cloud.retail.v2.CatalogService.ReplaceCatalogAttributeCallback): void;

Calls ReplaceCatalogAttribute.

Parameters

Name	Description
request	IReplaceCatalogAttributeRequest ReplaceCatalogAttributeRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.ReplaceCatalogAttributeCallback Node-style callback called with the error, if any, and AttributesConfig

Returns

Type	Description
void

replaceCatalogAttribute(request)

public replaceCatalogAttribute(request: google.cloud.retail.v2.IReplaceCatalogAttributeRequest): Promise<google.cloud.retail.v2.AttributesConfig>;

Calls ReplaceCatalogAttribute.

Parameter

Name	Description
request	IReplaceCatalogAttributeRequest ReplaceCatalogAttributeRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.AttributesConfig>	Promise

setDefaultBranch(request, callback)

public setDefaultBranch(request: google.cloud.retail.v2.ISetDefaultBranchRequest, callback: google.cloud.retail.v2.CatalogService.SetDefaultBranchCallback): void;

Calls SetDefaultBranch.

Parameters

Name	Description
request	ISetDefaultBranchRequest SetDefaultBranchRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.SetDefaultBranchCallback Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

setDefaultBranch(request)

public setDefaultBranch(request: google.cloud.retail.v2.ISetDefaultBranchRequest): Promise<google.protobuf.Empty>;

Calls SetDefaultBranch.

Parameter

Name	Description
request	ISetDefaultBranchRequest SetDefaultBranchRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

updateAttributesConfig(request, callback)

public updateAttributesConfig(request: google.cloud.retail.v2.IUpdateAttributesConfigRequest, callback: google.cloud.retail.v2.CatalogService.UpdateAttributesConfigCallback): void;

Calls UpdateAttributesConfig.

Parameters

Name	Description
request	IUpdateAttributesConfigRequest UpdateAttributesConfigRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.UpdateAttributesConfigCallback Node-style callback called with the error, if any, and AttributesConfig

Returns

Type	Description
void

updateAttributesConfig(request)

public updateAttributesConfig(request: google.cloud.retail.v2.IUpdateAttributesConfigRequest): Promise<google.cloud.retail.v2.AttributesConfig>;

Calls UpdateAttributesConfig.

Parameter

Name	Description
request	IUpdateAttributesConfigRequest UpdateAttributesConfigRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.AttributesConfig>	Promise

updateCatalog(request, callback)

public updateCatalog(request: google.cloud.retail.v2.IUpdateCatalogRequest, callback: google.cloud.retail.v2.CatalogService.UpdateCatalogCallback): void;

Calls UpdateCatalog.

Parameters

Name	Description
request	IUpdateCatalogRequest UpdateCatalogRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.UpdateCatalogCallback Node-style callback called with the error, if any, and Catalog

Returns

Type	Description
void

updateCatalog(request)

public updateCatalog(request: google.cloud.retail.v2.IUpdateCatalogRequest): Promise<google.cloud.retail.v2.Catalog>;

Calls UpdateCatalog.

Parameter

Name	Description
request	IUpdateCatalogRequest UpdateCatalogRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.Catalog>	Promise

updateCompletionConfig(request, callback)

public updateCompletionConfig(request: google.cloud.retail.v2.IUpdateCompletionConfigRequest, callback: google.cloud.retail.v2.CatalogService.UpdateCompletionConfigCallback): void;

Calls UpdateCompletionConfig.

Parameters

Name	Description
request	IUpdateCompletionConfigRequest UpdateCompletionConfigRequest message or plain object
callback	google.cloud.retail.v2.CatalogService.UpdateCompletionConfigCallback Node-style callback called with the error, if any, and CompletionConfig

Returns

Type	Description
void

updateCompletionConfig(request)

public updateCompletionConfig(request: google.cloud.retail.v2.IUpdateCompletionConfigRequest): Promise<google.cloud.retail.v2.CompletionConfig>;

Calls UpdateCompletionConfig.

Parameter

Name	Description
request	IUpdateCompletionConfigRequest UpdateCompletionConfigRequest message or plain object

Returns

Type	Description
Promise<google.cloud.retail.v2.CompletionConfig>	Promise