GeneratorsClient (Google Dialogflow CX 0.71.0 API)

java.lang.Object
- com.google.cloud.dialogflow.cx.v3beta1.GeneratorsClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class GeneratorsClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing [Generators][google.cloud.dialogflow.cx.v3beta1.Generator]

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()) {
   GeneratorName name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[GENERATOR]");
   Generator response = generatorsClient.getGenerator(name);
 }

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
ListGenerators	Returns the list of all generators in the specified agent.	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(AgentName 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()
GetGenerator	Retrieves the specified 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()
CreateGenerator	Creates a generator in the specified agent.	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(AgentName parent, Generator generator) createGenerator(String parent, Generator generator) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createGeneratorCallable()
UpdateGenerator	Update the specified 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()
DeleteGenerator	Deletes the specified generators.	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()
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GeneratorsClient.ListGeneratorsFixedSizeCollection`
`static class`	`GeneratorsClient.ListGeneratorsPage`
`static class`	`GeneratorsClient.ListGeneratorsPagedResponse`
`static class`	`GeneratorsClient.ListLocationsFixedSizeCollection`
`static class`	`GeneratorsClient.ListLocationsPage`
`static class`	`GeneratorsClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GeneratorsClient(GeneratorsSettings settings)` Constructs an instance of GeneratorsClient, using the given settings.
`protected`	`GeneratorsClient(GeneratorsStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static GeneratorsClient`	`create()` Constructs an instance of GeneratorsClient with default settings.
`static GeneratorsClient`	`create(GeneratorsSettings settings)` Constructs an instance of GeneratorsClient, using the given settings.
`static GeneratorsClient`	`create(GeneratorsStub stub)` Constructs an instance of GeneratorsClient, using the given stub for making calls.
`Generator`	`createGenerator(AgentName parent, Generator generator)` Creates a generator in the specified agent.
`Generator`	`createGenerator(CreateGeneratorRequest request)` Creates a generator in the specified agent.
`Generator`	`createGenerator(String parent, Generator generator)` Creates a generator in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<CreateGeneratorRequest,Generator>`	`createGeneratorCallable()` Creates a generator in the specified agent.
`void`	`deleteGenerator(DeleteGeneratorRequest request)` Deletes the specified generators.
`void`	`deleteGenerator(GeneratorName name)` Deletes the specified generators.
`void`	`deleteGenerator(String name)` Deletes the specified generators.
`com.google.api.gax.rpc.UnaryCallable<DeleteGeneratorRequest,com.google.protobuf.Empty>`	`deleteGeneratorCallable()` Deletes the specified generators.
`Generator`	`getGenerator(GeneratorName name)` Retrieves the specified generator.
`Generator`	`getGenerator(GetGeneratorRequest request)` Retrieves the specified generator.
`Generator`	`getGenerator(String name)` Retrieves the specified generator.
`com.google.api.gax.rpc.UnaryCallable<GetGeneratorRequest,Generator>`	`getGeneratorCallable()` Retrieves the specified generator.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`GeneratorsSettings`	`getSettings()`
`GeneratorsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`GeneratorsClient.ListGeneratorsPagedResponse`	`listGenerators(AgentName parent)` Returns the list of all generators in the specified agent.
`GeneratorsClient.ListGeneratorsPagedResponse`	`listGenerators(ListGeneratorsRequest request)` Returns the list of all generators in the specified agent.
`GeneratorsClient.ListGeneratorsPagedResponse`	`listGenerators(String parent)` Returns the list of all generators in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<ListGeneratorsRequest,ListGeneratorsResponse>`	`listGeneratorsCallable()` Returns the list of all generators in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<ListGeneratorsRequest,GeneratorsClient.ListGeneratorsPagedResponse>`	`listGeneratorsPagedCallable()` Returns the list of all generators in the specified agent.
`GeneratorsClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,GeneratorsClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Generator`	`updateGenerator(Generator generator, com.google.protobuf.FieldMask updateMask)` Update the specified generator.
`Generator`	`updateGenerator(UpdateGeneratorRequest request)` Update the specified generator.
`com.google.api.gax.rpc.UnaryCallable<UpdateGeneratorRequest,Generator>`	`updateGeneratorCallable()` Update the specified generator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- GeneratorsClient
```
protected GeneratorsClient(GeneratorsSettings settings)
                    throws IOException
```
  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.
  
  Throws:
  
  IOException
- GeneratorsClient
```
protected GeneratorsClient(GeneratorsStub stub)
```

Method Detail

create

public static final GeneratorsClient create()
                                     throws IOException

Constructs an instance of GeneratorsClient with default settings.

Throws:: IOException

create
```
public static final GeneratorsClient create(GeneratorsSettings settings)
                                     throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final GeneratorsSettings getSettings()

getStub
```
public GeneratorsStub getStub()
```