Class DocumentsClientImpl (3.2.0)

Version 3.2.0

• 4.23.0 (latest)
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0

public sealed class DocumentsClientImpl : DocumentsClient

Documents client wrapper implementation, for convenient use.

Inheritance

Object > DocumentsClient > DocumentsClientImpl

Inherited Members

DocumentsClient.DefaultEndpoint

DocumentsClient.DefaultScopes

DocumentsClient.CreateAsync(CancellationToken)

DocumentsClient.Create()

DocumentsClient.ShutdownDefaultChannelsAsync()

DocumentsClient.ListDocuments(String, String, Nullable<Int32>, CallSettings)

DocumentsClient.ListDocumentsAsync(String, String, Nullable<Int32>, CallSettings)

DocumentsClient.ListDocuments(KnowledgeBaseName, String, Nullable<Int32>, CallSettings)

DocumentsClient.ListDocumentsAsync(KnowledgeBaseName, String, Nullable<Int32>, CallSettings)

DocumentsClient.GetDocumentAsync(GetDocumentRequest, CancellationToken)

DocumentsClient.GetDocument(String, CallSettings)

DocumentsClient.GetDocumentAsync(String, CallSettings)

DocumentsClient.GetDocumentAsync(String, CancellationToken)

DocumentsClient.GetDocument(DocumentName, CallSettings)

DocumentsClient.GetDocumentAsync(DocumentName, CallSettings)

DocumentsClient.GetDocumentAsync(DocumentName, CancellationToken)

DocumentsClient.CreateDocumentAsync(CreateDocumentRequest, CancellationToken)

DocumentsClient.PollOnceCreateDocument(String, CallSettings)

DocumentsClient.PollOnceCreateDocumentAsync(String, CallSettings)

DocumentsClient.CreateDocument(String, Document, CallSettings)

DocumentsClient.CreateDocumentAsync(String, Document, CallSettings)

DocumentsClient.CreateDocumentAsync(String, Document, CancellationToken)

DocumentsClient.CreateDocument(KnowledgeBaseName, Document, CallSettings)

DocumentsClient.CreateDocumentAsync(KnowledgeBaseName, Document, CallSettings)

DocumentsClient.CreateDocumentAsync(KnowledgeBaseName, Document, CancellationToken)

DocumentsClient.DeleteDocumentAsync(DeleteDocumentRequest, CancellationToken)

DocumentsClient.PollOnceDeleteDocument(String, CallSettings)

DocumentsClient.PollOnceDeleteDocumentAsync(String, CallSettings)

DocumentsClient.DeleteDocument(String, CallSettings)

DocumentsClient.DeleteDocumentAsync(String, CallSettings)

DocumentsClient.DeleteDocumentAsync(String, CancellationToken)

DocumentsClient.DeleteDocument(DocumentName, CallSettings)

DocumentsClient.DeleteDocumentAsync(DocumentName, CallSettings)

DocumentsClient.DeleteDocumentAsync(DocumentName, CancellationToken)

DocumentsClient.UpdateDocumentAsync(UpdateDocumentRequest, CancellationToken)

DocumentsClient.PollOnceUpdateDocument(String, CallSettings)

DocumentsClient.PollOnceUpdateDocumentAsync(String, CallSettings)

DocumentsClient.UpdateDocument(Document, FieldMask, CallSettings)

DocumentsClient.UpdateDocumentAsync(Document, FieldMask, CallSettings)

DocumentsClient.UpdateDocumentAsync(Document, FieldMask, CancellationToken)

DocumentsClient.ReloadDocumentAsync(ReloadDocumentRequest, CancellationToken)

DocumentsClient.PollOnceReloadDocument(String, CallSettings)

DocumentsClient.PollOnceReloadDocumentAsync(String, CallSettings)

DocumentsClient.ReloadDocument(String, String, CallSettings)

DocumentsClient.ReloadDocumentAsync(String, String, CallSettings)

DocumentsClient.ReloadDocumentAsync(String, String, CancellationToken)

DocumentsClient.ReloadDocument(DocumentName, String, CallSettings)

DocumentsClient.ReloadDocumentAsync(DocumentName, String, CallSettings)

DocumentsClient.ReloadDocumentAsync(DocumentName, String, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Remarks

Service for managing knowledge [Documents][google.cloud.dialogflow.v2.Document].

Constructors

DocumentsClientImpl(Documents.DocumentsClient, DocumentsSettings)

public DocumentsClientImpl(Documents.DocumentsClient grpcClient, DocumentsSettings settings)

Constructs a client wrapper for the Documents service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	Documents.DocumentsClient The underlying gRPC client.
settings	DocumentsSettings The base DocumentsSettings used within this client.

Properties

CreateDocumentOperationsClient

public override OperationsClient CreateDocumentOperationsClient { get; }

The long-running operations client for CreateDocument.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

DocumentsClient.CreateDocumentOperationsClient

DeleteDocumentOperationsClient

public override OperationsClient DeleteDocumentOperationsClient { get; }

The long-running operations client for DeleteDocument.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

DocumentsClient.DeleteDocumentOperationsClient

GrpcClient

public override Documents.DocumentsClient GrpcClient { get; }

The underlying gRPC Documents client

Property Value
Type	Description
Documents.DocumentsClient

Overrides

DocumentsClient.GrpcClient

ReloadDocumentOperationsClient

public override OperationsClient ReloadDocumentOperationsClient { get; }

The long-running operations client for ReloadDocument.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

DocumentsClient.ReloadDocumentOperationsClient

UpdateDocumentOperationsClient

public override OperationsClient UpdateDocumentOperationsClient { get; }

The long-running operations client for UpdateDocument.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

DocumentsClient.UpdateDocumentOperationsClient

Methods

CreateDocument(CreateDocumentRequest, CallSettings)

public override Operation<Document, KnowledgeOperationMetadata> CreateDocument(CreateDocumentRequest request, CallSettings callSettings = null)

Creates a new document.

Operation &lt;response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]&gt;

