- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
GitHub Repository | Product Reference |
Service Description: Service for displaying processed 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().
Method | Description | Method Variants |
---|---|---|
GetChunk |
Gets a Document. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListChunks |
Gets a list of Chunks. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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 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.
Static Methods
create()
public static final ChunkServiceClient create()
Constructs an instance of ChunkServiceClient with default settings.
Returns | |
---|---|
Type | Description |
ChunkServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ChunkServiceSettings settings)
public static final ChunkServiceClient create(ChunkServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
ChunkServiceSettings |
Returns | |
---|---|
Type | Description |
ChunkServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ChunkServiceStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
ChunkServiceStub |
Returns | |
---|---|
Type | Description |
ChunkServiceClient |
Constructors
ChunkServiceClient(ChunkServiceSettings settings)
protected ChunkServiceClient(ChunkServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
ChunkServiceSettings |
ChunkServiceClient(ChunkServiceStub stub)
protected ChunkServiceClient(ChunkServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
ChunkServiceStub |
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()
getChunk(ChunkName name)
public final Chunk getChunk(ChunkName name)
Gets a 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);
}
Parameter | |
---|---|
Name | Description |
name |
ChunkName Required. Full resource name of
Chunk, such as
If the caller does not have permission to access the
Chunk, regardless of whether or not it
exists, a If the requested Chunk does not exist, a
|
Returns | |
---|---|
Type | Description |
Chunk |
getChunk(GetChunkRequest request)
public final Chunk getChunk(GetChunkRequest request)
Gets a 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);
}
Parameter | |
---|---|
Name | Description |
request |
GetChunkRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Chunk |
getChunk(String name)
public final Chunk getChunk(String name)
Gets a 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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Full resource name of
Chunk, such as
If the caller does not have permission to access the
Chunk, regardless of whether or not it
exists, a If the requested Chunk does not exist, a
|
Returns | |
---|---|
Type | Description |
Chunk |
getChunkCallable()
public final UnaryCallable<GetChunkRequest,Chunk> getChunkCallable()
Gets a 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetChunkRequest,Chunk> |
getSettings()
public final ChunkServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
ChunkServiceSettings |
getStub()
public ChunkServiceStub getStub()
Returns | |
---|---|
Type | Description |
ChunkServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listChunks(DocumentName parent)
public final ChunkServiceClient.ListChunksPagedResponse listChunks(DocumentName parent)
Gets a list of Chunks.
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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
DocumentName Required. The parent document resource name, such as
If the caller does not have permission to list
Chunks under this document, regardless of
whether or not this document exists, a |
Returns | |
---|---|
Type | Description |
ChunkServiceClient.ListChunksPagedResponse |
listChunks(ListChunksRequest request)
public final ChunkServiceClient.ListChunksPagedResponse listChunks(ListChunksRequest request)
Gets a list of Chunks.
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListChunksRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ChunkServiceClient.ListChunksPagedResponse |
listChunks(String parent)
public final ChunkServiceClient.ListChunksPagedResponse listChunks(String parent)
Gets a list of Chunks.
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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent document resource name, such as
If the caller does not have permission to list
Chunks under this document, regardless of
whether or not this document exists, a |
Returns | |
---|---|
Type | Description |
ChunkServiceClient.ListChunksPagedResponse |
listChunksCallable()
public final UnaryCallable<ListChunksRequest,ListChunksResponse> listChunksCallable()
Gets a list of Chunks.
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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListChunksRequest,ListChunksResponse> |
listChunksPagedCallable()
public final UnaryCallable<ListChunksRequest,ChunkServiceClient.ListChunksPagedResponse> listChunksPagedCallable()
Gets a list of Chunks.
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListChunksRequest,ListChunksPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()