ExperimentsClient (Google Dialogflow CX 0.71.0 API)

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

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

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

Service Description: Service for managing [Experiments][google.cloud.dialogflow.cx.v3beta1.Experiment].

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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
   ExperimentName name =
       ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]");
   Experiment response = experimentsClient.getExperiment(name);
 }

Note: close() needs to be called on the ExperimentsClient 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
ListExperiments	Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].	Request object method variants only take one parameter, a request object, which must be constructed before the call. listExperiments(ListExperimentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listExperiments(EnvironmentName parent) listExperiments(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. listExperimentsPagedCallable() listExperimentsCallable()
GetExperiment	Retrieves the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getExperiment(GetExperimentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getExperiment(ExperimentName name) getExperiment(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. getExperimentCallable()
CreateExperiment	Creates an [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment] in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].	Request object method variants only take one parameter, a request object, which must be constructed before the call. createExperiment(CreateExperimentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createExperiment(EnvironmentName parent, Experiment experiment) createExperiment(String parent, Experiment experiment) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createExperimentCallable()
UpdateExperiment	Updates the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateExperiment(UpdateExperimentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateExperiment(Experiment experiment, 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. updateExperimentCallable()
DeleteExperiment	Deletes the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteExperiment(DeleteExperimentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteExperiment(ExperimentName name) deleteExperiment(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. deleteExperimentCallable()
StartExperiment	Starts the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment]. This rpc only changes the state of experiment from PENDING to RUNNING.	Request object method variants only take one parameter, a request object, which must be constructed before the call. startExperiment(StartExperimentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. startExperiment(ExperimentName name) startExperiment(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. startExperimentCallable()
StopExperiment	Stops the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment]. This rpc only changes the state of experiment from RUNNING to DONE.	Request object method variants only take one parameter, a request object, which must be constructed before the call. stopExperiment(StopExperimentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. stopExperiment(ExperimentName name) stopExperiment(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. stopExperimentCallable()
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 ExperimentsSettings 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
 ExperimentsSettings experimentsSettings =
     ExperimentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ExperimentsClient experimentsClient = ExperimentsClient.create(experimentsSettings);

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
 ExperimentsSettings experimentsSettings =
     ExperimentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ExperimentsClient experimentsClient = ExperimentsClient.create(experimentsSettings);

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
 ExperimentsSettings experimentsSettings = ExperimentsSettings.newHttpJsonBuilder().build();
 ExperimentsClient experimentsClient = ExperimentsClient.create(experimentsSettings);

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`	`ExperimentsClient.ListExperimentsFixedSizeCollection`
`static class`	`ExperimentsClient.ListExperimentsPage`
`static class`	`ExperimentsClient.ListExperimentsPagedResponse`
`static class`	`ExperimentsClient.ListLocationsFixedSizeCollection`
`static class`	`ExperimentsClient.ListLocationsPage`
`static class`	`ExperimentsClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ExperimentsClient(ExperimentsSettings settings)` Constructs an instance of ExperimentsClient, using the given settings.
`protected`	`ExperimentsClient(ExperimentsStub 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 ExperimentsClient`	`create()` Constructs an instance of ExperimentsClient with default settings.
`static ExperimentsClient`	`create(ExperimentsSettings settings)` Constructs an instance of ExperimentsClient, using the given settings.
`static ExperimentsClient`	`create(ExperimentsStub stub)` Constructs an instance of ExperimentsClient, using the given stub for making calls.
`Experiment`	`createExperiment(CreateExperimentRequest request)` Creates an [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment] in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`Experiment`	`createExperiment(EnvironmentName parent, Experiment experiment)` Creates an [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment] in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`Experiment`	`createExperiment(String parent, Experiment experiment)` Creates an [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment] in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`com.google.api.gax.rpc.UnaryCallable<CreateExperimentRequest,Experiment>`	`createExperimentCallable()` Creates an [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment] in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`void`	`deleteExperiment(DeleteExperimentRequest request)` Deletes the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`void`	`deleteExperiment(ExperimentName name)` Deletes the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`void`	`deleteExperiment(String name)` Deletes the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`com.google.api.gax.rpc.UnaryCallable<DeleteExperimentRequest,com.google.protobuf.Empty>`	`deleteExperimentCallable()` Deletes the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`getExperiment(ExperimentName name)` Retrieves the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`getExperiment(GetExperimentRequest request)` Retrieves the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`getExperiment(String name)` Retrieves the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`com.google.api.gax.rpc.UnaryCallable<GetExperimentRequest,Experiment>`	`getExperimentCallable()` Retrieves the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`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.
`ExperimentsSettings`	`getSettings()`
`ExperimentsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ExperimentsClient.ListExperimentsPagedResponse`	`listExperiments(EnvironmentName parent)` Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`ExperimentsClient.ListExperimentsPagedResponse`	`listExperiments(ListExperimentsRequest request)` Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`ExperimentsClient.ListExperimentsPagedResponse`	`listExperiments(String parent)` Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`com.google.api.gax.rpc.UnaryCallable<ListExperimentsRequest,ListExperimentsResponse>`	`listExperimentsCallable()` Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`com.google.api.gax.rpc.UnaryCallable<ListExperimentsRequest,ExperimentsClient.ListExperimentsPagedResponse>`	`listExperimentsPagedCallable()` Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
`ExperimentsClient.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,ExperimentsClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Experiment`	`startExperiment(ExperimentName name)` Starts the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`startExperiment(StartExperimentRequest request)` Starts the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`startExperiment(String name)` Starts the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`com.google.api.gax.rpc.UnaryCallable<StartExperimentRequest,Experiment>`	`startExperimentCallable()` Starts the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`stopExperiment(ExperimentName name)` Stops the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`stopExperiment(StopExperimentRequest request)` Stops the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`stopExperiment(String name)` Stops the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`com.google.api.gax.rpc.UnaryCallable<StopExperimentRequest,Experiment>`	`stopExperimentCallable()` Stops the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`updateExperiment(Experiment experiment, com.google.protobuf.FieldMask updateMask)` Updates the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`Experiment`	`updateExperiment(UpdateExperimentRequest request)` Updates the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].
`com.google.api.gax.rpc.UnaryCallable<UpdateExperimentRequest,Experiment>`	`updateExperimentCallable()` Updates the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].

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

Constructor Detail
- ExperimentsClient
```
protected ExperimentsClient(ExperimentsSettings settings)
                     throws IOException
```
  Constructs an instance of ExperimentsClient, 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
- ExperimentsClient
```
protected ExperimentsClient(ExperimentsStub stub)
```

Method Detail

create

public static final ExperimentsClient create()
                                      throws IOException

Constructs an instance of ExperimentsClient with default settings.

Throws:: IOException

create
```
public static final ExperimentsClient create(ExperimentsSettings settings)
                                      throws IOException
```
Constructs an instance of ExperimentsClient, 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 ExperimentsClient create(ExperimentsStub stub)
```
Constructs an instance of ExperimentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ExperimentsSettings).

getSettings

public final ExperimentsSettings getSettings()

getStub
```
public ExperimentsStub getStub()
```