com.google.cloud.dialogflow.v2beta1.DocumentsClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-dialogflow Show documentation
Show all versions of google-cloud-dialogflow Show documentation
Java idiomatic client for Google Cloud Dialog Flow API
/*
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dialogflow.v2beta1;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.v2beta1.stub.DocumentsStub;
import com.google.cloud.dialogflow.v2beta1.stub.DocumentsStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Manages documents of a knowledge base.
*
* 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:
*
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* Document response = documentsClient.getDocument(name);
* }
*
*
*
* Note: close() needs to be called on the documentsClient 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 DocumentsSettings to create().
* For example:
*
*
To customize credentials:
*
*
*
* DocumentsSettings documentsSettings =
* DocumentsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* DocumentsClient documentsClient =
* DocumentsClient.create(documentsSettings);
*
*
*
* To customize the endpoint:
*
*
*
* DocumentsSettings documentsSettings =
* DocumentsSettings.newBuilder().setEndpoint(myEndpoint).build();
* DocumentsClient documentsClient =
* DocumentsClient.create(documentsSettings);
*
*
*/
@Generated("by gapic-generator")
@BetaApi
public class DocumentsClient implements BackgroundResource {
private final DocumentsSettings settings;
private final DocumentsStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of DocumentsClient with default settings. */
public static final DocumentsClient create() throws IOException {
return create(DocumentsSettings.newBuilder().build());
}
/**
* Constructs an instance of DocumentsClient, using the given settings. The channels are created
* based on the settings passed in, or defaults for any settings that are not set.
*/
public static final DocumentsClient create(DocumentsSettings settings) throws IOException {
return new DocumentsClient(settings);
}
/**
* Constructs an instance of DocumentsClient, using the given stub for making calls. This is for
* advanced usage - prefer to use DocumentsSettings}.
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final DocumentsClient create(DocumentsStub stub) {
return new DocumentsClient(stub);
}
/**
* Constructs an instance of DocumentsClient, 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.
*/
protected DocumentsClient(DocumentsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((DocumentsStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected DocumentsClient(DocumentsStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final DocumentsSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public DocumentsStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all documents of the knowledge base.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param parent Required. The knowledge base to list all documents for. Format:
* `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDocumentsPagedResponse listDocuments(KnowledgeBaseName parent) {
ListDocumentsRequest request =
ListDocumentsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listDocuments(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all documents of the knowledge base.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* for (Document element : documentsClient.listDocuments(parent.toString()).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param parent Required. The knowledge base to list all documents for. Format:
* `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDocumentsPagedResponse listDocuments(String parent) {
ListDocumentsRequest request = ListDocumentsRequest.newBuilder().setParent(parent).build();
return listDocuments(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all documents of the knowledge base.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* ListDocumentsRequest request = ListDocumentsRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* for (Document element : documentsClient.listDocuments(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param 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
*/
public final ListDocumentsPagedResponse listDocuments(ListDocumentsRequest request) {
return listDocumentsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all documents of the knowledge base.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* ListDocumentsRequest request = ListDocumentsRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* ApiFuture<ListDocumentsPagedResponse> future = documentsClient.listDocumentsPagedCallable().futureCall(request);
* // Do something
* for (Document element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*/
public final UnaryCallable
listDocumentsPagedCallable() {
return stub.listDocumentsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the list of all documents of the knowledge base.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* ListDocumentsRequest request = ListDocumentsRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* while (true) {
* ListDocumentsResponse response = documentsClient.listDocumentsCallable().call(request);
* for (Document element : response.getDocumentsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
*
*/
public final UnaryCallable listDocumentsCallable() {
return stub.listDocumentsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified document.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* Document response = documentsClient.getDocument(name);
* }
*
*
* @param name Required. The name of the document to retrieve. Format `projects/<Project
* ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Document getDocument(DocumentName name) {
GetDocumentRequest request =
GetDocumentRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getDocument(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified document.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* Document response = documentsClient.getDocument(name.toString());
* }
*
*
* @param name Required. The name of the document to retrieve. Format `projects/<Project
* ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Document getDocument(String name) {
GetDocumentRequest request = GetDocumentRequest.newBuilder().setName(name).build();
return getDocument(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified document.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* GetDocumentRequest request = GetDocumentRequest.newBuilder()
* .setName(name.toString())
* .build();
* Document response = documentsClient.getDocument(request);
* }
*
*
* @param 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
*/
public final Document getDocument(GetDocumentRequest request) {
return getDocumentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Retrieves the specified document.
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* GetDocumentRequest request = GetDocumentRequest.newBuilder()
* .setName(name.toString())
* .build();
* ApiFuture<Document> future = documentsClient.getDocumentCallable().futureCall(request);
* // Do something
* Document response = future.get();
* }
*
*/
public final UnaryCallable getDocumentCallable() {
return stub.getDocumentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a new document.
*
* Operation <response: [Document][google.cloud.dialogflow.v2beta1.Document], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* Document document = Document.newBuilder().build();
* Document response = documentsClient.createDocumentAsync(parent, document).get();
* }
*
*
* @param parent Required. The knoweldge base to create a document for. Format:
* `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param document Required. The document to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture createDocumentAsync(
KnowledgeBaseName parent, Document document) {
CreateDocumentRequest request =
CreateDocumentRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setDocument(document)
.build();
return createDocumentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a new document.
*
* Operation <response: [Document][google.cloud.dialogflow.v2beta1.Document], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* Document document = Document.newBuilder().build();
* Document response = documentsClient.createDocumentAsync(parent.toString(), document).get();
* }
*
*
* @param parent Required. The knoweldge base to create a document for. Format:
* `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
* @param document Required. The document to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture createDocumentAsync(
String parent, Document document) {
CreateDocumentRequest request =
CreateDocumentRequest.newBuilder().setParent(parent).setDocument(document).build();
return createDocumentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a new document.
*
* Operation <response: [Document][google.cloud.dialogflow.v2beta1.Document], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* Document document = Document.newBuilder().build();
* CreateDocumentRequest request = CreateDocumentRequest.newBuilder()
* .setParent(parent.toString())
* .setDocument(document)
* .build();
* Document response = documentsClient.createDocumentAsync(request).get();
* }
*
*
* @param 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
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture createDocumentAsync(
CreateDocumentRequest request) {
return createDocumentOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a new document.
*
* Operation <response: [Document][google.cloud.dialogflow.v2beta1.Document], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* Document document = Document.newBuilder().build();
* CreateDocumentRequest request = CreateDocumentRequest.newBuilder()
* .setParent(parent.toString())
* .setDocument(document)
* .build();
* OperationFuture<Document, KnowledgeOperationMetadata> future = documentsClient.createDocumentOperationCallable().futureCall(request);
* // Do something
* Document response = future.get();
* }
*
*/
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable
createDocumentOperationCallable() {
return stub.createDocumentOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a new document.
*
* Operation <response: [Document][google.cloud.dialogflow.v2beta1.Document], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* KnowledgeBaseName parent = KnowledgeBaseName.of("[PROJECT]", "[KNOWLEDGE_BASE]");
* Document document = Document.newBuilder().build();
* CreateDocumentRequest request = CreateDocumentRequest.newBuilder()
* .setParent(parent.toString())
* .setDocument(document)
* .build();
* ApiFuture<Operation> future = documentsClient.createDocumentCallable().futureCall(request);
* // Do something
* Operation response = future.get();
* }
*
*/
public final UnaryCallable createDocumentCallable() {
return stub.createDocumentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified document.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* documentsClient.deleteDocumentAsync(name).get();
* }
*
*
* @param name The name of the document to delete. Format: `projects/<Project
* ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture deleteDocumentAsync(
DocumentName name) {
DeleteDocumentRequest request =
DeleteDocumentRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return deleteDocumentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified document.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* documentsClient.deleteDocumentAsync(name.toString()).get();
* }
*
*
* @param name The name of the document to delete. Format: `projects/<Project
* ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture deleteDocumentAsync(String name) {
DeleteDocumentRequest request = DeleteDocumentRequest.newBuilder().setName(name).build();
return deleteDocumentAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified document.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* DeleteDocumentRequest request = DeleteDocumentRequest.newBuilder()
* .setName(name.toString())
* .build();
* documentsClient.deleteDocumentAsync(request).get();
* }
*
*
* @param 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
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture deleteDocumentAsync(
DeleteDocumentRequest request) {
return deleteDocumentOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified document.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* DeleteDocumentRequest request = DeleteDocumentRequest.newBuilder()
* .setName(name.toString())
* .build();
* OperationFuture<Empty, KnowledgeOperationMetadata> future = documentsClient.deleteDocumentOperationCallable().futureCall(request);
* // Do something
* future.get();
* }
*
*/
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable
deleteDocumentOperationCallable() {
return stub.deleteDocumentOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes the specified document.
*
* Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
*
Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name = DocumentName.of("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* DeleteDocumentRequest request = DeleteDocumentRequest.newBuilder()
* .setName(name.toString())
* .build();
* ApiFuture<Operation> future = documentsClient.deleteDocumentCallable().futureCall(request);
* // Do something
* future.get();
* }
*
*/
public final UnaryCallable deleteDocumentCallable() {
return stub.deleteDocumentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates the specified document. Operation <response:
* [Document][google.cloud.dialogflow.v2beta1.Document], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* UpdateDocumentRequest request = UpdateDocumentRequest.newBuilder().build();
* Operation response = documentsClient.updateDocument(request);
* }
*
*
* @param 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
*/
public final Operation updateDocument(UpdateDocumentRequest request) {
return updateDocumentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Updates the specified document. Operation <response:
* [Document][google.cloud.dialogflow.v2beta1.Document], metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* UpdateDocumentRequest request = UpdateDocumentRequest.newBuilder().build();
* ApiFuture<Operation> future = documentsClient.updateDocumentCallable().futureCall(request);
* // Do something
* Operation response = future.get();
* }
*
*/
public final UnaryCallable updateDocumentCallable() {
return stub.updateDocumentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Reloads the specified document from its specified source, content_uri or content. The
* previously loaded content of the document will be deleted. Note: Even when the content of the
* document has not changed, there still may be side effects because of internal implementation
* changes. Operation <response: [Document][google.cloud.dialogflow.v2beta1.Document],
* metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* ReloadDocumentRequest request = ReloadDocumentRequest.newBuilder().build();
* Operation response = documentsClient.reloadDocument(request);
* }
*
*
* @param 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
*/
public final Operation reloadDocument(ReloadDocumentRequest request) {
return reloadDocumentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Reloads the specified document from its specified source, content_uri or content. The
* previously loaded content of the document will be deleted. Note: Even when the content of the
* document has not changed, there still may be side effects because of internal implementation
* changes. Operation <response: [Document][google.cloud.dialogflow.v2beta1.Document],
* metadata:
* [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
*
* Sample code:
*
*
* try (DocumentsClient documentsClient = DocumentsClient.create()) {
* ReloadDocumentRequest request = ReloadDocumentRequest.newBuilder().build();
* ApiFuture<Operation> future = documentsClient.reloadDocumentCallable().futureCall(request);
* // Do something
* Operation response = future.get();
* }
*
*/
public final UnaryCallable reloadDocumentCallable() {
return stub.reloadDocumentCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListDocumentsPagedResponse
extends AbstractPagedListResponse<
ListDocumentsRequest,
ListDocumentsResponse,
Document,
ListDocumentsPage,
ListDocumentsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListDocumentsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction() {
@Override
public ListDocumentsPagedResponse apply(ListDocumentsPage input) {
return new ListDocumentsPagedResponse(input);
}
},
MoreExecutors.directExecutor());
}
private ListDocumentsPagedResponse(ListDocumentsPage page) {
super(page, ListDocumentsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListDocumentsPage
extends AbstractPage<
ListDocumentsRequest, ListDocumentsResponse, Document, ListDocumentsPage> {
private ListDocumentsPage(
PageContext context,
ListDocumentsResponse response) {
super(context, response);
}
private static ListDocumentsPage createEmptyPage() {
return new ListDocumentsPage(null, null);
}
@Override
protected ListDocumentsPage createPage(
PageContext context,
ListDocumentsResponse response) {
return new ListDocumentsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListDocumentsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListDocumentsRequest,
ListDocumentsResponse,
Document,
ListDocumentsPage,
ListDocumentsFixedSizeCollection> {
private ListDocumentsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListDocumentsFixedSizeCollection createEmptyCollection() {
return new ListDocumentsFixedSizeCollection(null, 0);
}
@Override
protected ListDocumentsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListDocumentsFixedSizeCollection(pages, collectionSize);
}
}
}