com.google.cloud.discoveryengine.v1alpha

Class ChunkServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1alpha.ChunkServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: Service for displaying processed [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] information of the customer's unstructured data.

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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   ChunkName name =
       ChunkName.ofProjectLocationDataStoreBranchDocumentChunkName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]", "[CHUNK]");
   Chunk response = chunkServiceClient.getChunk(name);
 }
 

Note: close() needs to be called on the ChunkServiceClient 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
GetChunk	Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getChunk(GetChunkRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getChunk(ChunkName name) getChunk(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. getChunkCallable()
ListChunks	Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listChunks(ListChunksRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listChunks(DocumentName parent) listChunks(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. listChunksPagedCallable() listChunksCallable()

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 ChunkServiceSettings 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
 ChunkServiceSettings chunkServiceSettings =
     ChunkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ChunkServiceClient chunkServiceClient = ChunkServiceClient.create(chunkServiceSettings);
 

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
 ChunkServiceSettings chunkServiceSettings =
     ChunkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ChunkServiceClient chunkServiceClient = ChunkServiceClient.create(chunkServiceSettings);
 

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
 ChunkServiceSettings chunkServiceSettings = ChunkServiceSettings.newHttpJsonBuilder().build();
 ChunkServiceClient chunkServiceClient = ChunkServiceClient.create(chunkServiceSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChunkServiceClient.ListChunksFixedSizeCollection
static class	ChunkServiceClient.ListChunksPage
static class	ChunkServiceClient.ListChunksPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChunkServiceClient(ChunkServiceSettings settings) Constructs an instance of ChunkServiceClient, using the given settings.
protected	ChunkServiceClient(ChunkServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ChunkServiceClient	create() Constructs an instance of ChunkServiceClient with default settings.
static ChunkServiceClient	create(ChunkServiceSettings settings) Constructs an instance of ChunkServiceClient, using the given settings.
static ChunkServiceClient	create(ChunkServiceStub stub) Constructs an instance of ChunkServiceClient, using the given stub for making calls.
Chunk	getChunk(ChunkName name) Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
Chunk	getChunk(GetChunkRequest request) Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
Chunk	getChunk(String name) Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
com.google.api.gax.rpc.UnaryCallable<GetChunkRequest,Chunk>	getChunkCallable() Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
ChunkServiceSettings	getSettings()
ChunkServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ChunkServiceClient.ListChunksPagedResponse	listChunks(DocumentName parent) Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
ChunkServiceClient.ListChunksPagedResponse	listChunks(ListChunksRequest request) Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
ChunkServiceClient.ListChunksPagedResponse	listChunks(String parent) Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
com.google.api.gax.rpc.UnaryCallable<ListChunksRequest,ListChunksResponse>	listChunksCallable() Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
com.google.api.gax.rpc.UnaryCallable<ListChunksRequest,ChunkServiceClient.ListChunksPagedResponse>	listChunksPagedCallable() Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChunkServiceClient

protected ChunkServiceClient(ChunkServiceSettings settings)
                      throws IOException

Constructs an instance of ChunkServiceClient, 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

ChunkServiceClient

protected ChunkServiceClient(ChunkServiceStub stub)

Method Detail

create

public static final ChunkServiceClient create()
                                       throws IOException

Constructs an instance of ChunkServiceClient with default settings.

Throws:

IOException

create

public static final ChunkServiceClient create(ChunkServiceSettings settings)
                                       throws IOException

Constructs an instance of ChunkServiceClient, 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 ChunkServiceClient create(ChunkServiceStub stub)

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

getSettings

public final ChunkServiceSettings getSettings()

getStub

public ChunkServiceStub getStub()

getChunk

public final Chunk getChunk(ChunkName name)

Gets a [Document][google.cloud.discoveryengine.v1alpha.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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   ChunkName name =
       ChunkName.ofProjectLocationDataStoreBranchDocumentChunkName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]", "[CHUNK]");
   Chunk response = chunkServiceClient.getChunk(name);
 }
 

Parameters:

name - Required. Full resource name of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`.

If the caller does not have permission to access the [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned.

If the requested [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does not exist, a `NOT_FOUND` error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getChunk

public final Chunk getChunk(String name)

Gets a [Document][google.cloud.discoveryengine.v1alpha.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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   String name =
       ChunkName.ofProjectLocationDataStoreBranchDocumentChunkName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]", "[CHUNK]")
           .toString();
   Chunk response = chunkServiceClient.getChunk(name);
 }
 

Parameters:

name - Required. Full resource name of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`.

If the caller does not have permission to access the [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned.

If the requested [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does not exist, a `NOT_FOUND` error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getChunk

public final Chunk getChunk(GetChunkRequest request)

Gets a [Document][google.cloud.discoveryengine.v1alpha.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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   GetChunkRequest request =
       GetChunkRequest.newBuilder()
           .setName(
               ChunkName.ofProjectLocationDataStoreBranchDocumentChunkName(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DATA_STORE]",
                       "[BRANCH]",
                       "[DOCUMENT]",
                       "[CHUNK]")
                   .toString())
           .build();
   Chunk response = chunkServiceClient.getChunk(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

getChunkCallable

public final com.google.api.gax.rpc.UnaryCallable<GetChunkRequest,Chunk> getChunkCallable()

Gets a [Document][google.cloud.discoveryengine.v1alpha.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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   GetChunkRequest request =
       GetChunkRequest.newBuilder()
           .setName(
               ChunkName.ofProjectLocationDataStoreBranchDocumentChunkName(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DATA_STORE]",
                       "[BRANCH]",
                       "[DOCUMENT]",
                       "[CHUNK]")
                   .toString())
           .build();
   ApiFuture<Chunk> future = chunkServiceClient.getChunkCallable().futureCall(request);
   // Do something.
   Chunk response = future.get();
 }
 

listChunks

public final ChunkServiceClient.ListChunksPagedResponse listChunks(DocumentName parent)

Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.

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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   DocumentName parent =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
   for (Chunk element : chunkServiceClient.listChunks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

If the caller does not have permission to list [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listChunks

public final ChunkServiceClient.ListChunksPagedResponse listChunks(String parent)

Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.

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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   String parent =
       DocumentName.ofProjectLocationDataStoreBranchDocumentName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
           .toString();
   for (Chunk element : chunkServiceClient.listChunks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

If the caller does not have permission to list [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listChunks

public final ChunkServiceClient.ListChunksPagedResponse listChunks(ListChunksRequest request)

Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.

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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   ListChunksRequest request =
       ListChunksRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDataStoreBranchDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Chunk element : chunkServiceClient.listChunks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listChunksPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListChunksRequest,ChunkServiceClient.ListChunksPagedResponse> listChunksPagedCallable()

Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.

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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   ListChunksRequest request =
       ListChunksRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDataStoreBranchDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Chunk> future = chunkServiceClient.listChunksPagedCallable().futureCall(request);
   // Do something.
   for (Chunk element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listChunksCallable

public final com.google.api.gax.rpc.UnaryCallable<ListChunksRequest,ListChunksResponse> listChunksCallable()

Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.

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 (ChunkServiceClient chunkServiceClient = ChunkServiceClient.create()) {
   ListChunksRequest request =
       ListChunksRequest.newBuilder()
           .setParent(
               DocumentName.ofProjectLocationDataStoreBranchDocumentName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListChunksResponse response = chunkServiceClient.listChunksCallable().call(request);
     for (Chunk element : response.getChunksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException