Class DocumentLinkServiceClient (2.23.0)

This service lets you manage document-links.

Document-Links are treated as sub-resources under source documents.

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

DocumentLinkServiceClient(DocumentLinkServiceClient const &)

Copy and move support

Parameter
Name Description
DocumentLinkServiceClient const &

DocumentLinkServiceClient(DocumentLinkServiceClient &&)

Copy and move support

Parameter
Name Description
DocumentLinkServiceClient &&

DocumentLinkServiceClient(std::shared_ptr< DocumentLinkServiceConnection >, Options)

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

Operators

operator=(DocumentLinkServiceClient const &)

Copy and move support

Parameter
Name Description
DocumentLinkServiceClient const &
Returns
Type Description
DocumentLinkServiceClient &

operator=(DocumentLinkServiceClient &&)

Copy and move support

Parameter
Name Description
DocumentLinkServiceClient &&
Returns
Type Description
DocumentLinkServiceClient &

Functions

ListLinkedTargets(std::string const &, Options)

Return all target document-links from the document.

Parameters
Name Description
parent std::string const &

Required. The name of the document, for which all target links are returned. Format: projects/{project_number}/locations/{location}/documents/{target_document_id}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contentwarehouse::v1::ListLinkedTargetsResponse >

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

ListLinkedTargets(google::cloud::contentwarehouse::v1::ListLinkedTargetsRequest const &, Options)

Return all target document-links from the document.

Parameters
Name Description
request google::cloud::contentwarehouse::v1::ListLinkedTargetsRequest 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.contentwarehouse.v1.ListLinkedTargetsRequest. 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::contentwarehouse::v1::ListLinkedTargetsResponse >

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

ListLinkedSources(std::string const &, Options)

Return all source document-links from the document.

Parameters
Name Description
parent std::string const &

Required. The name of the document, for which all source links are returned. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::contentwarehouse::v1::DocumentLink >

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.contentwarehouse.v1.DocumentLink, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListLinkedSources(google::cloud::contentwarehouse::v1::ListLinkedSourcesRequest, Options)

Return all source document-links from the document.

Parameters
Name Description
request google::cloud::contentwarehouse::v1::ListLinkedSourcesRequest

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.contentwarehouse.v1.ListLinkedSourcesRequest. 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::contentwarehouse::v1::DocumentLink >

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.contentwarehouse.v1.DocumentLink, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateDocumentLink(std::string const &, google::cloud::contentwarehouse::v1::DocumentLink const &, Options)

Create a link between a source document and a target document.

Parameters
Name Description
parent std::string const &

Required. Parent of the document-link to be created. parent of document-link should be a document. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}.

document_link google::cloud::contentwarehouse::v1::DocumentLink const &

Required. Document links associated with the source documents (source_document_id).

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contentwarehouse::v1::DocumentLink >

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

CreateDocumentLink(google::cloud::contentwarehouse::v1::CreateDocumentLinkRequest const &, Options)

Create a link between a source document and a target document.

Parameters
Name Description
request google::cloud::contentwarehouse::v1::CreateDocumentLinkRequest 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.contentwarehouse.v1.CreateDocumentLinkRequest. 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::contentwarehouse::v1::DocumentLink >

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

DeleteDocumentLink(std::string const &, Options)

Remove the link between the source and target documents.

Parameters
Name Description
name std::string const &

Required. The name of the document-link to be deleted. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.

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.

DeleteDocumentLink(google::cloud::contentwarehouse::v1::DeleteDocumentLinkRequest const &, Options)

Remove the link between the source and target documents.

Parameters
Name Description
request google::cloud::contentwarehouse::v1::DeleteDocumentLinkRequest 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.contentwarehouse.v1.DeleteDocumentLinkRequest. 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.