com.google.cloud.dialogflow.v2.FulfillmentsClient Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow Show documentation
/*
* Copyright 2024 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.v2;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
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.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.v2.stub.FulfillmentsStub;
import com.google.cloud.dialogflow.v2.stub.FulfillmentsStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for managing [Fulfillments][google.cloud.dialogflow.v2.Fulfillment].
*
* 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:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* FulfillmentName name = FulfillmentName.ofProjectName("[PROJECT]");
* Fulfillment response = fulfillmentsClient.getFulfillment(name);
* }
* }
*
* Note: close() needs to be called on the FulfillmentsClient 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
*
*
* GetFulfillment
Retrieves the fulfillment.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getFulfillment(GetFulfillmentRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getFulfillment(FulfillmentName name)
*
getFulfillment(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.
*
* getFulfillmentCallable()
*
*
*
*
* UpdateFulfillment
Updates the fulfillment.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateFulfillment(UpdateFulfillmentRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateFulfillment(Fulfillment fulfillment, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateFulfillmentCallable()
*
*
*
*
* ListLocations
Lists information about the supported locations for this service.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listLocations(ListLocationsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listLocationsPagedCallable()
*
listLocationsCallable()
*
*
*
*
* GetLocation
Gets information about a location.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getLocation(GetLocationRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getLocationCallable()
*
*
*
*
*
* 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 FulfillmentsSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@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
* FulfillmentsSettings fulfillmentsSettings =
* FulfillmentsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create(fulfillmentsSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* FulfillmentsSettings fulfillmentsSettings =
* FulfillmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
* FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create(fulfillmentsSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* FulfillmentsSettings fulfillmentsSettings = FulfillmentsSettings.newHttpJsonBuilder().build();
* FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create(fulfillmentsSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class FulfillmentsClient implements BackgroundResource {
private final FulfillmentsSettings settings;
private final FulfillmentsStub stub;
/** Constructs an instance of FulfillmentsClient with default settings. */
public static final FulfillmentsClient create() throws IOException {
return create(FulfillmentsSettings.newBuilder().build());
}
/**
* Constructs an instance of FulfillmentsClient, 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 FulfillmentsClient create(FulfillmentsSettings settings) throws IOException {
return new FulfillmentsClient(settings);
}
/**
* Constructs an instance of FulfillmentsClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(FulfillmentsSettings).
*/
public static final FulfillmentsClient create(FulfillmentsStub stub) {
return new FulfillmentsClient(stub);
}
/**
* Constructs an instance of FulfillmentsClient, 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 FulfillmentsClient(FulfillmentsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((FulfillmentsStubSettings) settings.getStubSettings()).createStub();
}
protected FulfillmentsClient(FulfillmentsStub stub) {
this.settings = null;
this.stub = stub;
}
public final FulfillmentsSettings getSettings() {
return settings;
}
public FulfillmentsStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the fulfillment.
*
*
Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* FulfillmentName name = FulfillmentName.ofProjectName("[PROJECT]");
* Fulfillment response = fulfillmentsClient.getFulfillment(name);
* }
* }
*
* @param name Required. The name of the fulfillment. Format: `projects/<Project
* ID>/agent/fulfillment`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Fulfillment getFulfillment(FulfillmentName name) {
GetFulfillmentRequest request =
GetFulfillmentRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getFulfillment(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the fulfillment.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* String name = FulfillmentName.ofProjectName("[PROJECT]").toString();
* Fulfillment response = fulfillmentsClient.getFulfillment(name);
* }
* }
*
* @param name Required. The name of the fulfillment. Format: `projects/<Project
* ID>/agent/fulfillment`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Fulfillment getFulfillment(String name) {
GetFulfillmentRequest request = GetFulfillmentRequest.newBuilder().setName(name).build();
return getFulfillment(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the fulfillment.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* GetFulfillmentRequest request =
* GetFulfillmentRequest.newBuilder()
* .setName(FulfillmentName.ofProjectName("[PROJECT]").toString())
* .build();
* Fulfillment response = fulfillmentsClient.getFulfillment(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 Fulfillment getFulfillment(GetFulfillmentRequest request) {
return getFulfillmentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the fulfillment.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* GetFulfillmentRequest request =
* GetFulfillmentRequest.newBuilder()
* .setName(FulfillmentName.ofProjectName("[PROJECT]").toString())
* .build();
* ApiFuture future =
* fulfillmentsClient.getFulfillmentCallable().futureCall(request);
* // Do something.
* Fulfillment response = future.get();
* }
* }
*/
public final UnaryCallable getFulfillmentCallable() {
return stub.getFulfillmentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the fulfillment.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* Fulfillment fulfillment = Fulfillment.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Fulfillment response = fulfillmentsClient.updateFulfillment(fulfillment, updateMask);
* }
* }
*
* @param fulfillment Required. The fulfillment to update.
* @param updateMask Required. The mask to control which fields get updated. If the mask is not
* present, all fields will be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Fulfillment updateFulfillment(Fulfillment fulfillment, FieldMask updateMask) {
UpdateFulfillmentRequest request =
UpdateFulfillmentRequest.newBuilder()
.setFulfillment(fulfillment)
.setUpdateMask(updateMask)
.build();
return updateFulfillment(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the fulfillment.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* UpdateFulfillmentRequest request =
* UpdateFulfillmentRequest.newBuilder()
* .setFulfillment(Fulfillment.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Fulfillment response = fulfillmentsClient.updateFulfillment(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 Fulfillment updateFulfillment(UpdateFulfillmentRequest request) {
return updateFulfillmentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the fulfillment.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* UpdateFulfillmentRequest request =
* UpdateFulfillmentRequest.newBuilder()
* .setFulfillment(Fulfillment.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* fulfillmentsClient.updateFulfillmentCallable().futureCall(request);
* // Do something.
* Fulfillment response = future.get();
* }
* }
*/
public final UnaryCallable updateFulfillmentCallable() {
return stub.updateFulfillmentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : fulfillmentsClient.listLocations(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 ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* fulfillmentsClient.listLocationsPagedCallable().futureCall(request);
* // Do something.
* for (Location element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response = fulfillmentsClient.listLocationsCallable().call(request);
* for (Location element : response.getLocationsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = fulfillmentsClient.getLocation(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 Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future = fulfillmentsClient.getLocationCallable().futureCall(request);
* // Do something.
* Location response = future.get();
* }
* }
*/
public final UnaryCallable getLocationCallable() {
return stub.getLocationCallable();
}
@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 ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListLocationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListLocationsPagedResponse(ListLocationsPage page) {
super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListLocationsPage
extends AbstractPage<
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {
private ListLocationsPage(
PageContext context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}