Class DocumentLinkServiceClient (0.40.0)

GitHub RepositoryProduct Reference

Service Description: This service lets you manage document-links. Document-Links are treated as sub-resources under source documents.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   DocumentName parent =
       DocumentName.ofProjectLocationDocumentName("[PROJECT]", "[LOCATION]", "[DOCUMENT]");
   ListLinkedTargetsResponse response = documentLinkServiceClient.listLinkedTargets(parent);
 }

Note: close() needs to be called on the DocumentLinkServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListLinkedTargets

Return all target document-links from the document.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLinkedTargets(ListLinkedTargetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listLinkedTargets(DocumentName parent)

  • listLinkedTargets(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLinkedTargetsCallable()

ListLinkedSources

Return all source document-links from the document.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLinkedSources(ListLinkedSourcesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listLinkedSources(DocumentName parent)

  • listLinkedSources(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLinkedSourcesPagedCallable()

  • listLinkedSourcesCallable()

CreateDocumentLink

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDocumentLink(CreateDocumentLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDocumentLink(DocumentName parent, DocumentLink documentLink)

  • createDocumentLink(String parent, DocumentLink documentLink)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDocumentLinkCallable()

DeleteDocumentLink

Remove the link between the source and target documents.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDocumentLink(DeleteDocumentLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDocumentLink(DocumentLinkName name)

  • deleteDocumentLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDocumentLinkCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DocumentLinkServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentLinkServiceSettings documentLinkServiceSettings =
     DocumentLinkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentLinkServiceClient documentLinkServiceClient =
     DocumentLinkServiceClient.create(documentLinkServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentLinkServiceSettings documentLinkServiceSettings =
     DocumentLinkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentLinkServiceClient documentLinkServiceClient =
     DocumentLinkServiceClient.create(documentLinkServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentLinkServiceSettings documentLinkServiceSettings =
     DocumentLinkServiceSettings.newHttpJsonBuilder().build();
 DocumentLinkServiceClient documentLinkServiceClient =
     DocumentLinkServiceClient.create(documentLinkServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DocumentLinkServiceClient

Static Methods

create()

public static final DocumentLinkServiceClient create()

Constructs an instance of DocumentLinkServiceClient with default settings.

Returns
Type Description
DocumentLinkServiceClient
Exceptions
Type Description
IOException

create(DocumentLinkServiceSettings settings)

public static final DocumentLinkServiceClient create(DocumentLinkServiceSettings settings)

Constructs an instance of DocumentLinkServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings DocumentLinkServiceSettings
Returns
Type Description
DocumentLinkServiceClient
Exceptions
Type Description
IOException

create(DocumentLinkServiceStub stub)

public static final DocumentLinkServiceClient create(DocumentLinkServiceStub stub)

Constructs an instance of DocumentLinkServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DocumentLinkServiceSettings).

Parameter
Name Description
stub DocumentLinkServiceStub
Returns
Type Description
DocumentLinkServiceClient

Constructors

DocumentLinkServiceClient(DocumentLinkServiceSettings settings)

protected DocumentLinkServiceClient(DocumentLinkServiceSettings settings)

Constructs an instance of DocumentLinkServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings DocumentLinkServiceSettings

DocumentLinkServiceClient(DocumentLinkServiceStub stub)

protected DocumentLinkServiceClient(DocumentLinkServiceStub stub)
Parameter
Name Description
stub DocumentLinkServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createDocumentLink(CreateDocumentLinkRequest request)

public final DocumentLink createDocumentLink(CreateDocumentLinkRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   CreateDocumentLinkRequest request =
       CreateDocumentLinkRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DOCUMENT]")
                   .toString())
           .setDocumentLink(DocumentLink.newBuilder().build())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   DocumentLink response = documentLinkServiceClient.createDocumentLink(request);
 }
Parameter
Name Description
request CreateDocumentLinkRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DocumentLink

createDocumentLink(DocumentName parent, DocumentLink documentLink)

public final DocumentLink createDocumentLink(DocumentName parent, DocumentLink documentLink)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   DocumentName parent =
       DocumentName.ofProjectLocationDocumentName("[PROJECT]", "[LOCATION]", "[DOCUMENT]");
   DocumentLink documentLink = DocumentLink.newBuilder().build();
   DocumentLink response = documentLinkServiceClient.createDocumentLink(parent, documentLink);
 }
Parameters
Name Description
parent DocumentName

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}.
documentLink DocumentLink

Required. Document links associated with the source documents (source_document_id).
Returns
Type Description
DocumentLink

createDocumentLink(String parent, DocumentLink documentLink)

public final DocumentLink createDocumentLink(String parent, DocumentLink documentLink)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   String parent =
       DocumentName.ofProjectLocationDocumentName("[PROJECT]", "[LOCATION]", "[DOCUMENT]")
           .toString();
   DocumentLink documentLink = DocumentLink.newBuilder().build();
   DocumentLink response = documentLinkServiceClient.createDocumentLink(parent, documentLink);
 }
Parameters
Name Description
parent String

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}.
documentLink DocumentLink

Required. Document links associated with the source documents (source_document_id).
Returns
Type Description
DocumentLink

createDocumentLinkCallable()

public final UnaryCallable<CreateDocumentLinkRequest,DocumentLink> createDocumentLinkCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   CreateDocumentLinkRequest request =
       CreateDocumentLinkRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DOCUMENT]")
                   .toString())
           .setDocumentLink(DocumentLink.newBuilder().build())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   ApiFuture<DocumentLink> future =
       documentLinkServiceClient.createDocumentLinkCallable().futureCall(request);
   // Do something.
   DocumentLink response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateDocumentLinkRequest,DocumentLink>

