Discovery Engine v1 API - Class DocumentService.DocumentServiceClient (1.0.0-beta06)

Version 1.0.0-beta06

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public class DocumentService.DocumentServiceClient : ClientBase<DocumentService.DocumentServiceClient>

Reference documentation and code samples for the Discovery Engine v1 API class DocumentService.DocumentServiceClient.

Client for DocumentService

Inheritance

object > ClientBase > ClientBaseDocumentServiceDocumentServiceClient > DocumentService.DocumentServiceClient

Inherited Members

ClientBase<DocumentService.DocumentServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

DocumentServiceClient()

protected DocumentServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DocumentServiceClient(CallInvoker)

public DocumentServiceClient(CallInvoker callInvoker)

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

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

DocumentServiceClient(ChannelBase)

public DocumentServiceClient(ChannelBase channel)

Creates a new client for DocumentService

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

DocumentServiceClient(ClientBaseConfiguration)

protected DocumentServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateDocument(CreateDocumentRequest, CallOptions)

public virtual Document CreateDocument(CreateDocumentRequest request, CallOptions options)

Creates a [Document][google.cloud.discoveryengine.v1.Document].

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

Returns
Type	Description
Document	The response received from the server.

CreateDocument(CreateDocumentRequest, Metadata, DateTime?, CancellationToken)

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

Creates a [Document][google.cloud.discoveryengine.v1.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	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.

CreateDocumentAsync(CreateDocumentRequest, CallOptions)

public virtual AsyncUnaryCall<Document> CreateDocumentAsync(CreateDocumentRequest request, CallOptions options)

Creates a [Document][google.cloud.discoveryengine.v1.Document].

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

Returns
Type	Description
AsyncUnaryCallDocument	The call object.

CreateDocumentAsync(CreateDocumentRequest, Metadata, DateTime?, CancellationToken)

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

Creates a [Document][google.cloud.discoveryengine.v1.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	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
AsyncUnaryCallDocument	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 Empty DeleteDocument(DeleteDocumentRequest request, CallOptions options)

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

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

Returns
Type	Description
Empty	The response received from the server.

DeleteDocument(DeleteDocumentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

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	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.

DeleteDocumentAsync(DeleteDocumentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteDocumentAsync(DeleteDocumentRequest request, CallOptions options)

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

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

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteDocumentAsync(DeleteDocumentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a [Document][google.cloud.discoveryengine.v1.Document].

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	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.

GetDocument(GetDocumentRequest, CallOptions)

public virtual Document GetDocument(GetDocumentRequest request, CallOptions options)

Gets a [Document][google.cloud.discoveryengine.v1.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, DateTime?, CancellationToken)

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

Gets a [Document][google.cloud.discoveryengine.v1.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	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)

Gets a [Document][google.cloud.discoveryengine.v1.Document].

Parameters
Name	Description
request	GetDocumentRequest The request to send to the server.
options	CallOptions The 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)

Gets a [Document][google.cloud.discoveryengine.v1.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	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
AsyncUnaryCallDocument	The call object.

ImportDocuments(ImportDocumentsRequest, CallOptions)

public virtual Operation ImportDocuments(ImportDocumentsRequest request, CallOptions options)

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items will be created.

Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.

Parameters
Name	Description
request	ImportDocumentsRequest The request to send to the server.
options	CallOptions The 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)

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items will be created.

Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.

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

ImportDocumentsAsync(ImportDocumentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportDocumentsAsync(ImportDocumentsRequest request, CallOptions options)

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items will be created.

Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.

Parameters
Name	Description
request	ImportDocumentsRequest The request to send to the server.
options	CallOptions The 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)

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items will be created.

Note: It is possible for a subset of the [Document][google.cloud.discoveryengine.v1.Document]s to be successfully updated.

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

ListDocuments(ListDocumentsRequest, CallOptions)

public virtual ListDocumentsResponse ListDocuments(ListDocumentsRequest request, CallOptions options)

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

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, DateTime?, CancellationToken)

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

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

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	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)

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

Parameters
Name	Description
request	ListDocumentsRequest The request to send to the server.
options	CallOptions The 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)

Gets a list of [Document][google.cloud.discoveryengine.v1.Document]s.

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	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
AsyncUnaryCallListDocumentsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override DocumentService.DocumentServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DocumentServiceDocumentServiceClient

Overrides

ClientBase<DocumentService.DocumentServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

PurgeDocuments(PurgeDocumentsRequest, CallOptions)

public virtual Operation PurgeDocuments(PurgeDocumentsRequest request, CallOptions options)

Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.

This process is asynchronous. Depending on the number of [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this operation can take hours to complete. Before the delete operation completes, some [Document][google.cloud.discoveryengine.v1.Document]s might still be returned by [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].

To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.

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

Returns
Type	Description
Operation	The response received from the server.

PurgeDocuments(PurgeDocumentsRequest, Metadata, DateTime?, CancellationToken)

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

Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.

This process is asynchronous. Depending on the number of [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this operation can take hours to complete. Before the delete operation completes, some [Document][google.cloud.discoveryengine.v1.Document]s might still be returned by [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].

To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.

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

PurgeDocumentsAsync(PurgeDocumentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PurgeDocumentsAsync(PurgeDocumentsRequest request, CallOptions options)

Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.

This process is asynchronous. Depending on the number of [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this operation can take hours to complete. Before the delete operation completes, some [Document][google.cloud.discoveryengine.v1.Document]s might still be returned by [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].

To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PurgeDocumentsAsync(PurgeDocumentsRequest, Metadata, DateTime?, CancellationToken)

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

Permanently deletes all selected [Document][google.cloud.discoveryengine.v1.Document]s in a branch.

This process is asynchronous. Depending on the number of [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this operation can take hours to complete. Before the delete operation completes, some [Document][google.cloud.discoveryengine.v1.Document]s might still be returned by [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].

To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s to be deleted, set [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] to false.

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

UpdateDocument(UpdateDocumentRequest, CallOptions)

public virtual Document UpdateDocument(UpdateDocumentRequest request, CallOptions options)

Updates a [Document][google.cloud.discoveryengine.v1.Document].

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

Returns
Type	Description
Document	The response received from the server.

UpdateDocument(UpdateDocumentRequest, Metadata, DateTime?, CancellationToken)

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

Updates a [Document][google.cloud.discoveryengine.v1.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	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.

UpdateDocumentAsync(UpdateDocumentRequest, CallOptions)

public virtual AsyncUnaryCall<Document> UpdateDocumentAsync(UpdateDocumentRequest request, CallOptions options)

Updates a [Document][google.cloud.discoveryengine.v1.Document].

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

Returns
Type	Description
AsyncUnaryCallDocument	The call object.

UpdateDocumentAsync(UpdateDocumentRequest, Metadata, DateTime?, CancellationToken)

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

Updates a [Document][google.cloud.discoveryengine.v1.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	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
AsyncUnaryCallDocument	The call object.