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

Stay organized with collections Save and categorize content based on your preferences.
public class CatalogServiceClient : ClientBase<CatalogService.CatalogServiceClient>

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

Client for CatalogService

Inheritance

Object > ClientBase > ClientBase<CatalogService.CatalogServiceClient> > CatalogService.CatalogServiceClient

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

CatalogServiceClient(ChannelBase)

public CatalogServiceClient(ChannelBase channel)

Creates a new client for CatalogService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

CatalogServiceClient(ClientBase.ClientBaseConfiguration)

protected CatalogServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateCatalogItem(CreateCatalogItemRequest, CallOptions)

public virtual CatalogItem CreateCatalogItem(CreateCatalogItemRequest request, CallOptions options)

Creates a catalog item.

Parameters
NameDescription
requestCreateCatalogItemRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CatalogItem

The response received from the server.

CreateCatalogItem(CreateCatalogItemRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a catalog item.

Parameters
NameDescription
requestCreateCatalogItemRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
CatalogItem

The response received from the server.

CreateCatalogItemAsync(CreateCatalogItemRequest, CallOptions)

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

Creates a catalog item.

Parameters
NameDescription
requestCreateCatalogItemRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<CatalogItem>

The call object.

CreateCatalogItemAsync(CreateCatalogItemRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a catalog item.

Parameters
NameDescription
requestCreateCatalogItemRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<CatalogItem>

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
TypeDescription
Operations.OperationsClient

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
NameDescription
requestDeleteCatalogItemRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteCatalogItem(DeleteCatalogItemRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a catalog item.

Parameters
NameDescription
requestDeleteCatalogItemRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteCatalogItemAsync(DeleteCatalogItemRequest, CallOptions)

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

Deletes a catalog item.

Parameters
NameDescription
requestDeleteCatalogItemRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteCatalogItemAsync(DeleteCatalogItemRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a catalog item.

Parameters
NameDescription
requestDeleteCatalogItemRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

GetCatalogItem(GetCatalogItemRequest, CallOptions)

public virtual CatalogItem GetCatalogItem(GetCatalogItemRequest request, CallOptions options)

Gets a specific catalog item.

Parameters
NameDescription
requestGetCatalogItemRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CatalogItem

The response received from the server.

GetCatalogItem(GetCatalogItemRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a specific catalog item.

Parameters
NameDescription
requestGetCatalogItemRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetCatalogItemRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<CatalogItem>

The call object.

GetCatalogItemAsync(GetCatalogItemRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a specific catalog item.

Parameters
NameDescription
requestGetCatalogItemRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<CatalogItem>

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
NameDescription
requestImportCatalogItemsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportCatalogItems(ImportCatalogItemsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestImportCatalogItemsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestImportCatalogItemsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ImportCatalogItemsAsync(ImportCatalogItemsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestImportCatalogItemsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ListCatalogItems(ListCatalogItemsRequest, CallOptions)

public virtual ListCatalogItemsResponse ListCatalogItems(ListCatalogItemsRequest request, CallOptions options)

Gets a list of catalog items.

Parameters
NameDescription
requestListCatalogItemsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListCatalogItemsResponse

The response received from the server.

ListCatalogItems(ListCatalogItemsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a list of catalog items.

Parameters
NameDescription
requestListCatalogItemsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListCatalogItemsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListCatalogItemsResponse>

The call object.

ListCatalogItemsAsync(ListCatalogItemsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a list of catalog items.

Parameters
NameDescription
requestListCatalogItemsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListCatalogItemsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
CatalogService.CatalogServiceClient
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
NameDescription
requestUpdateCatalogItemRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CatalogItem

The response received from the server.

UpdateCatalogItem(UpdateCatalogItemRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateCatalogItemRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpdateCatalogItemRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<CatalogItem>

The call object.

UpdateCatalogItemAsync(UpdateCatalogItemRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateCatalogItemRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<CatalogItem>

The call object.