deleteDocumentLink(DeleteDocumentLinkRequest request)

public final void deleteDocumentLink(DeleteDocumentLinkRequest request)

Remove the link between the source and target documents.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   DeleteDocumentLinkRequest request =
       DeleteDocumentLinkRequest.newBuilder()
           .setName(
               DocumentLinkName.of("[PROJECT]", "[LOCATION]", "[DOCUMENT]", "[DOCUMENT_LINK]")
                   .toString())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   documentLinkServiceClient.deleteDocumentLink(request);
 }
Parameter
Name Description
request DeleteDocumentLinkRequest

The request object containing all of the parameters for the API call.

deleteDocumentLink(DocumentLinkName name)

public final void deleteDocumentLink(DocumentLinkName name)

Remove the link between the source and target documents.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   DocumentLinkName name =
       DocumentLinkName.of("[PROJECT]", "[LOCATION]", "[DOCUMENT]", "[DOCUMENT_LINK]");
   documentLinkServiceClient.deleteDocumentLink(name);
 }
Parameter
Name Description
name DocumentLinkName

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

deleteDocumentLink(String name)

public final void deleteDocumentLink(String name)

Remove the link between the source and target documents.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   String name =
       DocumentLinkName.of("[PROJECT]", "[LOCATION]", "[DOCUMENT]", "[DOCUMENT_LINK]")
           .toString();
   documentLinkServiceClient.deleteDocumentLink(name);
 }
Parameter
Name Description
name String

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

deleteDocumentLinkCallable()

public final UnaryCallable<DeleteDocumentLinkRequest,Empty> deleteDocumentLinkCallable()

Remove the link between the source and target documents.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   DeleteDocumentLinkRequest request =
       DeleteDocumentLinkRequest.newBuilder()
           .setName(
               DocumentLinkName.of("[PROJECT]", "[LOCATION]", "[DOCUMENT]", "[DOCUMENT_LINK]")
                   .toString())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   ApiFuture<Empty> future =
       documentLinkServiceClient.deleteDocumentLinkCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteDocumentLinkRequest,Empty>

getSettings()

public final DocumentLinkServiceSettings getSettings()
Returns
Type Description
DocumentLinkServiceSettings

getStub()

public DocumentLinkServiceStub getStub()
Returns
Type Description
DocumentLinkServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLinkedSources(DocumentName parent)

public final DocumentLinkServiceClient.ListLinkedSourcesPagedResponse listLinkedSources(DocumentName parent)

