com.google.cloud.dialogflow.v2.GeneratorsClient 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.GeneratorsStub;
import com.google.cloud.dialogflow.v2.stub.GeneratorsStubSettings;
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.Empty;
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: Generator Service for LLM powered Agent Assist. This service manages the
* configurations of user owned Generators, such as description, context and instruction,
* input/output format, etc. The generator resources will be used inside a conversation and will be
* triggered by TriggerEvent to query LLM for answers.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* Generator generator = Generator.newBuilder().build();
* String generatorId = "generatorId887044942";
* Generator response = generatorsClient.createGenerator(parent, generator, generatorId);
* }
* }
*
* Note: close() needs to be called on the GeneratorsClient 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
*
*
* CreateGenerator
Creates a generator.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createGenerator(CreateGeneratorRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createGenerator(ProjectName parent, Generator generator, String generatorId)
*
createGenerator(String parent, Generator generator, String generatorId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createGeneratorCallable()
*
*
*
*
* GetGenerator
Retrieves a generator.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getGenerator(GetGeneratorRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getGenerator(GeneratorName name)
*
getGenerator(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.
*
* getGeneratorCallable()
*
*
*
*
* ListGenerators
Lists generators.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listGenerators(ListGeneratorsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listGenerators(ProjectName parent)
*
listGenerators(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.
*
* listGeneratorsPagedCallable()
*
listGeneratorsCallable()
*
*
*
*
* DeleteGenerator
Deletes a generator.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteGenerator(DeleteGeneratorRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteGenerator(GeneratorName name)
*
deleteGenerator(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.
*
* deleteGeneratorCallable()
*
*
*
*
* UpdateGenerator
Updates a generator.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateGenerator(UpdateGeneratorRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateGenerator(Generator generator, 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.
*
* updateGeneratorCallable()
*
*
*
*
* 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 GeneratorsSettings 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
* GeneratorsSettings generatorsSettings =
* GeneratorsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* GeneratorsClient generatorsClient = GeneratorsClient.create(generatorsSettings);
* }
*
* 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
* GeneratorsSettings generatorsSettings =
* GeneratorsSettings.newBuilder().setEndpoint(myEndpoint).build();
* GeneratorsClient generatorsClient = GeneratorsClient.create(generatorsSettings);
* }
*
* 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
* GeneratorsSettings generatorsSettings = GeneratorsSettings.newHttpJsonBuilder().build();
* GeneratorsClient generatorsClient = GeneratorsClient.create(generatorsSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class GeneratorsClient implements BackgroundResource {
private final GeneratorsSettings settings;
private final GeneratorsStub stub;
/** Constructs an instance of GeneratorsClient with default settings. */
public static final GeneratorsClient create() throws IOException {
return create(GeneratorsSettings.newBuilder().build());
}
/**
* Constructs an instance of GeneratorsClient, 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 GeneratorsClient create(GeneratorsSettings settings) throws IOException {
return new GeneratorsClient(settings);
}
/**
* Constructs an instance of GeneratorsClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(GeneratorsSettings).
*/
public static final GeneratorsClient create(GeneratorsStub stub) {
return new GeneratorsClient(stub);
}
/**
* Constructs an instance of GeneratorsClient, 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 GeneratorsClient(GeneratorsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((GeneratorsStubSettings) settings.getStubSettings()).createStub();
}
protected GeneratorsClient(GeneratorsStub stub) {
this.settings = null;
this.stub = stub;
}
public final GeneratorsSettings getSettings() {
return settings;
}
public GeneratorsStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a generator.
*
*
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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* Generator generator = Generator.newBuilder().build();
* String generatorId = "generatorId887044942";
* Generator response = generatorsClient.createGenerator(parent, generator, generatorId);
* }
* }
*
* @param parent Required. The project/location to create generator for. Format:
* `projects/<Project ID>/locations/<Location ID>`
* @param generator Required. The generator to create.
* @param generatorId Optional. The ID to use for the generator, which will become the final
* component of the generator's resource name.
* The generator ID must be compliant with the regression fomula
* `[a-zA-Z][a-zA-Z0-9_-]*` with the characters length in range of [3,64]. If the field is
* not provided, an Id will be auto-generated. If the field is provided, the caller is
* resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the
* consistency for whether to use custom ID or not under a project to better ensure
* uniqueness.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Generator createGenerator(
ProjectName parent, Generator generator, String generatorId) {
CreateGeneratorRequest request =
CreateGeneratorRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setGenerator(generator)
.setGeneratorId(generatorId)
.build();
return createGenerator(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a generator.
*
*
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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* Generator generator = Generator.newBuilder().build();
* String generatorId = "generatorId887044942";
* Generator response = generatorsClient.createGenerator(parent, generator, generatorId);
* }
* }
*
* @param parent Required. The project/location to create generator for. Format:
* `projects/<Project ID>/locations/<Location ID>`
* @param generator Required. The generator to create.
* @param generatorId Optional. The ID to use for the generator, which will become the final
* component of the generator's resource name.
* The generator ID must be compliant with the regression fomula
* `[a-zA-Z][a-zA-Z0-9_-]*` with the characters length in range of [3,64]. If the field is
* not provided, an Id will be auto-generated. If the field is provided, the caller is
* resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the
* consistency for whether to use custom ID or not under a project to better ensure
* uniqueness.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Generator createGenerator(String parent, Generator generator, String generatorId) {
CreateGeneratorRequest request =
CreateGeneratorRequest.newBuilder()
.setParent(parent)
.setGenerator(generator)
.setGeneratorId(generatorId)
.build();
return createGenerator(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a generator.
*
*
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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* CreateGeneratorRequest request =
* CreateGeneratorRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setGenerator(Generator.newBuilder().build())
* .setGeneratorId("generatorId887044942")
* .build();
* Generator response = generatorsClient.createGenerator(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 Generator createGenerator(CreateGeneratorRequest request) {
return createGeneratorCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* CreateGeneratorRequest request =
* CreateGeneratorRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setGenerator(Generator.newBuilder().build())
* .setGeneratorId("generatorId887044942")
* .build();
* ApiFuture future = generatorsClient.createGeneratorCallable().futureCall(request);
* // Do something.
* Generator response = future.get();
* }
* }
*/
public final UnaryCallable createGeneratorCallable() {
return stub.createGeneratorCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* GeneratorName name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]");
* Generator response = generatorsClient.getGenerator(name);
* }
* }
*
* @param name Required. The generator resource name to retrieve. Format: `projects/<Project
* ID>/locations/<Location ID>`/generators/<Generator ID>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Generator getGenerator(GeneratorName name) {
GetGeneratorRequest request =
GetGeneratorRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getGenerator(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* String name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString();
* Generator response = generatorsClient.getGenerator(name);
* }
* }
*
* @param name Required. The generator resource name to retrieve. Format: `projects/<Project
* ID>/locations/<Location ID>`/generators/<Generator ID>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Generator getGenerator(String name) {
GetGeneratorRequest request = GetGeneratorRequest.newBuilder().setName(name).build();
return getGenerator(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* GetGeneratorRequest request =
* GetGeneratorRequest.newBuilder()
* .setName(GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString())
* .build();
* Generator response = generatorsClient.getGenerator(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 Generator getGenerator(GetGeneratorRequest request) {
return getGeneratorCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* GetGeneratorRequest request =
* GetGeneratorRequest.newBuilder()
* .setName(GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString())
* .build();
* ApiFuture future = generatorsClient.getGeneratorCallable().futureCall(request);
* // Do something.
* Generator response = future.get();
* }
* }
*/
public final UnaryCallable getGeneratorCallable() {
return stub.getGeneratorCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists generators.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* for (Generator element : generatorsClient.listGenerators(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project/location to list generators for. Format:
* `projects/<Project ID>/locations/<Location ID>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListGeneratorsPagedResponse listGenerators(ProjectName parent) {
ListGeneratorsRequest request =
ListGeneratorsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listGenerators(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists generators.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* for (Generator element : generatorsClient.listGenerators(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project/location to list generators for. Format:
* `projects/<Project ID>/locations/<Location ID>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListGeneratorsPagedResponse listGenerators(String parent) {
ListGeneratorsRequest request = ListGeneratorsRequest.newBuilder().setParent(parent).build();
return listGenerators(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists generators.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ListGeneratorsRequest request =
* ListGeneratorsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Generator element : generatorsClient.listGenerators(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 ListGeneratorsPagedResponse listGenerators(ListGeneratorsRequest request) {
return listGeneratorsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists generators.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ListGeneratorsRequest request =
* ListGeneratorsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* generatorsClient.listGeneratorsPagedCallable().futureCall(request);
* // Do something.
* for (Generator element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listGeneratorsPagedCallable() {
return stub.listGeneratorsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists generators.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ListGeneratorsRequest request =
* ListGeneratorsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListGeneratorsResponse response = generatorsClient.listGeneratorsCallable().call(request);
* for (Generator element : response.getGeneratorsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listGeneratorsCallable() {
return stub.listGeneratorsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* GeneratorName name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]");
* generatorsClient.deleteGenerator(name);
* }
* }
*
* @param name Required. The generator resource name to delete. Format: `projects/<Project
* ID>/locations/<Location ID>/generators/<Generator ID>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteGenerator(GeneratorName name) {
DeleteGeneratorRequest request =
DeleteGeneratorRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteGenerator(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* String name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString();
* generatorsClient.deleteGenerator(name);
* }
* }
*
* @param name Required. The generator resource name to delete. Format: `projects/<Project
* ID>/locations/<Location ID>/generators/<Generator ID>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteGenerator(String name) {
DeleteGeneratorRequest request = DeleteGeneratorRequest.newBuilder().setName(name).build();
deleteGenerator(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* DeleteGeneratorRequest request =
* DeleteGeneratorRequest.newBuilder()
* .setName(GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString())
* .build();
* generatorsClient.deleteGenerator(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 void deleteGenerator(DeleteGeneratorRequest request) {
deleteGeneratorCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* DeleteGeneratorRequest request =
* DeleteGeneratorRequest.newBuilder()
* .setName(GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString())
* .build();
* ApiFuture future = generatorsClient.deleteGeneratorCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteGeneratorCallable() {
return stub.deleteGeneratorCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* Generator generator = Generator.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Generator response = generatorsClient.updateGenerator(generator, updateMask);
* }
* }
*
* @param generator Required. The generator to update. The name field of generator is to identify
* the generator to update.
* @param updateMask Optional. The list of fields to update.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Generator updateGenerator(Generator generator, FieldMask updateMask) {
UpdateGeneratorRequest request =
UpdateGeneratorRequest.newBuilder()
.setGenerator(generator)
.setUpdateMask(updateMask)
.build();
return updateGenerator(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* UpdateGeneratorRequest request =
* UpdateGeneratorRequest.newBuilder()
* .setGenerator(Generator.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Generator response = generatorsClient.updateGenerator(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 Generator updateGenerator(UpdateGeneratorRequest request) {
return updateGeneratorCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a generator.
*
* 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* UpdateGeneratorRequest request =
* UpdateGeneratorRequest.newBuilder()
* .setGenerator(Generator.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future = generatorsClient.updateGeneratorCallable().futureCall(request);
* // Do something.
* Generator response = future.get();
* }
* }
*/
public final UnaryCallable updateGeneratorCallable() {
return stub.updateGeneratorCallable();
}
// 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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : generatorsClient.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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* generatorsClient.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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response = generatorsClient.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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = generatorsClient.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 (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future = generatorsClient.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 ListGeneratorsPagedResponse
extends AbstractPagedListResponse<
ListGeneratorsRequest,
ListGeneratorsResponse,
Generator,
ListGeneratorsPage,
ListGeneratorsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListGeneratorsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListGeneratorsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListGeneratorsPagedResponse(ListGeneratorsPage page) {
super(page, ListGeneratorsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListGeneratorsPage
extends AbstractPage<
ListGeneratorsRequest, ListGeneratorsResponse, Generator, ListGeneratorsPage> {
private ListGeneratorsPage(
PageContext context,
ListGeneratorsResponse response) {
super(context, response);
}
private static ListGeneratorsPage createEmptyPage() {
return new ListGeneratorsPage(null, null);
}
@Override
protected ListGeneratorsPage createPage(
PageContext context,
ListGeneratorsResponse response) {
return new ListGeneratorsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListGeneratorsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListGeneratorsRequest,
ListGeneratorsResponse,
Generator,
ListGeneratorsPage,
ListGeneratorsFixedSizeCollection> {
private ListGeneratorsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListGeneratorsFixedSizeCollection createEmptyCollection() {
return new ListGeneratorsFixedSizeCollection(null, 0);
}
@Override
protected ListGeneratorsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListGeneratorsFixedSizeCollection(pages, collectionSize);
}
}
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);
}
}
}