CatalogService

google .cloud .retail .v2. CatalogService

Represents a CatalogService

Constructor

new CatalogService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new CatalogService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

addCatalogAttribute(request, callback) → {undefined}

Calls AddCatalogAttribute.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

addCatalogAttribute(request) → {Promise.<google.cloud.retail.v2.AttributesConfig>}

Calls AddCatalogAttribute.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IAddCatalogAttributeRequest	AddCatalogAttributeRequest message or plain object

Returns:

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

getAttributesConfig(request, callback) → {undefined}

Calls GetAttributesConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

getAttributesConfig(request) → {Promise.<google.cloud.retail.v2.AttributesConfig>}

Calls GetAttributesConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IGetAttributesConfigRequest	GetAttributesConfigRequest message or plain object

Returns:

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

getCompletionConfig(request, callback) → {undefined}

Calls GetCompletionConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

getCompletionConfig(request) → {Promise.<google.cloud.retail.v2.CompletionConfig>}

Calls GetCompletionConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IGetCompletionConfigRequest	GetCompletionConfigRequest message or plain object

Returns:

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

getDefaultBranch(request, callback) → {undefined}

Calls GetDefaultBranch.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

getDefaultBranch(request) → {Promise.<google.cloud.retail.v2.GetDefaultBranchResponse>}

Calls GetDefaultBranch.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IGetDefaultBranchRequest	GetDefaultBranchRequest message or plain object

Returns:

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

listCatalogs(request, callback) → {undefined}

Calls ListCatalogs.

Parameters:

Name	Type	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
undefined

listCatalogs(request) → {Promise.<google.cloud.retail.v2.ListCatalogsResponse>}

Calls ListCatalogs.

Parameters:

Name	Type	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) → {undefined}

Calls RemoveCatalogAttribute.

Parameters:

Name	Type	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
undefined

removeCatalogAttribute(request) → {Promise.<google.cloud.retail.v2.AttributesConfig>}

Calls RemoveCatalogAttribute.

Parameters:

Name	Type	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) → {undefined}

Calls ReplaceCatalogAttribute.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

replaceCatalogAttribute(request) → {Promise.<google.cloud.retail.v2.AttributesConfig>}

Calls ReplaceCatalogAttribute.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IReplaceCatalogAttributeRequest	ReplaceCatalogAttributeRequest message or plain object

Returns:

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

setDefaultBranch(request, callback) → {undefined}

Calls SetDefaultBranch.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

setDefaultBranch(request) → {Promise.<google.protobuf.Empty>}

Calls SetDefaultBranch.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.ISetDefaultBranchRequest	SetDefaultBranchRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

updateAttributesConfig(request, callback) → {undefined}

Calls UpdateAttributesConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

updateAttributesConfig(request) → {Promise.<google.cloud.retail.v2.AttributesConfig>}

Calls UpdateAttributesConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IUpdateAttributesConfigRequest	UpdateAttributesConfigRequest message or plain object

Returns:

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

updateCatalog(request, callback) → {undefined}

Calls UpdateCatalog.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

updateCatalog(request) → {Promise.<google.cloud.retail.v2.Catalog>}

Calls UpdateCatalog.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IUpdateCatalogRequest	UpdateCatalogRequest message or plain object

Returns:

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

updateCompletionConfig(request, callback) → {undefined}

Calls UpdateCompletionConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.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
undefined

updateCompletionConfig(request) → {Promise.<google.cloud.retail.v2.CompletionConfig>}

Calls UpdateCompletionConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IUpdateCompletionConfigRequest	UpdateCompletionConfigRequest message or plain object

Returns:

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

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {CatalogService}

Creates new CatalogService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

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

Type Definitions

AddCatalogAttributeCallback(error, responseopt)

Callback as used by addCatalogAttribute.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.AttributesConfig	<optional>	AttributesConfig

GetAttributesConfigCallback(error, responseopt)

Callback as used by getAttributesConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.AttributesConfig	<optional>	AttributesConfig

GetCompletionConfigCallback(error, responseopt)

Callback as used by getCompletionConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.CompletionConfig	<optional>	CompletionConfig

GetDefaultBranchCallback(error, responseopt)

Callback as used by getDefaultBranch.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.GetDefaultBranchResponse	<optional>	GetDefaultBranchResponse

ListCatalogsCallback(error, responseopt)

Callback as used by listCatalogs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.ListCatalogsResponse	<optional>	ListCatalogsResponse

RemoveCatalogAttributeCallback(error, responseopt)

Callback as used by removeCatalogAttribute.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.AttributesConfig	<optional>	AttributesConfig

ReplaceCatalogAttributeCallback(error, responseopt)

Callback as used by replaceCatalogAttribute.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.AttributesConfig	<optional>	AttributesConfig

SetDefaultBranchCallback(error, responseopt)

Callback as used by setDefaultBranch.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

UpdateAttributesConfigCallback(error, responseopt)

Callback as used by updateAttributesConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.AttributesConfig	<optional>	AttributesConfig

UpdateCatalogCallback(error, responseopt)

Callback as used by updateCatalog.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.Catalog	<optional>	Catalog

UpdateCompletionConfigCallback(error, responseopt)

Callback as used by updateCompletionConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.CompletionConfig	<optional>	CompletionConfig