Class DeveloperKnowledge.DeveloperKnowledgeClient

Show / Hide Table of Contents

Client for DeveloperKnowledge

Inheritance

object

ClientBase

ClientBase<DeveloperKnowledge.DeveloperKnowledgeClient>

DeveloperKnowledge.DeveloperKnowledgeClient

Inherited Members

ClientBase<DeveloperKnowledge.DeveloperKnowledgeClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Developers.DeveloperKnowledge.V1

Assembly: Google.Developers.DeveloperKnowledge.V1.dll

Syntax

public class DeveloperKnowledge.DeveloperKnowledgeClient : ClientBase<DeveloperKnowledge.DeveloperKnowledgeClient>

Constructors

DeveloperKnowledgeClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected DeveloperKnowledgeClient()

DeveloperKnowledgeClient(CallInvoker)

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

Declaration

public DeveloperKnowledgeClient(CallInvoker callInvoker)

Parameters

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

DeveloperKnowledgeClient(ChannelBase)

Creates a new client for DeveloperKnowledge

Declaration

public DeveloperKnowledgeClient(ChannelBase channel)

Parameters

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

DeveloperKnowledgeClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected DeveloperKnowledgeClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

BatchGetDocuments(BatchGetDocumentsRequest, CallOptions)

Retrieves multiple documents, each with its full Markdown content.

Declaration

public virtual BatchGetDocumentsResponse BatchGetDocuments(BatchGetDocumentsRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchGetDocumentsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
BatchGetDocumentsResponse	The response received from the server.

BatchGetDocuments(BatchGetDocumentsRequest, Metadata, DateTime?, CancellationToken)

Retrieves multiple documents, each with its full Markdown content.

Declaration

public virtual BatchGetDocumentsResponse BatchGetDocuments(BatchGetDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchGetDocumentsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	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
BatchGetDocumentsResponse	The response received from the server.

BatchGetDocumentsAsync(BatchGetDocumentsRequest, CallOptions)

Retrieves multiple documents, each with its full Markdown content.

Declaration

public virtual AsyncUnaryCall<BatchGetDocumentsResponse> BatchGetDocumentsAsync(BatchGetDocumentsRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchGetDocumentsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<BatchGetDocumentsResponse>	The call object.

BatchGetDocumentsAsync(BatchGetDocumentsRequest, Metadata, DateTime?, CancellationToken)

Retrieves multiple documents, each with its full Markdown content.

Declaration

public virtual AsyncUnaryCall<BatchGetDocumentsResponse> BatchGetDocumentsAsync(BatchGetDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchGetDocumentsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	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
AsyncUnaryCall<BatchGetDocumentsResponse>	The call object.

GetDocument(GetDocumentRequest, CallOptions)

Retrieves a single document with its full Markdown content.

Declaration

public virtual Document GetDocument(GetDocumentRequest request, CallOptions options)

Parameters

Type	Name	Description
GetDocumentRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Document	The response received from the server.

GetDocument(GetDocumentRequest, Metadata, DateTime?, CancellationToken)

Retrieves a single document with its full Markdown content.

Declaration

public virtual Document GetDocument(GetDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetDocumentRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	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
Document	The response received from the server.

GetDocumentAsync(GetDocumentRequest, CallOptions)

Retrieves a single document with its full Markdown content.

Declaration

public virtual AsyncUnaryCall<Document> GetDocumentAsync(GetDocumentRequest request, CallOptions options)

Parameters

Type	Name	Description
GetDocumentRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Document>	The call object.

GetDocumentAsync(GetDocumentRequest, Metadata, DateTime?, CancellationToken)

Retrieves a single document with its full Markdown content.

Declaration

public virtual AsyncUnaryCall<Document> GetDocumentAsync(GetDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetDocumentRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	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
AsyncUnaryCall<Document>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override DeveloperKnowledge.DeveloperKnowledgeClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
DeveloperKnowledge.DeveloperKnowledgeClient

Overrides

Grpc.Core.ClientBase<Google.Developers.DeveloperKnowledge.V1.DeveloperKnowledge.DeveloperKnowledgeClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SearchDocumentChunks(SearchDocumentChunksRequest, CallOptions)

Searches for developer knowledge across Google's developer documentation. Returns [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s based on the user's query. There may be many chunks from the same [Document][google.developers.knowledge.v1.Document]. To retrieve full documents, use [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] or [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] with the [DocumentChunk.parent][google.developers.knowledge.v1.DocumentChunk.parent] returned in the [SearchDocumentChunksResponse.results][google.developers.knowledge.v1.SearchDocumentChunksResponse.results].

Declaration

public virtual SearchDocumentChunksResponse SearchDocumentChunks(SearchDocumentChunksRequest request, CallOptions options)

Parameters

Type	Name	Description
SearchDocumentChunksRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
SearchDocumentChunksResponse	The response received from the server.

SearchDocumentChunks(SearchDocumentChunksRequest, Metadata, DateTime?, CancellationToken)

Searches for developer knowledge across Google's developer documentation. Returns [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s based on the user's query. There may be many chunks from the same [Document][google.developers.knowledge.v1.Document]. To retrieve full documents, use [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] or [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] with the [DocumentChunk.parent][google.developers.knowledge.v1.DocumentChunk.parent] returned in the [SearchDocumentChunksResponse.results][google.developers.knowledge.v1.SearchDocumentChunksResponse.results].

Declaration

public virtual SearchDocumentChunksResponse SearchDocumentChunks(SearchDocumentChunksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SearchDocumentChunksRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	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
SearchDocumentChunksResponse	The response received from the server.

SearchDocumentChunksAsync(SearchDocumentChunksRequest, CallOptions)

Searches for developer knowledge across Google's developer documentation. Returns [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s based on the user's query. There may be many chunks from the same [Document][google.developers.knowledge.v1.Document]. To retrieve full documents, use [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] or [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] with the [DocumentChunk.parent][google.developers.knowledge.v1.DocumentChunk.parent] returned in the [SearchDocumentChunksResponse.results][google.developers.knowledge.v1.SearchDocumentChunksResponse.results].

Declaration

public virtual AsyncUnaryCall<SearchDocumentChunksResponse> SearchDocumentChunksAsync(SearchDocumentChunksRequest request, CallOptions options)

Parameters

Type	Name	Description
SearchDocumentChunksRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<SearchDocumentChunksResponse>	The call object.

SearchDocumentChunksAsync(SearchDocumentChunksRequest, Metadata, DateTime?, CancellationToken)

Searches for developer knowledge across Google's developer documentation. Returns [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s based on the user's query. There may be many chunks from the same [Document][google.developers.knowledge.v1.Document]. To retrieve full documents, use [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] or [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] with the [DocumentChunk.parent][google.developers.knowledge.v1.DocumentChunk.parent] returned in the [SearchDocumentChunksResponse.results][google.developers.knowledge.v1.SearchDocumentChunksResponse.results].

Declaration

public virtual AsyncUnaryCall<SearchDocumentChunksResponse> SearchDocumentChunksAsync(SearchDocumentChunksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SearchDocumentChunksRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	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
AsyncUnaryCall<SearchDocumentChunksResponse>	The call object.

In this article

Back to top Generated by DocFX