Discovery Engine v1 API - Class DocumentServiceClientImpl (1.5.0)

Version 1.5.0

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

public sealed class DocumentServiceClientImpl : DocumentServiceClient

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

DocumentService client wrapper implementation, for convenient use.

Inheritance

object > DocumentServiceClient > DocumentServiceClientImpl

Inherited Members

DocumentServiceClient.DefaultEndpoint

DocumentServiceClient.DefaultScopes

DocumentServiceClient.ServiceMetadata

DocumentServiceClient.CreateAsync(CancellationToken)

DocumentServiceClient.Create()

DocumentServiceClient.ShutdownDefaultChannelsAsync()

DocumentServiceClient.GetDocumentAsync(GetDocumentRequest, CancellationToken)

DocumentServiceClient.GetDocument(string, CallSettings)

DocumentServiceClient.GetDocumentAsync(string, CallSettings)

DocumentServiceClient.GetDocumentAsync(string, CancellationToken)

DocumentServiceClient.GetDocument(DocumentName, CallSettings)

DocumentServiceClient.GetDocumentAsync(DocumentName, CallSettings)

DocumentServiceClient.GetDocumentAsync(DocumentName, CancellationToken)

DocumentServiceClient.ListDocuments(string, string, int?, CallSettings)

DocumentServiceClient.ListDocumentsAsync(string, string, int?, CallSettings)

DocumentServiceClient.ListDocuments(BranchName, string, int?, CallSettings)

DocumentServiceClient.ListDocumentsAsync(BranchName, string, int?, CallSettings)

DocumentServiceClient.CreateDocumentAsync(CreateDocumentRequest, CancellationToken)

DocumentServiceClient.CreateDocument(string, Document, string, CallSettings)

DocumentServiceClient.CreateDocumentAsync(string, Document, string, CallSettings)

DocumentServiceClient.CreateDocumentAsync(string, Document, string, CancellationToken)

DocumentServiceClient.CreateDocument(BranchName, Document, string, CallSettings)

DocumentServiceClient.CreateDocumentAsync(BranchName, Document, string, CallSettings)

DocumentServiceClient.CreateDocumentAsync(BranchName, Document, string, CancellationToken)

DocumentServiceClient.UpdateDocumentAsync(UpdateDocumentRequest, CancellationToken)

DocumentServiceClient.UpdateDocument(Document, FieldMask, CallSettings)

DocumentServiceClient.UpdateDocumentAsync(Document, FieldMask, CallSettings)

DocumentServiceClient.UpdateDocumentAsync(Document, FieldMask, CancellationToken)

DocumentServiceClient.DeleteDocumentAsync(DeleteDocumentRequest, CancellationToken)

DocumentServiceClient.DeleteDocument(string, CallSettings)

DocumentServiceClient.DeleteDocumentAsync(string, CallSettings)

DocumentServiceClient.DeleteDocumentAsync(string, CancellationToken)

DocumentServiceClient.DeleteDocument(DocumentName, CallSettings)

DocumentServiceClient.DeleteDocumentAsync(DocumentName, CallSettings)

DocumentServiceClient.DeleteDocumentAsync(DocumentName, CancellationToken)

DocumentServiceClient.ImportDocumentsAsync(ImportDocumentsRequest, CancellationToken)

DocumentServiceClient.PollOnceImportDocuments(string, CallSettings)

DocumentServiceClient.PollOnceImportDocumentsAsync(string, CallSettings)

DocumentServiceClient.PurgeDocumentsAsync(PurgeDocumentsRequest, CancellationToken)

DocumentServiceClient.PollOncePurgeDocuments(string, CallSettings)

DocumentServiceClient.PollOncePurgeDocumentsAsync(string, CallSettings)

DocumentServiceClient.BatchGetDocumentsMetadataAsync(BatchGetDocumentsMetadataRequest, CancellationToken)

DocumentServiceClient.BatchGetDocumentsMetadata(string, CallSettings)

DocumentServiceClient.BatchGetDocumentsMetadataAsync(string, CallSettings)

DocumentServiceClient.BatchGetDocumentsMetadataAsync(string, CancellationToken)

DocumentServiceClient.BatchGetDocumentsMetadata(BranchName, CallSettings)

DocumentServiceClient.BatchGetDocumentsMetadataAsync(BranchName, CallSettings)

DocumentServiceClient.BatchGetDocumentsMetadataAsync(BranchName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for ingesting [Document][google.cloud.discoveryengine.v1.Document] information of the customer's website.

Constructors

DocumentServiceClientImpl(DocumentServiceClient, DocumentServiceSettings, ILogger)

public DocumentServiceClientImpl(DocumentService.DocumentServiceClient grpcClient, DocumentServiceSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	DocumentServiceDocumentServiceClient The underlying gRPC client.
settings	DocumentServiceSettings The base DocumentServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override DocumentService.DocumentServiceClient GrpcClient { get; }

The underlying gRPC DocumentService client

Property Value
Type	Description
DocumentServiceDocumentServiceClient

Overrides

DocumentServiceClient.GrpcClient

ImportDocumentsOperationsClient

public override OperationsClient ImportDocumentsOperationsClient { get; }

The long-running operations client for ImportDocuments.

Property Value
Type	Description
OperationsClient

Overrides

DocumentServiceClient.ImportDocumentsOperationsClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

DocumentServiceClient.LocationsClient

PurgeDocumentsOperationsClient

public override OperationsClient PurgeDocumentsOperationsClient { get; }

The long-running operations client for PurgeDocuments.

Property Value
Type	Description
OperationsClient

Overrides

DocumentServiceClient.PurgeDocumentsOperationsClient

Methods

BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest, CallSettings)

public override BatchGetDocumentsMetadataResponse BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request, CallSettings callSettings = null)

Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s. Supported for website search only.

