- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: Service for managing Experiments.
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
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.
Static Methods
create()
public static final ExperimentsClient create()
Constructs an instance of ExperimentsClient with default settings.
Returns | |
---|---|
Type | Description |
ExperimentsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ExperimentsSettings settings)
public static final ExperimentsClient create(ExperimentsSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
ExperimentsSettings |
Returns | |
---|---|
Type | Description |
ExperimentsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ExperimentsStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
ExperimentsStub |
Returns | |
---|---|
Type | Description |
ExperimentsClient |
Constructors
ExperimentsClient(ExperimentsSettings settings)
protected ExperimentsClient(ExperimentsSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
ExperimentsSettings |
ExperimentsClient(ExperimentsStub stub)
protected ExperimentsClient(ExperimentsStub stub)
Parameter | |
---|---|
Name | Description |
stub |
ExperimentsStub |
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()
createExperiment(CreateExperimentRequest request)
public final Experiment createExperiment(CreateExperimentRequest request)
Creates an Experiment in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
CreateExperimentRequest request =
CreateExperimentRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setExperiment(Experiment.newBuilder().build())
.build();
Experiment response = experimentsClient.createExperiment(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreateExperimentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Experiment |
createExperiment(EnvironmentName parent, Experiment experiment)
public final Experiment createExperiment(EnvironmentName parent, Experiment experiment)
Creates an Experiment in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
EnvironmentName parent =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
Experiment experiment = Experiment.newBuilder().build();
Experiment response = experimentsClient.createExperiment(parent, experiment);
}
Parameters | |
---|---|
Name | Description |
parent |
EnvironmentName Required. The Agent to create an
Environment for. Format: |
experiment |
Experiment Required. The experiment to create. |
Returns | |
---|---|
Type | Description |
Experiment |
createExperiment(String parent, Experiment experiment)
public final Experiment createExperiment(String parent, Experiment experiment)
Creates an Experiment in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
String parent =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
Experiment experiment = Experiment.newBuilder().build();
Experiment response = experimentsClient.createExperiment(parent, experiment);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The Agent to create an
Environment for. Format: |
experiment |
Experiment Required. The experiment to create. |
Returns | |
---|---|
Type | Description |
Experiment |
createExperimentCallable()
public final UnaryCallable<CreateExperimentRequest,Experiment> createExperimentCallable()
Creates an Experiment in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
CreateExperimentRequest request =
CreateExperimentRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setExperiment(Experiment.newBuilder().build())
.build();
ApiFuture<Experiment> future =
experimentsClient.createExperimentCallable().futureCall(request);
// Do something.
Experiment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateExperimentRequest,Experiment> |
deleteExperiment(DeleteExperimentRequest request)
public final void deleteExperiment(DeleteExperimentRequest request)
Deletes the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
DeleteExperimentRequest request =
DeleteExperimentRequest.newBuilder()
.setName(
ExperimentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString())
.build();
experimentsClient.deleteExperiment(request);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteExperimentRequest The request object containing all of the parameters for the API call. |
deleteExperiment(ExperimentName name)
public final void deleteExperiment(ExperimentName name)
Deletes the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ExperimentName name =
ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]");
experimentsClient.deleteExperiment(name);
}
Parameter | |
---|---|
Name | Description |
name |
ExperimentName Required. The name of the Environment
to delete. Format: |
deleteExperiment(String name)
public final void deleteExperiment(String name)
Deletes the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
String name =
ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString();
experimentsClient.deleteExperiment(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the Environment
to delete. Format: |
deleteExperimentCallable()
public final UnaryCallable<DeleteExperimentRequest,Empty> deleteExperimentCallable()
Deletes the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
DeleteExperimentRequest request =
DeleteExperimentRequest.newBuilder()
.setName(
ExperimentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString())
.build();
ApiFuture<Empty> future = experimentsClient.deleteExperimentCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteExperimentRequest,Empty> |
getExperiment(ExperimentName name)
public final Experiment getExperiment(ExperimentName name)
Retrieves the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ExperimentName name =
ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]");
Experiment response = experimentsClient.getExperiment(name);
}
Parameter | |
---|---|
Name | Description |
name |
ExperimentName Required. The name of the Environment.
Format: |
Returns | |
---|---|
Type | Description |
Experiment |
getExperiment(GetExperimentRequest request)
public final Experiment getExperiment(GetExperimentRequest request)
Retrieves the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
GetExperimentRequest request =
GetExperimentRequest.newBuilder()
.setName(
ExperimentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString())
.build();
Experiment response = experimentsClient.getExperiment(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetExperimentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Experiment |
getExperiment(String name)
public final Experiment getExperiment(String name)
Retrieves the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
String name =
ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString();
Experiment response = experimentsClient.getExperiment(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the Environment.
Format: |
Returns | |
---|---|
Type | Description |
Experiment |
getExperimentCallable()
public final UnaryCallable<GetExperimentRequest,Experiment> getExperimentCallable()
Retrieves the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
GetExperimentRequest request =
GetExperimentRequest.newBuilder()
.setName(
ExperimentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString())
.build();
ApiFuture<Experiment> future = experimentsClient.getExperimentCallable().futureCall(request);
// Do something.
Experiment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetExperimentRequest,Experiment> |
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = experimentsClient.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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = experimentsClient.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 ExperimentsSettings getSettings()
Returns | |
---|---|
Type | Description |
ExperimentsSettings |
getStub()
public ExperimentsStub getStub()
Returns | |
---|---|
Type | Description |
ExperimentsStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listExperiments(EnvironmentName parent)
public final ExperimentsClient.ListExperimentsPagedResponse listExperiments(EnvironmentName parent)
Returns the list of all experiments in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
EnvironmentName parent =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
for (Experiment element : experimentsClient.listExperiments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
EnvironmentName Required. The Environment to list
all environments for. Format: |
Returns | |
---|---|
Type | Description |
ExperimentsClient.ListExperimentsPagedResponse |
listExperiments(ListExperimentsRequest request)
public final ExperimentsClient.ListExperimentsPagedResponse listExperiments(ListExperimentsRequest request)
Returns the list of all experiments in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ListExperimentsRequest request =
ListExperimentsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Experiment element : experimentsClient.listExperiments(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListExperimentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ExperimentsClient.ListExperimentsPagedResponse |
listExperiments(String parent)
public final ExperimentsClient.ListExperimentsPagedResponse listExperiments(String parent)
Returns the list of all experiments in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
String parent =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
for (Experiment element : experimentsClient.listExperiments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The Environment to list
all environments for. Format: |
Returns | |
---|---|
Type | Description |
ExperimentsClient.ListExperimentsPagedResponse |
listExperimentsCallable()
public final UnaryCallable<ListExperimentsRequest,ListExperimentsResponse> listExperimentsCallable()
Returns the list of all experiments in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ListExperimentsRequest request =
ListExperimentsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListExperimentsResponse response =
experimentsClient.listExperimentsCallable().call(request);
for (Experiment element : response.getExperimentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListExperimentsRequest,ListExperimentsResponse> |
listExperimentsPagedCallable()
public final UnaryCallable<ListExperimentsRequest,ExperimentsClient.ListExperimentsPagedResponse> listExperimentsPagedCallable()
Returns the list of all experiments in the specified Environment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ListExperimentsRequest request =
ListExperimentsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Experiment> future =
experimentsClient.listExperimentsPagedCallable().futureCall(request);
// Do something.
for (Experiment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListExperimentsRequest,ListExperimentsPagedResponse> |
listLocations(ListLocationsRequest request)
public final ExperimentsClient.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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : experimentsClient.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 |
ExperimentsClient.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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = experimentsClient.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,ExperimentsClient.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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
experimentsClient.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()
startExperiment(ExperimentName name)
public final Experiment startExperiment(ExperimentName name)
Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ExperimentName name =
ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]");
Experiment response = experimentsClient.startExperiment(name);
}
Parameter | |
---|---|
Name | Description |
name |
ExperimentName Required. Resource name of the experiment to start. Format: |
Returns | |
---|---|
Type | Description |
Experiment |
startExperiment(StartExperimentRequest request)
public final Experiment startExperiment(StartExperimentRequest request)
Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
StartExperimentRequest request =
StartExperimentRequest.newBuilder()
.setName(
ExperimentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString())
.build();
Experiment response = experimentsClient.startExperiment(request);
}
Parameter | |
---|---|
Name | Description |
request |
StartExperimentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Experiment |
startExperiment(String name)
public final Experiment startExperiment(String name)
Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
String name =
ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString();
Experiment response = experimentsClient.startExperiment(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Resource name of the experiment to start. Format: |
Returns | |
---|---|
Type | Description |
Experiment |
startExperimentCallable()
public final UnaryCallable<StartExperimentRequest,Experiment> startExperimentCallable()
Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
StartExperimentRequest request =
StartExperimentRequest.newBuilder()
.setName(
ExperimentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString())
.build();
ApiFuture<Experiment> future =
experimentsClient.startExperimentCallable().futureCall(request);
// Do something.
Experiment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StartExperimentRequest,Experiment> |
stopExperiment(ExperimentName name)
public final Experiment stopExperiment(ExperimentName name)
Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
ExperimentName name =
ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]");
Experiment response = experimentsClient.stopExperiment(name);
}
Parameter | |
---|---|
Name | Description |
name |
ExperimentName Required. Resource name of the experiment to stop. Format: |
Returns | |
---|---|
Type | Description |
Experiment |
stopExperiment(StopExperimentRequest request)
public final Experiment stopExperiment(StopExperimentRequest request)
Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
StopExperimentRequest request =
StopExperimentRequest.newBuilder()
.setName(
ExperimentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString())
.build();
Experiment response = experimentsClient.stopExperiment(request);
}
Parameter | |
---|---|
Name | Description |
request |
StopExperimentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Experiment |
stopExperiment(String name)
public final Experiment stopExperiment(String name)
Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
String name =
ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString();
Experiment response = experimentsClient.stopExperiment(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Resource name of the experiment to stop. Format: |
Returns | |
---|---|
Type | Description |
Experiment |
stopExperimentCallable()
public final UnaryCallable<StopExperimentRequest,Experiment> stopExperimentCallable()
Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
StopExperimentRequest request =
StopExperimentRequest.newBuilder()
.setName(
ExperimentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]")
.toString())
.build();
ApiFuture<Experiment> future = experimentsClient.stopExperimentCallable().futureCall(request);
// Do something.
Experiment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StopExperimentRequest,Experiment> |
updateExperiment(Experiment experiment, FieldMask updateMask)
public final Experiment updateExperiment(Experiment experiment, FieldMask updateMask)
Updates the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
Experiment experiment = Experiment.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Experiment response = experimentsClient.updateExperiment(experiment, updateMask);
}
Parameters | |
---|---|
Name | Description |
experiment |
Experiment Required. The experiment to update. |
updateMask |
FieldMask Required. The mask to control which fields get updated. |
Returns | |
---|---|
Type | Description |
Experiment |
updateExperiment(UpdateExperimentRequest request)
public final Experiment updateExperiment(UpdateExperimentRequest request)
Updates the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
UpdateExperimentRequest request =
UpdateExperimentRequest.newBuilder()
.setExperiment(Experiment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Experiment response = experimentsClient.updateExperiment(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateExperimentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Experiment |
updateExperimentCallable()
public final UnaryCallable<UpdateExperimentRequest,Experiment> updateExperimentCallable()
Updates the specified Experiment.
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 (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
UpdateExperimentRequest request =
UpdateExperimentRequest.newBuilder()
.setExperiment(Experiment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Experiment> future =
experimentsClient.updateExperimentCallable().futureCall(request);
// Do something.
Experiment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateExperimentRequest,Experiment> |