Parameters
Name	Description
request	CreateDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Document, KnowledgeOperationMetadata>	The RPC response.

Overrides

DocumentsClient.CreateDocument(CreateDocumentRequest, CallSettings)

CreateDocumentAsync(CreateDocumentRequest, CallSettings)

public override Task<Operation<Document, KnowledgeOperationMetadata>> CreateDocumentAsync(CreateDocumentRequest request, CallSettings callSettings = null)

Creates a new document.

Operation &lt;response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]&gt;

Parameters
Name	Description
request	CreateDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Document, KnowledgeOperationMetadata>>	A Task containing the RPC response.

Overrides

DocumentsClient.CreateDocumentAsync(CreateDocumentRequest, CallSettings)

DeleteDocument(DeleteDocumentRequest, CallSettings)

public override Operation<Empty, KnowledgeOperationMetadata> DeleteDocument(DeleteDocumentRequest request, CallSettings callSettings = null)

Deletes the specified document.

Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]&gt;

Parameters
Name	Description
request	DeleteDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Empty, KnowledgeOperationMetadata>	The RPC response.

Overrides

DocumentsClient.DeleteDocument(DeleteDocumentRequest, CallSettings)

DeleteDocumentAsync(DeleteDocumentRequest, CallSettings)

public override Task<Operation<Empty, KnowledgeOperationMetadata>> DeleteDocumentAsync(DeleteDocumentRequest request, CallSettings callSettings = null)

Deletes the specified document.

Operation &lt;response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]&gt;

Parameters
Name	Description
request	DeleteDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Empty, KnowledgeOperationMetadata>>	A Task containing the RPC response.

Overrides

DocumentsClient.DeleteDocumentAsync(DeleteDocumentRequest, CallSettings)

GetDocument(GetDocumentRequest, CallSettings)

public override Document GetDocument(GetDocumentRequest request, CallSettings callSettings = null)

Retrieves the specified document.

Parameters
Name	Description
request	GetDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Document	The RPC response.

Overrides

DocumentsClient.GetDocument(GetDocumentRequest, CallSettings)

GetDocumentAsync(GetDocumentRequest, CallSettings)

public override Task<Document> GetDocumentAsync(GetDocumentRequest request, CallSettings callSettings = null)

Retrieves the specified document.

Parameters
Name	Description
request	GetDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Document>	A Task containing the RPC response.

Overrides

DocumentsClient.GetDocumentAsync(GetDocumentRequest, CallSettings)

ListDocuments(ListDocumentsRequest, CallSettings)

public override PagedEnumerable<ListDocumentsResponse, Document> ListDocuments(ListDocumentsRequest request, CallSettings callSettings = null)

Returns the list of all documents of the knowledge base.

Parameters
Name	Description
request	ListDocumentsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListDocumentsResponse, Document>	A pageable sequence of Document resources.

Overrides

DocumentsClient.ListDocuments(ListDocumentsRequest, CallSettings)

ListDocumentsAsync(ListDocumentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDocumentsResponse, Document> ListDocumentsAsync(ListDocumentsRequest request, CallSettings callSettings = null)

Returns the list of all documents of the knowledge base.

Parameters
Name	Description
request	ListDocumentsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListDocumentsResponse, Document>	A pageable asynchronous sequence of Document resources.

Overrides

DocumentsClient.ListDocumentsAsync(ListDocumentsRequest, CallSettings)

ReloadDocument(ReloadDocumentRequest, CallSettings)

public override Operation<Document, KnowledgeOperationMetadata> ReloadDocument(ReloadDocumentRequest request, CallSettings callSettings = null)

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Operation &lt;response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]&gt;

Parameters
Name	Description
request	ReloadDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Document, KnowledgeOperationMetadata>	The RPC response.

Overrides

DocumentsClient.ReloadDocument(ReloadDocumentRequest, CallSettings)

ReloadDocumentAsync(ReloadDocumentRequest, CallSettings)

public override Task<Operation<Document, KnowledgeOperationMetadata>> ReloadDocumentAsync(ReloadDocumentRequest request, CallSettings callSettings = null)

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Operation &lt;response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]&gt;

Parameters
Name	Description
request	ReloadDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Document, KnowledgeOperationMetadata>>	A Task containing the RPC response.

Overrides

DocumentsClient.ReloadDocumentAsync(ReloadDocumentRequest, CallSettings)

UpdateDocument(UpdateDocumentRequest, CallSettings)

public override Operation<Document, KnowledgeOperationMetadata> UpdateDocument(UpdateDocumentRequest request, CallSettings callSettings = null)

Updates the specified document.

Operation &lt;response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]&gt;

Parameters
Name	Description
request	UpdateDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Document, KnowledgeOperationMetadata>	The RPC response.

Overrides

DocumentsClient.UpdateDocument(UpdateDocumentRequest, CallSettings)

UpdateDocumentAsync(UpdateDocumentRequest, CallSettings)

public override Task<Operation<Document, KnowledgeOperationMetadata>> UpdateDocumentAsync(UpdateDocumentRequest request, CallSettings callSettings = null)

Updates the specified document.

Operation &lt;response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]&gt;

Parameters
Name	Description
request	UpdateDocumentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Document, KnowledgeOperationMetadata>>	A Task containing the RPC response.

Overrides

DocumentsClient.UpdateDocumentAsync(UpdateDocumentRequest, CallSettings)