public class Documents.DocumentsClient : ClientBase<Documents.DocumentsClient>Reference documentation and code samples for the Google Cloud Dialogflow v2 API class Documents.DocumentsClient.
Client for Documents
Namespace
Google.Cloud.Dialogflow.V2Assembly
Google.Cloud.Dialogflow.V2.dll
Constructors
DocumentsClient()
protected DocumentsClient()Protected parameterless constructor to allow creation of test doubles.
DocumentsClient(CallInvoker)
public DocumentsClient(CallInvoker callInvoker)Creates a new client for Documents that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker | CallInvokerThe callInvoker to use to make remote calls. |
DocumentsClient(ChannelBase)
public DocumentsClient(ChannelBase channel)Creates a new client for Documents
| Parameter | |
|---|---|
| Name | Description |
channel | ChannelBaseThe channel to use to make remote calls. |
DocumentsClient(ClientBaseConfiguration)
protected DocumentsClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CreateDocument(CreateDocumentRequest, CallOptions)
public virtual Operation CreateDocument(CreateDocumentRequest request, CallOptions options)Creates a new document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | CreateDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
CreateDocument(CreateDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateDocument(CreateDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | CreateDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
CreateDocumentAsync(CreateDocumentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateDocumentAsync(CreateDocumentRequest request, CallOptions options)Creates a new document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | CreateDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
CreateDocumentAsync(CreateDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateDocumentAsync(CreateDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | CreateDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | 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. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
OperationsOperationsClient | A new Operations client for the same target as this client. |
DeleteDocument(DeleteDocumentRequest, CallOptions)
public virtual Operation DeleteDocument(DeleteDocumentRequest request, CallOptions options)Deletes the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: An Empty message
| Parameters | |
|---|---|
| Name | Description |
request | DeleteDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
DeleteDocument(DeleteDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteDocument(DeleteDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: An Empty message
| Parameters | |
|---|---|
| Name | Description |
request | DeleteDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
DeleteDocumentAsync(DeleteDocumentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteDocumentAsync(DeleteDocumentRequest request, CallOptions options)Deletes the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: An Empty message
| Parameters | |
|---|---|
| Name | Description |
request | DeleteDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
DeleteDocumentAsync(DeleteDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteDocumentAsync(DeleteDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: An Empty message
| Parameters | |
|---|---|
| Name | Description |
request | DeleteDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
ExportDocument(ExportDocumentRequest, CallOptions)
public virtual Operation ExportDocument(ExportDocumentRequest request, CallOptions options)Exports a smart messaging candidate document into the specified destination.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ExportDocument(ExportDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ExportDocument(ExportDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Exports a smart messaging candidate document into the specified destination.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ExportDocumentAsync(ExportDocumentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ExportDocumentAsync(ExportDocumentRequest request, CallOptions options)Exports a smart messaging candidate document into the specified destination.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
ExportDocumentAsync(ExportDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ExportDocumentAsync(ExportDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Exports a smart messaging candidate document into the specified destination.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
GetDocument(GetDocumentRequest, CallOptions)
public virtual Document GetDocument(GetDocumentRequest request, CallOptions options)Retrieves the specified document.
| Parameters | |
|---|---|
| Name | Description |
request | GetDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Document | The response received from the server. |
GetDocument(GetDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual Document GetDocument(GetDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified document.
| Parameters | |
|---|---|
| Name | Description |
request | GetDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Document | The response received from the server. |
GetDocumentAsync(GetDocumentRequest, CallOptions)
public virtual AsyncUnaryCall<Document> GetDocumentAsync(GetDocumentRequest request, CallOptions options)Retrieves the specified document.
| Parameters | |
|---|---|
| Name | Description |
request | GetDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDocument | The call object. |
GetDocumentAsync(GetDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Document> GetDocumentAsync(GetDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified document.
| Parameters | |
|---|---|
| Name | Description |
request | GetDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDocument | The call object. |
ImportDocuments(ImportDocumentsRequest, CallOptions)
public virtual Operation ImportDocuments(ImportDocumentsRequest request, CallOptions options)Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ImportDocuments(ImportDocumentsRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ImportDocuments(ImportDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ImportDocumentsAsync(ImportDocumentsRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ImportDocumentsAsync(ImportDocumentsRequest request, CallOptions options)Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
ImportDocumentsAsync(ImportDocumentsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ImportDocumentsAsync(ImportDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
ListDocuments(ListDocumentsRequest, CallOptions)
public virtual ListDocumentsResponse ListDocuments(ListDocumentsRequest request, CallOptions options)Returns the list of all documents of the knowledge base.
| Parameters | |
|---|---|
| Name | Description |
request | ListDocumentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListDocumentsResponse | The response received from the server. |
ListDocuments(ListDocumentsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListDocumentsResponse ListDocuments(ListDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns the list of all documents of the knowledge base.
| Parameters | |
|---|---|
| Name | Description |
request | ListDocumentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListDocumentsResponse | The response received from the server. |
ListDocumentsAsync(ListDocumentsRequest, CallOptions)
public virtual AsyncUnaryCall<ListDocumentsResponse> ListDocumentsAsync(ListDocumentsRequest request, CallOptions options)Returns the list of all documents of the knowledge base.
| Parameters | |
|---|---|
| Name | Description |
request | ListDocumentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListDocumentsResponse | The call object. |
ListDocumentsAsync(ListDocumentsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListDocumentsResponse> ListDocumentsAsync(ListDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns the list of all documents of the knowledge base.
| Parameters | |
|---|---|
| Name | Description |
request | ListDocumentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListDocumentsResponse | The call object. |
NewInstance(ClientBaseConfiguration)
protected override Documents.DocumentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
DocumentsDocumentsClient | |
ReloadDocument(ReloadDocumentRequest, CallOptions)
public virtual Operation ReloadDocument(ReloadDocumentRequest request, CallOptions options)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.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request | ReloadDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ReloadDocument(ReloadDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ReloadDocument(ReloadDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request | ReloadDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ReloadDocumentAsync(ReloadDocumentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ReloadDocumentAsync(ReloadDocumentRequest request, CallOptions options)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.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request | ReloadDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
ReloadDocumentAsync(ReloadDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ReloadDocumentAsync(ReloadDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request | ReloadDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
UpdateDocument(UpdateDocumentRequest, CallOptions)
public virtual Operation UpdateDocument(UpdateDocumentRequest request, CallOptions options)Updates the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
UpdateDocument(UpdateDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateDocument(UpdateDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
UpdateDocumentAsync(UpdateDocumentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateDocumentAsync(UpdateDocumentRequest request, CallOptions options)Updates the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDocumentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |
UpdateDocumentAsync(UpdateDocumentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateDocumentAsync(UpdateDocumentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDocumentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation | The call object. |