java.lang.Object
- com.google.cloud.contentwarehouse.v1.DocumentLinkServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated("by gapic-generator-java")
public class DocumentLinkServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DocumentLinkServiceClient.ListLinkedSourcesFixedSizeCollection`
`static class`	`DocumentLinkServiceClient.ListLinkedSourcesPage`
`static class`	`DocumentLinkServiceClient.ListLinkedSourcesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`DocumentLinkServiceClient(DocumentLinkServiceSettings settings)`	Constructs an instance of DocumentLinkServiceClient, using the given settings.
`protected`	`DocumentLinkServiceClient(DocumentLinkServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static DocumentLinkServiceClient`	`create()`	Constructs an instance of DocumentLinkServiceClient with default settings.
`static DocumentLinkServiceClient`	`create(DocumentLinkServiceSettings settings)`	Constructs an instance of DocumentLinkServiceClient, using the given settings.
`static DocumentLinkServiceClient`	`create(DocumentLinkServiceStub stub)`	Constructs an instance of DocumentLinkServiceClient, using the given stub for making calls.
`DocumentLink`	`createDocumentLink(CreateDocumentLinkRequest request)`	Create a link between a source document and a target document.
`DocumentLink`	`createDocumentLink(DocumentName parent, DocumentLink documentLink)`	Create a link between a source document and a target document.
`DocumentLink`	`createDocumentLink(String parent, DocumentLink documentLink)`	Create a link between a source document and a target document.
`com.google.api.gax.rpc.UnaryCallable<CreateDocumentLinkRequest,DocumentLink>`	`createDocumentLinkCallable()`	Create a link between a source document and a target document.
`void`	`deleteDocumentLink(DeleteDocumentLinkRequest request)`	Remove the link between the source and target documents.
`void`	`deleteDocumentLink(DocumentLinkName name)`	Remove the link between the source and target documents.
`void`	`deleteDocumentLink(String name)`	Remove the link between the source and target documents.
`com.google.api.gax.rpc.UnaryCallable<DeleteDocumentLinkRequest,com.google.protobuf.Empty>`	`deleteDocumentLinkCallable()`	Remove the link between the source and target documents.
`DocumentLinkServiceSettings`	`getSettings()`
`DocumentLinkServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`DocumentLinkServiceClient.ListLinkedSourcesPagedResponse`	`listLinkedSources(DocumentName parent)`	Return all source document-links from the document.
`DocumentLinkServiceClient.ListLinkedSourcesPagedResponse`	`listLinkedSources(ListLinkedSourcesRequest request)`	Return all source document-links from the document.
`DocumentLinkServiceClient.ListLinkedSourcesPagedResponse`	`listLinkedSources(String parent)`	Return all source document-links from the document.
`com.google.api.gax.rpc.UnaryCallable<ListLinkedSourcesRequest,ListLinkedSourcesResponse>`	`listLinkedSourcesCallable()`	Return all source document-links from the document.
`com.google.api.gax.rpc.UnaryCallable<ListLinkedSourcesRequest,DocumentLinkServiceClient.ListLinkedSourcesPagedResponse>`	`listLinkedSourcesPagedCallable()`	Return all source document-links from the document.
`ListLinkedTargetsResponse`	`listLinkedTargets(DocumentName parent)`	Return all target document-links from the document.
`ListLinkedTargetsResponse`	`listLinkedTargets(ListLinkedTargetsRequest request)`	Return all target document-links from the document.
`ListLinkedTargetsResponse`	`listLinkedTargets(String parent)`	Return all target document-links from the document.
`com.google.api.gax.rpc.UnaryCallable<ListLinkedTargetsRequest,ListLinkedTargetsResponse>`	`listLinkedTargetsCallable()`	Return all target document-links from the document.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DocumentLinkServiceClient
```
protected DocumentLinkServiceClient(DocumentLinkServiceSettings settings)
                             throws IOException
```
  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.
  
  Throws:
  
  IOException
- DocumentLinkServiceClient
```
protected DocumentLinkServiceClient(DocumentLinkServiceStub stub)
```

Method Detail

create

public static final DocumentLinkServiceClient create()
                                              throws IOException

Constructs an instance of DocumentLinkServiceClient with default settings.

Throws:: IOException

create
```
public static final DocumentLinkServiceClient create(DocumentLinkServiceSettings settings)
                                              throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final DocumentLinkServiceSettings getSettings()

getStub

public DocumentLinkServiceStub getStub()

listLinkedTargets

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);
 }

Parameters:: parent - Required. The name of the document, for which all target links are returned. Format: projects/{project_number}/locations/{location}/documents/{target_document_id}.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listLinkedTargets

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);
 }

Parameters:: parent - Required. The name of the document, for which all target links are returned. Format: projects/{project_number}/locations/{location}/documents/{target_document_id}.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listLinkedTargets

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listLinkedTargetsCallable

public final com.google.api.gax.rpc.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();
 }