Parameters
Name	Description
request	BatchGetDocumentsMetadataRequest 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
BatchGetDocumentsMetadataResponse	The RPC response.

Overrides

DocumentServiceClient.BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest, CallSettings)

BatchGetDocumentsMetadataAsync(BatchGetDocumentsMetadataRequest, CallSettings)

public override Task<BatchGetDocumentsMetadataResponse> BatchGetDocumentsMetadataAsync(BatchGetDocumentsMetadataRequest request, CallSettings callSettings = null)

Gets index freshness metadata for [Document][google.cloud.discoveryengine.v1.Document]s. Supported for website search only.

Parameters
Name	Description
request	BatchGetDocumentsMetadataRequest 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
TaskBatchGetDocumentsMetadataResponse	A Task containing the RPC response.

Overrides

DocumentServiceClient.BatchGetDocumentsMetadataAsync(BatchGetDocumentsMetadataRequest, CallSettings)

CreateDocument(CreateDocumentRequest, CallSettings)

public override Document CreateDocument(CreateDocumentRequest request, CallSettings callSettings = null)

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

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
Document	The RPC response.

Overrides

DocumentServiceClient.CreateDocument(CreateDocumentRequest, CallSettings)

CreateDocumentAsync(CreateDocumentRequest, CallSettings)

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

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

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
TaskDocument	A Task containing the RPC response.

Overrides

DocumentServiceClient.CreateDocumentAsync(CreateDocumentRequest, CallSettings)

DeleteDocument(DeleteDocumentRequest, CallSettings)

public override void DeleteDocument(DeleteDocumentRequest request, CallSettings callSettings = null)

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

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.

Overrides

DocumentServiceClient.DeleteDocument(DeleteDocumentRequest, CallSettings)

DeleteDocumentAsync(DeleteDocumentRequest, CallSettings)

public override Task DeleteDocumentAsync(DeleteDocumentRequest request, CallSettings callSettings = null)

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

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	A Task containing the RPC response.

Overrides

DocumentServiceClient.DeleteDocumentAsync(DeleteDocumentRequest, CallSettings)

GetDocument(GetDocumentRequest, CallSettings)

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

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

DocumentServiceClient.GetDocument(GetDocumentRequest, CallSettings)

GetDocumentAsync(GetDocumentRequest, CallSettings)

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

Gets a [Document][google.cloud.discoveryengine.v1.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
TaskDocument	A Task containing the RPC response.

Overrides

DocumentServiceClient.GetDocumentAsync(GetDocumentRequest, CallSettings)

ImportDocuments(ImportDocumentsRequest, CallSettings)

public override Operation<ImportDocumentsResponse, ImportDocumentsMetadata> ImportDocuments(ImportDocumentsRequest request, CallSettings callSettings = null)

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items are 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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationImportDocumentsResponseImportDocumentsMetadata	The RPC response.

Overrides

DocumentServiceClient.ImportDocuments(ImportDocumentsRequest, CallSettings)

ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)

public override Task<Operation<ImportDocumentsResponse, ImportDocumentsMetadata>> ImportDocumentsAsync(ImportDocumentsRequest request, CallSettings callSettings = null)

Bulk import of multiple [Document][google.cloud.discoveryengine.v1.Document]s. Request processing may be synchronous. Non-existing items are 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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationImportDocumentsResponseImportDocumentsMetadata	A Task containing the RPC response.

Overrides

DocumentServiceClient.ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)

ListDocuments(ListDocumentsRequest, CallSettings)

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

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

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
PagedEnumerableListDocumentsResponseDocument	A pageable sequence of Document resources.

Overrides

DocumentServiceClient.ListDocuments(ListDocumentsRequest, CallSettings)

ListDocumentsAsync(ListDocumentsRequest, CallSettings)

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

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

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
PagedAsyncEnumerableListDocumentsResponseDocument	A pageable asynchronous sequence of Document resources.

Overrides

DocumentServiceClient.ListDocumentsAsync(ListDocumentsRequest, CallSettings)

PurgeDocuments(PurgeDocumentsRequest, CallSettings)

public override Operation<PurgeDocumentsResponse, PurgeDocumentsMetadata> PurgeDocuments(PurgeDocumentsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationPurgeDocumentsResponsePurgeDocumentsMetadata	The RPC response.

Overrides

DocumentServiceClient.PurgeDocuments(PurgeDocumentsRequest, CallSettings)

PurgeDocumentsAsync(PurgeDocumentsRequest, CallSettings)

public override Task<Operation<PurgeDocumentsResponse, PurgeDocumentsMetadata>> PurgeDocumentsAsync(PurgeDocumentsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationPurgeDocumentsResponsePurgeDocumentsMetadata	A Task containing the RPC response.

Overrides

DocumentServiceClient.PurgeDocumentsAsync(PurgeDocumentsRequest, CallSettings)

UpdateDocument(UpdateDocumentRequest, CallSettings)

public override Document UpdateDocument(UpdateDocumentRequest request, CallSettings callSettings = null)

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

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
Document	The RPC response.

Overrides

DocumentServiceClient.UpdateDocument(UpdateDocumentRequest, CallSettings)

UpdateDocumentAsync(UpdateDocumentRequest, CallSettings)

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

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

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
TaskDocument	A Task containing the RPC response.

Overrides

DocumentServiceClient.UpdateDocumentAsync(UpdateDocumentRequest, CallSettings)