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.
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.
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.
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.
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.
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.
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.
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}.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis page details the \u003ccode\u003eDocumentLinkServiceClient\u003c/code\u003e for managing document links, which are treated as sub-resources of source documents.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the service is \u003ccode\u003e2.37.0-rc\u003c/code\u003e, but you can access documentation for versions ranging from \u003ccode\u003e2.12.0\u003c/code\u003e to \u003ccode\u003e2.36.0\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentLinkServiceClient\u003c/code\u003e allows you to create, list, and delete document links, managing both target and source links.\u003c/p\u003e\n"],["\u003cp\u003eConcurrent access to different instances of the class is safe, but using the same instance from multiple threads is not guaranteed to work, thus copies are suggested for multi-threaded use.\u003c/p\u003e\n"],["\u003cp\u003eThis class has copy and move support for both contruction and assignment, and also has different functions such as: \u003ccode\u003eListLinkedTargets\u003c/code\u003e \u003ccode\u003eListLinkedSources\u003c/code\u003e \u003ccode\u003eCreateDocumentLink\u003c/code\u003e and \u003ccode\u003eDeleteDocumentLink\u003c/code\u003e which can be used to interact with document-links.\u003c/p\u003e\n"]]],[],null,["# Class DocumentLinkServiceClient (2.28.0)\n\nVersion 2.28.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/contentwarehouse/latest/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.41.0](/cpp/docs/reference/contentwarehouse/2.41.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.40.0](/cpp/docs/reference/contentwarehouse/2.40.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.39.0](/cpp/docs/reference/contentwarehouse/2.39.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.38.0](/cpp/docs/reference/contentwarehouse/2.38.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.37.0](/cpp/docs/reference/contentwarehouse/2.37.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.36.0](/cpp/docs/reference/contentwarehouse/2.36.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.35.0](/cpp/docs/reference/contentwarehouse/2.35.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.34.0](/cpp/docs/reference/contentwarehouse/2.34.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.33.0](/cpp/docs/reference/contentwarehouse/2.33.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.32.0](/cpp/docs/reference/contentwarehouse/2.32.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.31.0](/cpp/docs/reference/contentwarehouse/2.31.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.30.0](/cpp/docs/reference/contentwarehouse/2.30.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.29.0](/cpp/docs/reference/contentwarehouse/2.29.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.28.0](/cpp/docs/reference/contentwarehouse/2.28.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.27.0](/cpp/docs/reference/contentwarehouse/2.27.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.26.0](/cpp/docs/reference/contentwarehouse/2.26.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.25.1](/cpp/docs/reference/contentwarehouse/2.25.1/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.24.0](/cpp/docs/reference/contentwarehouse/2.24.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.23.0](/cpp/docs/reference/contentwarehouse/2.23.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.22.1](/cpp/docs/reference/contentwarehouse/2.22.1/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.21.0](/cpp/docs/reference/contentwarehouse/2.21.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.20.0](/cpp/docs/reference/contentwarehouse/2.20.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.19.0](/cpp/docs/reference/contentwarehouse/2.19.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.18.0](/cpp/docs/reference/contentwarehouse/2.18.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.17.0](/cpp/docs/reference/contentwarehouse/2.17.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.16.0](/cpp/docs/reference/contentwarehouse/2.16.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.15.1](/cpp/docs/reference/contentwarehouse/2.15.1/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.14.0](/cpp/docs/reference/contentwarehouse/2.14.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.13.0](/cpp/docs/reference/contentwarehouse/2.13.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient)\n- [2.12.0](/cpp/docs/reference/contentwarehouse/2.12.0/classgoogle_1_1cloud_1_1contentwarehouse__v1_1_1DocumentLinkServiceClient) \nThis service lets you manage document-links. \nDocument-Links are treated as sub-resources under source documents.\n\n###### Equality\n\nInstances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal `std::shared_ptr\u003c*Connection\u003e` objects compare equal. Objects that compare equal share the same underlying resources.\n\n###### Performance\n\nCreating 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.\n\n###### Thread Safety\n\nConcurrent 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.\n\nConstructors\n------------\n\n### DocumentLinkServiceClient(DocumentLinkServiceClient const \\&)\n\nCopy and move support\n\n### DocumentLinkServiceClient(DocumentLinkServiceClient \\&\\&)\n\nCopy and move support\n\n### DocumentLinkServiceClient(std::shared_ptr\\\u003c DocumentLinkServiceConnection \\\u003e, Options)\n\nOperators\n---------\n\n### operator=(DocumentLinkServiceClient const \\&)\n\nCopy and move support\n\n### operator=(DocumentLinkServiceClient \\&\\&)\n\nCopy and move support\n\nFunctions\n---------\n\n### ListLinkedTargets(std::string const \\&, Options)\n\nReturn all target document-links from the document.\n\n### ListLinkedTargets(google::cloud::contentwarehouse::v1::ListLinkedTargetsRequest const \\&, Options)\n\nReturn all target document-links from the document.\n\n### ListLinkedSources(std::string const \\&, Options)\n\nReturn all source document-links from the document.\n\n### ListLinkedSources(google::cloud::contentwarehouse::v1::ListLinkedSourcesRequest, Options)\n\nReturn all source document-links from the document.\n\n### CreateDocumentLink(std::string const \\&, google::cloud::contentwarehouse::v1::DocumentLink const \\&, Options)\n\nCreate a link between a source document and a target document.\n\n### CreateDocumentLink(google::cloud::contentwarehouse::v1::CreateDocumentLinkRequest const \\&, Options)\n\nCreate a link between a source document and a target document.\n\n### DeleteDocumentLink(std::string const \\&, Options)\n\nRemove the link between the source and target documents.\n\n### DeleteDocumentLink(google::cloud::contentwarehouse::v1::DeleteDocumentLinkRequest const \\&, Options)\n\nRemove the link between the source and target documents."]]
