Class Documents.DocumentsClient (3.9.0)

Version 3.9.0

• 4.22.0 (latest)
• 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 class DocumentsClient : ClientBase<Documents.DocumentsClient>

Client for Documents

Inheritance

Object > ClientBase > ClientBase<Documents.DocumentsClient> > Documents.DocumentsClient

Inherited Members

ClientBase<Documents.DocumentsClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

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	CallInvoker The callInvoker to use to make remote calls.

DocumentsClient(ChannelBase)

public DocumentsClient(ChannelBase channel)

Creates a new client for Documents

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

DocumentsClient(ClientBase.ClientBaseConfiguration)

protected DocumentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The 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	CreateDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateDocument(CreateDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateDocument(CreateDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	CreateDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
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	CreateDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateDocumentAsync(CreateDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateDocumentAsync(CreateDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	CreateDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
Operations.OperationsClient	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	DeleteDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteDocument(DeleteDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteDocument(DeleteDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	DeleteDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
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	DeleteDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

DeleteDocumentAsync(DeleteDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteDocumentAsync(DeleteDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	DeleteDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	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	ExportDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportDocument(ExportDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ExportDocument(ExportDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	ExportDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
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	ExportDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

ExportDocumentAsync(ExportDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportDocumentAsync(ExportDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	ExportDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

GetDocument(GetDocumentRequest, CallOptions)

public virtual Document GetDocument(GetDocumentRequest request, CallOptions options)

Retrieves the specified document.

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

Returns
Type	Description
Document	The response received from the server.

GetDocument(GetDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves the specified document.

Parameters
Name	Description
request	GetDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
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	GetDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Document>	The call object.

GetDocumentAsync(GetDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves the specified document.

Parameters
Name	Description
request	GetDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Document>	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	ListDocumentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDocumentsResponse	The response received from the server.

ListDocuments(ListDocumentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListDocumentsResponse ListDocuments(ListDocumentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all documents of the knowledge base.

Parameters
Name	Description
request	ListDocumentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
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	ListDocumentsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<ListDocumentsResponse>	The call object.

ListDocumentsAsync(ListDocumentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListDocumentsResponse> ListDocumentsAsync(ListDocumentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all documents of the knowledge base.

Parameters
Name	Description
request	ListDocumentsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<ListDocumentsResponse>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Documents.DocumentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
Documents.DocumentsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.V2.Documents.DocumentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

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	ReloadDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ReloadDocument(ReloadDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ReloadDocument(ReloadDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	ReloadDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
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	ReloadDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

ReloadDocumentAsync(ReloadDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ReloadDocumentAsync(ReloadDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	ReloadDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	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	UpdateDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateDocument(UpdateDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateDocument(UpdateDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	UpdateDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
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	UpdateDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

UpdateDocumentAsync(UpdateDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateDocumentAsync(UpdateDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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	UpdateDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.