Class GeneratorsClient (4.54.0)

GitHub RepositoryProduct Reference

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:


 // 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:


 // 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:


 // 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:


 // 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.

Inheritance

java.lang.Object > GeneratorsClient

Static Methods

create()

public static final GeneratorsClient create()

Constructs an instance of GeneratorsClient with default settings.

Returns
Type Description
GeneratorsClient
Exceptions
Type Description
IOException

create(GeneratorsSettings settings)

public static final GeneratorsClient create(GeneratorsSettings settings)

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.

Parameter
Name Description
settings GeneratorsSettings
Returns
Type Description
GeneratorsClient
Exceptions
Type Description
IOException

create(GeneratorsStub stub)

public static final GeneratorsClient create(GeneratorsStub stub)

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

Parameter
Name Description
stub GeneratorsStub
Returns
Type Description
GeneratorsClient

Constructors

GeneratorsClient(GeneratorsSettings settings)

protected GeneratorsClient(GeneratorsSettings settings)

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.

Parameter
Name Description
settings GeneratorsSettings

GeneratorsClient(GeneratorsStub stub)

protected GeneratorsClient(GeneratorsStub stub)
Parameter
Name Description
stub GeneratorsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createGenerator(CreateGeneratorRequest request)

public final Generator createGenerator(CreateGeneratorRequest request)

Creates a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
 }
Parameter
Name Description
request CreateGeneratorRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Generator

createGenerator(ProjectName parent, Generator generator, String generatorId)

public final Generator createGenerator(ProjectName parent, Generator generator, String generatorId)

Creates a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Generator generator = Generator.newBuilder().build();
   String generatorId = "generatorId887044942";
   Generator response = generatorsClient.createGenerator(parent, generator, generatorId);
 }
Parameters
Name Description
parent ProjectName

Required. The project/location to create generator for. Format: projects/<Project ID>/locations/<Location ID>
generator Generator

Required. The generator to create.
generatorId String

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* 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.
Returns
Type Description
Generator

createGenerator(String parent, Generator generator, String generatorId)

public final Generator createGenerator(String parent, Generator generator, String generatorId)

Creates a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
 }
Parameters
Name Description
parent String

Required. The project/location to create generator for. Format: projects/<Project ID>/locations/<Location ID>
generator Generator

Required. The generator to create.
generatorId String

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* 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.
Returns
Type Description
Generator

createGeneratorCallable()

public final UnaryCallable<CreateGeneratorRequest,Generator> createGeneratorCallable()

Creates a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   CreateGeneratorRequest request =
       CreateGeneratorRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setGenerator(Generator.newBuilder().build())
           .setGeneratorId("generatorId887044942")
           .build();
   ApiFuture<Generator> future = generatorsClient.createGeneratorCallable().futureCall(request);
   // Do something.
   Generator response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateGeneratorRequest,Generator>

deleteGenerator(DeleteGeneratorRequest request)

public final void deleteGenerator(DeleteGeneratorRequest request)

Deletes a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   DeleteGeneratorRequest request =
       DeleteGeneratorRequest.newBuilder()
           .setName(GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString())
           .build();
   generatorsClient.deleteGenerator(request);
 }
Parameter
Name Description
request DeleteGeneratorRequest

The request object containing all of the parameters for the API call.

deleteGenerator(GeneratorName name)

public final void deleteGenerator(GeneratorName name)

Deletes a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   GeneratorName name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]");
   generatorsClient.deleteGenerator(name);
 }
Parameter
Name Description
name GeneratorName

Required. The generator resource name to delete. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>

deleteGenerator(String name)

public final void deleteGenerator(String name)

Deletes a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   String name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString();
   generatorsClient.deleteGenerator(name);
 }
Parameter
Name Description
name String

Required. The generator resource name to delete. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>

deleteGeneratorCallable()

public final UnaryCallable<DeleteGeneratorRequest,Empty> deleteGeneratorCallable()

Deletes a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   DeleteGeneratorRequest request =
       DeleteGeneratorRequest.newBuilder()
           .setName(GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString())
           .build();
   ApiFuture<Empty> future = generatorsClient.deleteGeneratorCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteGeneratorRequest,Empty>

getGenerator(GeneratorName name)

public final Generator getGenerator(GeneratorName name)

Retrieves a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   GeneratorName name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]");
   Generator response = generatorsClient.getGenerator(name);
 }
Parameter
Name Description
name GeneratorName

Required. The generator resource name to retrieve. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
Returns
Type Description
Generator

getGenerator(GetGeneratorRequest request)

