Google Cloud Dialogflow v2 API - Class KnowledgeBases.KnowledgeBasesClient (4.21.0)

public class KnowledgeBases.KnowledgeBasesClient : ClientBase<KnowledgeBases.KnowledgeBasesClient>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class KnowledgeBases.KnowledgeBasesClient.

Client for KnowledgeBases

Inheritance

object > ClientBase > ClientBaseKnowledgeBasesKnowledgeBasesClient > KnowledgeBases.KnowledgeBasesClient

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

KnowledgeBasesClient()

protected KnowledgeBasesClient()

Protected parameterless constructor to allow creation of test doubles.

KnowledgeBasesClient(CallInvoker)

public KnowledgeBasesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

KnowledgeBasesClient(ChannelBase)

public KnowledgeBasesClient(ChannelBase channel)

Creates a new client for KnowledgeBases

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

KnowledgeBasesClient(ClientBaseConfiguration)

protected KnowledgeBasesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateKnowledgeBase(CreateKnowledgeBaseRequest, CallOptions)

public virtual KnowledgeBase CreateKnowledgeBase(CreateKnowledgeBaseRequest request, CallOptions options)

Creates a knowledge base.

Parameters
Name Description
request CreateKnowledgeBaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
KnowledgeBase

The response received from the server.

CreateKnowledgeBase(CreateKnowledgeBaseRequest, Metadata, DateTime?, CancellationToken)

public virtual KnowledgeBase CreateKnowledgeBase(CreateKnowledgeBaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a knowledge base.

Parameters
Name Description
request CreateKnowledgeBaseRequest

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
KnowledgeBase

The response received from the server.

CreateKnowledgeBaseAsync(CreateKnowledgeBaseRequest, CallOptions)

public virtual AsyncUnaryCall<KnowledgeBase> CreateKnowledgeBaseAsync(CreateKnowledgeBaseRequest request, CallOptions options)

Creates a knowledge base.

Parameters
Name Description
request CreateKnowledgeBaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallKnowledgeBase

The call object.

CreateKnowledgeBaseAsync(CreateKnowledgeBaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<KnowledgeBase> CreateKnowledgeBaseAsync(CreateKnowledgeBaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a knowledge base.

Parameters
Name Description
request CreateKnowledgeBaseRequest

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
AsyncUnaryCallKnowledgeBase

The call object.

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.

DeleteKnowledgeBase(DeleteKnowledgeBaseRequest, CallOptions)

public virtual Empty DeleteKnowledgeBase(DeleteKnowledgeBaseRequest request, CallOptions options)

Deletes the specified knowledge base.

Parameters
Name Description
request DeleteKnowledgeBaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteKnowledgeBase(DeleteKnowledgeBaseRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified knowledge base.

Parameters
Name Description
request DeleteKnowledgeBaseRequest

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.

DeleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest request, CallOptions options)

Deletes the specified knowledge base.

Parameters
Name Description
request DeleteKnowledgeBaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified knowledge base.

Parameters
Name Description
request DeleteKnowledgeBaseRequest

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.

GetKnowledgeBase(GetKnowledgeBaseRequest, CallOptions)

public virtual KnowledgeBase GetKnowledgeBase(GetKnowledgeBaseRequest request, CallOptions options)

Retrieves the specified knowledge base.

Parameters
Name Description
request GetKnowledgeBaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
KnowledgeBase

The response received from the server.

GetKnowledgeBase(GetKnowledgeBaseRequest, Metadata, DateTime?, CancellationToken)

public virtual KnowledgeBase GetKnowledgeBase(GetKnowledgeBaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified knowledge base.

Parameters
Name Description
request GetKnowledgeBaseRequest

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
KnowledgeBase

The response received from the server.

GetKnowledgeBaseAsync(GetKnowledgeBaseRequest, CallOptions)

public virtual AsyncUnaryCall<KnowledgeBase> GetKnowledgeBaseAsync(GetKnowledgeBaseRequest request, CallOptions options)

Retrieves the specified knowledge base.

Parameters
Name Description
request GetKnowledgeBaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallKnowledgeBase

The call object.

GetKnowledgeBaseAsync(GetKnowledgeBaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<KnowledgeBase> GetKnowledgeBaseAsync(GetKnowledgeBaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified knowledge base.

Parameters
Name Description
request GetKnowledgeBaseRequest

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
AsyncUnaryCallKnowledgeBase

The call object.

ListKnowledgeBases(ListKnowledgeBasesRequest, CallOptions)

public virtual ListKnowledgeBasesResponse ListKnowledgeBases(ListKnowledgeBasesRequest request, CallOptions options)

Returns the list of all knowledge bases of the specified agent.

Parameters
Name Description
request ListKnowledgeBasesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListKnowledgeBasesResponse

The response received from the server.

ListKnowledgeBases(ListKnowledgeBasesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListKnowledgeBasesResponse ListKnowledgeBases(ListKnowledgeBasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all knowledge bases of the specified agent.

Parameters
Name Description
request ListKnowledgeBasesRequest

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
ListKnowledgeBasesResponse

The response received from the server.

ListKnowledgeBasesAsync(ListKnowledgeBasesRequest, CallOptions)

public virtual AsyncUnaryCall<ListKnowledgeBasesResponse> ListKnowledgeBasesAsync(ListKnowledgeBasesRequest request, CallOptions options)

Returns the list of all knowledge bases of the specified agent.

Parameters
Name Description
request ListKnowledgeBasesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListKnowledgeBasesResponse

The call object.

ListKnowledgeBasesAsync(ListKnowledgeBasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListKnowledgeBasesResponse> ListKnowledgeBasesAsync(ListKnowledgeBasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all knowledge bases of the specified agent.

Parameters
Name Description
request ListKnowledgeBasesRequest

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
AsyncUnaryCallListKnowledgeBasesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override KnowledgeBases.KnowledgeBasesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
KnowledgeBasesKnowledgeBasesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Dialogflow.V2.KnowledgeBases.KnowledgeBasesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateKnowledgeBase(UpdateKnowledgeBaseRequest, CallOptions)

public virtual KnowledgeBase UpdateKnowledgeBase(UpdateKnowledgeBaseRequest request, CallOptions options)

Updates the specified knowledge base.

Parameters
Name Description
request UpdateKnowledgeBaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
KnowledgeBase

The response received from the server.

UpdateKnowledgeBase(UpdateKnowledgeBaseRequest, Metadata, DateTime?, CancellationToken)

public virtual KnowledgeBase UpdateKnowledgeBase(UpdateKnowledgeBaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified knowledge base.

Parameters
Name Description
request UpdateKnowledgeBaseRequest

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
KnowledgeBase

The response received from the server.

UpdateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest, CallOptions)

public virtual AsyncUnaryCall<KnowledgeBase> UpdateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest request, CallOptions options)

Updates the specified knowledge base.

Parameters
Name Description
request UpdateKnowledgeBaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallKnowledgeBase

The call object.

UpdateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<KnowledgeBase> UpdateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified knowledge base.

Parameters
Name Description
request UpdateKnowledgeBaseRequest

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
AsyncUnaryCallKnowledgeBase

The call object.