Return all source document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   DocumentName parent =
       DocumentName.ofProjectLocationDocumentName("[PROJECT]", "[LOCATION]", "[DOCUMENT]");
   for (DocumentLink element :
       documentLinkServiceClient.listLinkedSources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent DocumentName

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

listLinkedSources(ListLinkedSourcesRequest request)

public final DocumentLinkServiceClient.ListLinkedSourcesPagedResponse listLinkedSources(ListLinkedSourcesRequest request)

Return all source document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   ListLinkedSourcesRequest request =
       ListLinkedSourcesRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   for (DocumentLink element :
       documentLinkServiceClient.listLinkedSources(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListLinkedSourcesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DocumentLinkServiceClient.ListLinkedSourcesPagedResponse

listLinkedSources(String parent)

public final DocumentLinkServiceClient.ListLinkedSourcesPagedResponse listLinkedSources(String parent)

Return all source document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   String parent =
       DocumentName.ofProjectLocationDocumentName("[PROJECT]", "[LOCATION]", "[DOCUMENT]")
           .toString();
   for (DocumentLink element :
       documentLinkServiceClient.listLinkedSources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

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

listLinkedSourcesCallable()

public final UnaryCallable<ListLinkedSourcesRequest,ListLinkedSourcesResponse> listLinkedSourcesCallable()

Return all source document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   ListLinkedSourcesRequest request =
       ListLinkedSourcesRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   while (true) {
     ListLinkedSourcesResponse response =
         documentLinkServiceClient.listLinkedSourcesCallable().call(request);
     for (DocumentLink element : response.getDocumentLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListLinkedSourcesRequest,ListLinkedSourcesResponse>

listLinkedSourcesPagedCallable()

public final UnaryCallable<ListLinkedSourcesRequest,DocumentLinkServiceClient.ListLinkedSourcesPagedResponse> listLinkedSourcesPagedCallable()

Return all source document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   ListLinkedSourcesRequest request =
       ListLinkedSourcesRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   ApiFuture<DocumentLink> future =
       documentLinkServiceClient.listLinkedSourcesPagedCallable().futureCall(request);
   // Do something.
   for (DocumentLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListLinkedSourcesRequest,ListLinkedSourcesPagedResponse>

listLinkedTargets(DocumentName parent)

public final ListLinkedTargetsResponse listLinkedTargets(DocumentName parent)

Return all target document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   DocumentName parent =
       DocumentName.ofProjectLocationDocumentName("[PROJECT]", "[LOCATION]", "[DOCUMENT]");
   ListLinkedTargetsResponse response = documentLinkServiceClient.listLinkedTargets(parent);
 }
Parameter
Name Description
parent DocumentName

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

listLinkedTargets(ListLinkedTargetsRequest request)

public final ListLinkedTargetsResponse listLinkedTargets(ListLinkedTargetsRequest request)

Return all target document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   ListLinkedTargetsRequest request =
       ListLinkedTargetsRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DOCUMENT]")
                   .toString())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   ListLinkedTargetsResponse response = documentLinkServiceClient.listLinkedTargets(request);
 }
Parameter
Name Description
request ListLinkedTargetsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ListLinkedTargetsResponse

listLinkedTargets(String parent)

public final ListLinkedTargetsResponse listLinkedTargets(String parent)

Return all target document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   String parent =
       DocumentName.ofProjectLocationDocumentName("[PROJECT]", "[LOCATION]", "[DOCUMENT]")
           .toString();
   ListLinkedTargetsResponse response = documentLinkServiceClient.listLinkedTargets(parent);
 }
Parameter
Name Description
parent String

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

listLinkedTargetsCallable()

public final UnaryCallable<ListLinkedTargetsRequest,ListLinkedTargetsResponse> listLinkedTargetsCallable()

Return all target document-links from the document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentLinkServiceClient documentLinkServiceClient = DocumentLinkServiceClient.create()) {
   ListLinkedTargetsRequest request =
       ListLinkedTargetsRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DOCUMENT]")
                   .toString())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   ApiFuture<ListLinkedTargetsResponse> future =
       documentLinkServiceClient.listLinkedTargetsCallable().futureCall(request);
   // Do something.
   ListLinkedTargetsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<ListLinkedTargetsRequest,ListLinkedTargetsResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()