Discovery Engine v1beta API - Class UserStoreService.UserStoreServiceClient (1.0.0-beta24)

public class UserStoreService.UserStoreServiceClient : ClientBase<UserStoreService.UserStoreServiceClient>

Reference documentation and code samples for the Discovery Engine v1beta API class UserStoreService.UserStoreServiceClient.

Client for UserStoreService

Inheritance

object > ClientBase > ClientBaseUserStoreServiceUserStoreServiceClient > UserStoreService.UserStoreServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

UserStoreServiceClient()

protected UserStoreServiceClient()

Protected parameterless constructor to allow creation of test doubles.

UserStoreServiceClient(CallInvoker)

public UserStoreServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

UserStoreServiceClient(ChannelBase)

public UserStoreServiceClient(ChannelBase channel)

Creates a new client for UserStoreService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

UserStoreServiceClient(ClientBaseConfiguration)

protected UserStoreServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

GetUserStore(GetUserStoreRequest, CallOptions)

public virtual UserStore GetUserStore(GetUserStoreRequest request, CallOptions options)

Gets the User Store.

Parameters
Name Description
request GetUserStoreRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
UserStore

The response received from the server.

GetUserStore(GetUserStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual UserStore GetUserStore(GetUserStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the User Store.

Parameters
Name Description
request GetUserStoreRequest

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
UserStore

The response received from the server.

GetUserStoreAsync(GetUserStoreRequest, CallOptions)

public virtual AsyncUnaryCall<UserStore> GetUserStoreAsync(GetUserStoreRequest request, CallOptions options)

Gets the User Store.

Parameters
Name Description
request GetUserStoreRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallUserStore

The call object.

GetUserStoreAsync(GetUserStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UserStore> GetUserStoreAsync(GetUserStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the User Store.

Parameters
Name Description
request GetUserStoreRequest

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
AsyncUnaryCallUserStore

The call object.

NewInstance(ClientBaseConfiguration)

protected override UserStoreService.UserStoreServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
UserStoreServiceUserStoreServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1Beta.UserStoreService.UserStoreServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateUserStore(UpdateUserStoreRequest, CallOptions)

public virtual UserStore UpdateUserStore(UpdateUserStoreRequest request, CallOptions options)

Updates the User Store.

Parameters
Name Description
request UpdateUserStoreRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
UserStore

The response received from the server.

UpdateUserStore(UpdateUserStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual UserStore UpdateUserStore(UpdateUserStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the User Store.

Parameters
Name Description
request UpdateUserStoreRequest

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
UserStore

The response received from the server.

UpdateUserStoreAsync(UpdateUserStoreRequest, CallOptions)

public virtual AsyncUnaryCall<UserStore> UpdateUserStoreAsync(UpdateUserStoreRequest request, CallOptions options)

Updates the User Store.

Parameters
Name Description
request UpdateUserStoreRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallUserStore

The call object.

UpdateUserStoreAsync(UpdateUserStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UserStore> UpdateUserStoreAsync(UpdateUserStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the User Store.

Parameters
Name Description
request UpdateUserStoreRequest

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
AsyncUnaryCallUserStore

The call object.