Class DocumentServiceClient (2.28.0)

Service for ingesting Document information of the customer's website.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

DocumentServiceClient(DocumentServiceClient const &)

Copy and move support

Parameter
Name Description
DocumentServiceClient const &

DocumentServiceClient(DocumentServiceClient &&)

Copy and move support

Parameter
Name Description
DocumentServiceClient &&

DocumentServiceClient(std::shared_ptr< DocumentServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< DocumentServiceConnection >
opts Options

Operators

operator=(DocumentServiceClient const &)

Copy and move support

Parameter
Name Description
DocumentServiceClient const &
Returns
Type Description
DocumentServiceClient &

operator=(DocumentServiceClient &&)

Copy and move support

Parameter
Name Description
DocumentServiceClient &&
Returns
Type Description
DocumentServiceClient &

Functions

GetDocument(std::string const &, Options)

Gets a Document.

Parameters
Name Description
name std::string const &

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.
If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document does not exist, a NOT_FOUND error is returned.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::discoveryengine::v1::Document >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.Document) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDocument(google::cloud::discoveryengine::v1::GetDocumentRequest const &, Options)

Gets a Document.

Parameters
Name Description
request google::cloud::discoveryengine::v1::GetDocumentRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.GetDocumentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::discoveryengine::v1::Document >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.Document) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListDocuments(std::string const &, Options)

Gets a list of Documents.

Parameters
Name Description
parent std::string const &

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch.
If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::discoveryengine::v1::Document >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.discoveryengine.v1.Document, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDocuments(google::cloud::discoveryengine::v1::ListDocumentsRequest, Options)

Gets a list of Documents.

Parameters
Name Description
request google::cloud::discoveryengine::v1::ListDocumentsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.ListDocumentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::discoveryengine::v1::Document >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.discoveryengine.v1.Document, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateDocument(std::string const &, google::cloud::discoveryengine::v1::Document const &, std::string const &, Options)

Creates a Document.

Parameters
Name Description
parent std::string const &

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

document google::cloud::discoveryengine::v1::Document const &

Required. The Document to create.

document_id std::string const &

Required. The ID to use for the Document, which becomes the final component of the Document.name.
If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned.
This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::discoveryengine::v1::Document >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.Document) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateDocument(google::cloud::discoveryengine::v1::CreateDocumentRequest const &, Options)

Creates a Document.

Parameters
Name Description
request google::cloud::discoveryengine::v1::CreateDocumentRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.CreateDocumentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::discoveryengine::v1::Document >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.Document) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDocument(google::cloud::discoveryengine::v1::Document const &, google::protobuf::FieldMask const &, Options)

Updates a Document.

Parameters
Name Description
document google::cloud::discoveryengine::v1::Document const &

Required. The document to update/create.
If the caller does not have permission to update the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

update_mask google::protobuf::FieldMask const &

Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::discoveryengine::v1::Document >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.Document) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDocument(google::cloud::discoveryengine::v1::UpdateDocumentRequest const &, Options)

Updates a Document.

Parameters
Name Description
request google::cloud::discoveryengine::v1::UpdateDocumentRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.UpdateDocumentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::discoveryengine::v1::Document >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.Document) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteDocument(std::string const &, Options)

Deletes a Document.

Parameters
Name Description
name std::string const &

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.
If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
If the Document to delete does not exist, a NOT_FOUND error is returned.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteDocument(google::cloud::discoveryengine::v1::DeleteDocumentRequest const &, Options)

Deletes a Document.

Parameters
Name Description
request google::cloud::discoveryengine::v1::DeleteDocumentRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.DeleteDocumentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

ImportDocuments(google::cloud::discoveryengine::v1::ImportDocumentsRequest const &, Options)

Bulk import of multiple Documents.

Request processing may be synchronous. Non-existing items are created.

Note: It is possible for a subset of the Documents to be successfully updated.

Parameters
Name Description
request google::cloud::discoveryengine::v1::ImportDocumentsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.ImportDocumentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::discoveryengine::v1::ImportDocumentsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.ImportDocumentsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportDocuments(NoAwaitTag, google::cloud::discoveryengine::v1::ImportDocumentsRequest const &, Options)

Bulk import of multiple Documents.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::discoveryengine::v1::ImportDocumentsRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ImportDocuments(google::longrunning::Operation const &, Options)

Bulk import of multiple Documents.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::discoveryengine::v1::ImportDocumentsResponse > >

PurgeDocuments(google::cloud::discoveryengine::v1::PurgeDocumentsRequest const &, Options)

Permanently deletes all selected Documents in a branch.

This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments.

To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.

Parameters
Name Description
request google::cloud::discoveryengine::v1::PurgeDocumentsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.PurgeDocumentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::discoveryengine::v1::PurgeDocumentsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.PurgeDocumentsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PurgeDocuments(NoAwaitTag, google::cloud::discoveryengine::v1::PurgeDocumentsRequest const &, Options)

Permanently deletes all selected Documents in a branch.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::discoveryengine::v1::PurgeDocumentsRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

PurgeDocuments(google::longrunning::Operation const &, Options)

Permanently deletes all selected Documents in a branch.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::discoveryengine::v1::PurgeDocumentsResponse > >