Class protos.google.cloud.retail.v2beta.CatalogService (1.6.1)

Represents a CatalogService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.retail.v2beta.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

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.

getDefaultBranch(request, callback)

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

Calls GetDefaultBranch.

Parameters
Name Description
request IGetDefaultBranchRequest

GetDefaultBranchRequest message or plain object
callback google.cloud.retail.v2beta.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.v2beta.IGetDefaultBranchRequest): Promise<google.cloud.retail.v2beta.GetDefaultBranchResponse>;

Calls GetDefaultBranch.

Parameter
Name Description
request IGetDefaultBranchRequest

GetDefaultBranchRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2beta.GetDefaultBranchResponse>

Promise

listCatalogs(request, callback)

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

Calls ListCatalogs.

Parameters
Name Description
request IListCatalogsRequest

ListCatalogsRequest message or plain object
callback google.cloud.retail.v2beta.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.v2beta.IListCatalogsRequest): Promise<google.cloud.retail.v2beta.ListCatalogsResponse>;

Calls ListCatalogs.

Parameter
Name Description
request IListCatalogsRequest

ListCatalogsRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2beta.ListCatalogsResponse>

Promise

setDefaultBranch(request, callback)

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

Calls SetDefaultBranch.

Parameters
Name Description
request ISetDefaultBranchRequest

SetDefaultBranchRequest message or plain object
callback google.cloud.retail.v2beta.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.v2beta.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

updateCatalog(request, callback)

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

Calls UpdateCatalog.

Parameters
Name Description
request google.cloud.retail.v2beta.IUpdateCatalogRequest

UpdateCatalogRequest message or plain object
callback google.cloud.retail.v2beta.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.v2beta.IUpdateCatalogRequest): Promise<google.cloud.retail.v2beta.Catalog>;

Calls UpdateCatalog.

Parameter
Name Description
request google.cloud.retail.v2beta.IUpdateCatalogRequest

UpdateCatalogRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2beta.Catalog>

Promise