public final Generator getGenerator(GetGeneratorRequest request)

Retrieves a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   GetGeneratorRequest request =
       GetGeneratorRequest.newBuilder()
           .setName(GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString())
           .build();
   Generator response = generatorsClient.getGenerator(request);
 }
Parameter
Name Description
request GetGeneratorRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Generator

getGenerator(String name)

public final Generator getGenerator(String name)

Retrieves a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   String name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString();
   Generator response = generatorsClient.getGenerator(name);
 }
Parameter
Name Description
name String

Required. The generator resource name to retrieve. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
Returns
Type Description
Generator

getGeneratorCallable()

public final UnaryCallable<GetGeneratorRequest,Generator> getGeneratorCallable()

Retrieves a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   GetGeneratorRequest request =
       GetGeneratorRequest.newBuilder()
           .setName(GeneratorName.of("[PROJECT]", "[LOCATION]", "[GENERATOR]").toString())
           .build();
   ApiFuture<Generator> future = generatorsClient.getGeneratorCallable().futureCall(request);
   // Do something.
   Generator response = future.get();
 }
Returns
Type Description
UnaryCallable<GetGeneratorRequest,Generator>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = generatorsClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = generatorsClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final GeneratorsSettings getSettings()
Returns
Type Description
GeneratorsSettings

getStub()

public GeneratorsStub getStub()
Returns
Type Description
GeneratorsStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listGenerators(ListGeneratorsRequest request)

public final GeneratorsClient.ListGeneratorsPagedResponse listGenerators(ListGeneratorsRequest request)

Lists generators.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }
Parameter
Name Description
request ListGeneratorsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
GeneratorsClient.ListGeneratorsPagedResponse

listGenerators(ProjectName parent)

public final GeneratorsClient.ListGeneratorsPagedResponse listGenerators(ProjectName parent)

Lists generators.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Generator element : generatorsClient.listGenerators(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ProjectName

Required. The project/location to list generators for. Format: projects/<Project ID>/locations/<Location ID>
Returns
Type Description
GeneratorsClient.ListGeneratorsPagedResponse

listGenerators(String parent)

public final GeneratorsClient.ListGeneratorsPagedResponse listGenerators(String parent)

Lists generators.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Generator element : generatorsClient.listGenerators(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The project/location to list generators for. Format: projects/<Project ID>/locations/<Location ID>
Returns
Type Description
GeneratorsClient.ListGeneratorsPagedResponse

listGeneratorsCallable()

public final UnaryCallable<ListGeneratorsRequest,ListGeneratorsResponse> listGeneratorsCallable()

Lists generators.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListGeneratorsRequest,ListGeneratorsResponse>

listGeneratorsPagedCallable()

public final UnaryCallable<ListGeneratorsRequest,GeneratorsClient.ListGeneratorsPagedResponse> listGeneratorsPagedCallable()

Lists generators.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   ListGeneratorsRequest request =
       ListGeneratorsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Generator> future =
       generatorsClient.listGeneratorsPagedCallable().futureCall(request);
   // Do something.
   for (Generator element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListGeneratorsRequest,ListGeneratorsPagedResponse>

listLocations(ListLocationsRequest request)

public final GeneratorsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
GeneratorsClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,GeneratorsClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       generatorsClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateGenerator(Generator generator, FieldMask updateMask)

public final Generator updateGenerator(Generator generator, FieldMask updateMask)

Updates a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   Generator generator = Generator.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Generator response = generatorsClient.updateGenerator(generator, updateMask);
 }
Parameters
Name Description
generator Generator

Required. The generator to update. The name field of generator is to identify the generator to update.
updateMask FieldMask

Optional. The list of fields to update.
Returns
Type Description
Generator

updateGenerator(UpdateGeneratorRequest request)

public final Generator updateGenerator(UpdateGeneratorRequest request)

Updates a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   UpdateGeneratorRequest request =
       UpdateGeneratorRequest.newBuilder()
           .setGenerator(Generator.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Generator response = generatorsClient.updateGenerator(request);
 }
Parameter
Name Description
request UpdateGeneratorRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Generator

updateGeneratorCallable()

public final UnaryCallable<UpdateGeneratorRequest,Generator> updateGeneratorCallable()

Updates a generator.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
   UpdateGeneratorRequest request =
       UpdateGeneratorRequest.newBuilder()
           .setGenerator(Generator.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Generator> future = generatorsClient.updateGeneratorCallable().futureCall(request);
   // Do something.
   Generator response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateGeneratorRequest,Generator>