Recommendations AI v1beta1 API - Class CatalogService.CatalogServiceClient (2.0.0-beta07)

Version latest

• 2.0.0-beta07 (latest)
• 2.0.0-beta06
• 1.0.0-beta03

public class CatalogService.CatalogServiceClient : ClientBase<CatalogService.CatalogServiceClient>

Reference documentation and code samples for the Recommendations AI v1beta1 API class CatalogService.CatalogServiceClient.

Client for CatalogService

Inheritance

object > ClientBase > ClientBaseCatalogServiceCatalogServiceClient > CatalogService.CatalogServiceClient

Inherited Members

ClientBase<CatalogService.CatalogServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

CatalogServiceClient()

protected CatalogServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CatalogServiceClient(CallInvoker)

public CatalogServiceClient(CallInvoker callInvoker)

Creates a new client for CatalogService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

CatalogServiceClient(ChannelBase)

public CatalogServiceClient(ChannelBase channel)

Creates a new client for CatalogService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

CatalogServiceClient(ClientBaseConfiguration)

protected CatalogServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateCatalogItem(CreateCatalogItemRequest, CallOptions)

public virtual CatalogItem CreateCatalogItem(CreateCatalogItemRequest request, CallOptions options)

Creates a catalog item.

Parameters
Name	Description
request	CreateCatalogItemRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
CatalogItem	The response received from the server.

CreateCatalogItem(CreateCatalogItemRequest, Metadata, DateTime?, CancellationToken)

public virtual CatalogItem CreateCatalogItem(CreateCatalogItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a catalog item.

Parameters
Name	Description
request	CreateCatalogItemRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
CatalogItem	The response received from the server.

CreateCatalogItemAsync(CreateCatalogItemRequest, CallOptions)

public virtual AsyncUnaryCall<CatalogItem> CreateCatalogItemAsync(CreateCatalogItemRequest request, CallOptions options)

Creates a catalog item.

Parameters
Name	Description
request	CreateCatalogItemRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCatalogItem	The call object.

CreateCatalogItemAsync(CreateCatalogItemRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CatalogItem> CreateCatalogItemAsync(CreateCatalogItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a catalog item.

Parameters
Name	Description
request	CreateCatalogItemRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallCatalogItem	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteCatalogItem(DeleteCatalogItemRequest, CallOptions)

public virtual Empty DeleteCatalogItem(DeleteCatalogItemRequest request, CallOptions options)

Deletes a catalog item.

Parameters
Name	Description
request	DeleteCatalogItemRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteCatalogItem(DeleteCatalogItemRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteCatalogItem(DeleteCatalogItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a catalog item.

Parameters
Name	Description
request	DeleteCatalogItemRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteCatalogItemAsync(DeleteCatalogItemRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteCatalogItemAsync(DeleteCatalogItemRequest request, CallOptions options)

Deletes a catalog item.

Parameters
Name	Description
request	DeleteCatalogItemRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteCatalogItemAsync(DeleteCatalogItemRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteCatalogItemAsync(DeleteCatalogItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a catalog item.

Parameters
Name	Description
request	DeleteCatalogItemRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetCatalogItem(GetCatalogItemRequest, CallOptions)

public virtual CatalogItem GetCatalogItem(GetCatalogItemRequest request, CallOptions options)

Gets a specific catalog item.

Parameters
Name	Description
request	GetCatalogItemRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
CatalogItem	The response received from the server.

GetCatalogItem(GetCatalogItemRequest, Metadata, DateTime?, CancellationToken)

public virtual CatalogItem GetCatalogItem(GetCatalogItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a specific catalog item.

Parameters
Name	Description
request	GetCatalogItemRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
CatalogItem	The response received from the server.

GetCatalogItemAsync(GetCatalogItemRequest, CallOptions)

public virtual AsyncUnaryCall<CatalogItem> GetCatalogItemAsync(GetCatalogItemRequest request, CallOptions options)

Gets a specific catalog item.

Parameters
Name	Description
request	GetCatalogItemRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCatalogItem	The call object.

GetCatalogItemAsync(GetCatalogItemRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CatalogItem> GetCatalogItemAsync(GetCatalogItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a specific catalog item.

Parameters
Name	Description
request	GetCatalogItemRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallCatalogItem	The call object.

ImportCatalogItems(ImportCatalogItemsRequest, CallOptions)

public virtual Operation ImportCatalogItems(ImportCatalogItemsRequest request, CallOptions options)

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.

Parameters
Name	Description
request	ImportCatalogItemsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ImportCatalogItems(ImportCatalogItemsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportCatalogItems(ImportCatalogItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.

Parameters
Name	Description
request	ImportCatalogItemsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ImportCatalogItemsAsync(ImportCatalogItemsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportCatalogItemsAsync(ImportCatalogItemsRequest request, CallOptions options)

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.

Parameters
Name	Description
request	ImportCatalogItemsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ImportCatalogItemsAsync(ImportCatalogItemsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportCatalogItemsAsync(ImportCatalogItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.

Parameters
Name	Description
request	ImportCatalogItemsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ListCatalogItems(ListCatalogItemsRequest, CallOptions)

public virtual ListCatalogItemsResponse ListCatalogItems(ListCatalogItemsRequest request, CallOptions options)

Gets a list of catalog items.

Parameters
Name	Description
request	ListCatalogItemsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListCatalogItemsResponse	The response received from the server.

ListCatalogItems(ListCatalogItemsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCatalogItemsResponse ListCatalogItems(ListCatalogItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of catalog items.

Parameters
Name	Description
request	ListCatalogItemsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListCatalogItemsResponse	The response received from the server.

ListCatalogItemsAsync(ListCatalogItemsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCatalogItemsResponse> ListCatalogItemsAsync(ListCatalogItemsRequest request, CallOptions options)

Gets a list of catalog items.

Parameters
Name	Description
request	ListCatalogItemsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListCatalogItemsResponse	The call object.

ListCatalogItemsAsync(ListCatalogItemsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCatalogItemsResponse> ListCatalogItemsAsync(ListCatalogItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of catalog items.

Parameters
Name	Description
request	ListCatalogItemsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListCatalogItemsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override CatalogService.CatalogServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
CatalogServiceCatalogServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.RecommendationEngine.V1Beta1.CatalogService.CatalogServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateCatalogItem(UpdateCatalogItemRequest, CallOptions)

public virtual CatalogItem UpdateCatalogItem(UpdateCatalogItemRequest request, CallOptions options)

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

Parameters
Name	Description
request	UpdateCatalogItemRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
CatalogItem	The response received from the server.

UpdateCatalogItem(UpdateCatalogItemRequest, Metadata, DateTime?, CancellationToken)

public virtual CatalogItem UpdateCatalogItem(UpdateCatalogItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

Parameters
Name	Description
request	UpdateCatalogItemRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
CatalogItem	The response received from the server.

UpdateCatalogItemAsync(UpdateCatalogItemRequest, CallOptions)

public virtual AsyncUnaryCall<CatalogItem> UpdateCatalogItemAsync(UpdateCatalogItemRequest request, CallOptions options)

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

Parameters
Name	Description
request	UpdateCatalogItemRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCatalogItem	The call object.

UpdateCatalogItemAsync(UpdateCatalogItemRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CatalogItem> UpdateCatalogItemAsync(UpdateCatalogItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

Parameters
Name	Description
request	UpdateCatalogItemRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallCatalogItem	The call object.