VizierServiceClient (Google Cloud Vertex AI 3.33.0 API)

java.lang.Object
- com.google.cloud.aiplatform.v1.VizierServiceClient

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

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

Service Description: Vertex AI Vizier API.

Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Study study = Study.newBuilder().build();
   Study response = vizierServiceClient.createStudy(parent, study);
 }

Note: close() needs to be called on the VizierServiceClient 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 VizierServiceSettings 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
 VizierServiceSettings vizierServiceSettings =
     VizierServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VizierServiceClient vizierServiceClient = VizierServiceClient.create(vizierServiceSettings);

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
 VizierServiceSettings vizierServiceSettings =
     VizierServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VizierServiceClient vizierServiceClient = VizierServiceClient.create(vizierServiceSettings);

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`	`VizierServiceClient.ListLocationsFixedSizeCollection`
`static class`	`VizierServiceClient.ListLocationsPage`
`static class`	`VizierServiceClient.ListLocationsPagedResponse`
`static class`	`VizierServiceClient.ListStudiesFixedSizeCollection`
`static class`	`VizierServiceClient.ListStudiesPage`
`static class`	`VizierServiceClient.ListStudiesPagedResponse`
`static class`	`VizierServiceClient.ListTrialsFixedSizeCollection`
`static class`	`VizierServiceClient.ListTrialsPage`
`static class`	`VizierServiceClient.ListTrialsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`VizierServiceClient(VizierServiceSettings settings)` Constructs an instance of VizierServiceClient, using the given settings.
`protected`	`VizierServiceClient(VizierServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Trial`	`addTrialMeasurement(AddTrialMeasurementRequest request)` Adds a measurement of the objective metrics to a Trial.
`com.google.api.gax.rpc.UnaryCallable<AddTrialMeasurementRequest,Trial>`	`addTrialMeasurementCallable()` Adds a measurement of the objective metrics to a Trial.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`com.google.api.gax.longrunning.OperationFuture<CheckTrialEarlyStoppingStateResponse,CheckTrialEarlyStoppingStateMetatdata>`	`checkTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest request)` Checks whether a Trial should stop or not.
`com.google.api.gax.rpc.UnaryCallable<CheckTrialEarlyStoppingStateRequest,com.google.longrunning.Operation>`	`checkTrialEarlyStoppingStateCallable()` Checks whether a Trial should stop or not.
`com.google.api.gax.rpc.OperationCallable<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse,CheckTrialEarlyStoppingStateMetatdata>`	`checkTrialEarlyStoppingStateOperationCallable()` Checks whether a Trial should stop or not.
`void`	`close()`
`Trial`	`completeTrial(CompleteTrialRequest request)` Marks a Trial as complete.
`com.google.api.gax.rpc.UnaryCallable<CompleteTrialRequest,Trial>`	`completeTrialCallable()` Marks a Trial as complete.
`static VizierServiceClient`	`create()` Constructs an instance of VizierServiceClient with default settings.
`static VizierServiceClient`	`create(VizierServiceSettings settings)` Constructs an instance of VizierServiceClient, using the given settings.
`static VizierServiceClient`	`create(VizierServiceStub stub)` Constructs an instance of VizierServiceClient, using the given stub for making calls.
`Study`	`createStudy(CreateStudyRequest request)` Creates a Study.
`Study`	`createStudy(LocationName parent, Study study)` Creates a Study.
`Study`	`createStudy(String parent, Study study)` Creates a Study.
`com.google.api.gax.rpc.UnaryCallable<CreateStudyRequest,Study>`	`createStudyCallable()` Creates a Study.
`Trial`	`createTrial(CreateTrialRequest request)` Adds a user provided Trial to a Study.
`Trial`	`createTrial(String parent, Trial trial)` Adds a user provided Trial to a Study.
`Trial`	`createTrial(StudyName parent, Trial trial)` Adds a user provided Trial to a Study.
`com.google.api.gax.rpc.UnaryCallable<CreateTrialRequest,Trial>`	`createTrialCallable()` Adds a user provided Trial to a Study.
`void`	`deleteStudy(DeleteStudyRequest request)` Deletes a Study.
`void`	`deleteStudy(String name)` Deletes a Study.
`void`	`deleteStudy(StudyName name)` Deletes a Study.
`com.google.api.gax.rpc.UnaryCallable<DeleteStudyRequest,com.google.protobuf.Empty>`	`deleteStudyCallable()` Deletes a Study.
`void`	`deleteTrial(DeleteTrialRequest request)` Deletes a Trial.
`void`	`deleteTrial(String name)` Deletes a Trial.
`void`	`deleteTrial(TrialName name)` Deletes a Trial.
`com.google.api.gax.rpc.UnaryCallable<DeleteTrialRequest,com.google.protobuf.Empty>`	`deleteTrialCallable()` Deletes a Trial.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`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.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`VizierServiceSettings`	`getSettings()`
`VizierServiceStub`	`getStub()`
`Study`	`getStudy(GetStudyRequest request)` Gets a Study by name.
`Study`	`getStudy(String name)` Gets a Study by name.
`Study`	`getStudy(StudyName name)` Gets a Study by name.
`com.google.api.gax.rpc.UnaryCallable<GetStudyRequest,Study>`	`getStudyCallable()` Gets a Study by name.
`Trial`	`getTrial(GetTrialRequest request)` Gets a Trial.
`Trial`	`getTrial(String name)` Gets a Trial.
`Trial`	`getTrial(TrialName name)` Gets a Trial.
`com.google.api.gax.rpc.UnaryCallable<GetTrialRequest,Trial>`	`getTrialCallable()` Gets a Trial.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`VizierServiceClient.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,VizierServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`ListOptimalTrialsResponse`	`listOptimalTrials(ListOptimalTrialsRequest request)` Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
`ListOptimalTrialsResponse`	`listOptimalTrials(String parent)` Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
`ListOptimalTrialsResponse`	`listOptimalTrials(StudyName parent)` Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
`com.google.api.gax.rpc.UnaryCallable<ListOptimalTrialsRequest,ListOptimalTrialsResponse>`	`listOptimalTrialsCallable()` Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
`VizierServiceClient.ListStudiesPagedResponse`	`listStudies(ListStudiesRequest request)` Lists all the studies in a region for an associated project.
`VizierServiceClient.ListStudiesPagedResponse`	`listStudies(LocationName parent)` Lists all the studies in a region for an associated project.
`VizierServiceClient.ListStudiesPagedResponse`	`listStudies(String parent)` Lists all the studies in a region for an associated project.
`com.google.api.gax.rpc.UnaryCallable<ListStudiesRequest,ListStudiesResponse>`	`listStudiesCallable()` Lists all the studies in a region for an associated project.
`com.google.api.gax.rpc.UnaryCallable<ListStudiesRequest,VizierServiceClient.ListStudiesPagedResponse>`	`listStudiesPagedCallable()` Lists all the studies in a region for an associated project.
`VizierServiceClient.ListTrialsPagedResponse`	`listTrials(ListTrialsRequest request)` Lists the Trials associated with a Study.
`VizierServiceClient.ListTrialsPagedResponse`	`listTrials(String parent)` Lists the Trials associated with a Study.
`VizierServiceClient.ListTrialsPagedResponse`	`listTrials(StudyName parent)` Lists the Trials associated with a Study.
`com.google.api.gax.rpc.UnaryCallable<ListTrialsRequest,ListTrialsResponse>`	`listTrialsCallable()` Lists the Trials associated with a Study.
`com.google.api.gax.rpc.UnaryCallable<ListTrialsRequest,VizierServiceClient.ListTrialsPagedResponse>`	`listTrialsPagedCallable()` Lists the Trials associated with a Study.
`Study`	`lookupStudy(LocationName parent)` Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
`Study`	`lookupStudy(LookupStudyRequest request)` Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
`Study`	`lookupStudy(String parent)` Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
`com.google.api.gax.rpc.UnaryCallable<LookupStudyRequest,Study>`	`lookupStudyCallable()` Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Trial`	`stopTrial(StopTrialRequest request)` Stops a Trial.
`com.google.api.gax.rpc.UnaryCallable<StopTrialRequest,Trial>`	`stopTrialCallable()` Stops a Trial.
`com.google.api.gax.longrunning.OperationFuture<SuggestTrialsResponse,SuggestTrialsMetadata>`	`suggestTrialsAsync(SuggestTrialsRequest request)` Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
`com.google.api.gax.rpc.UnaryCallable<SuggestTrialsRequest,com.google.longrunning.Operation>`	`suggestTrialsCallable()` Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
`com.google.api.gax.rpc.OperationCallable<SuggestTrialsRequest,SuggestTrialsResponse,SuggestTrialsMetadata>`	`suggestTrialsOperationCallable()` Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.

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

Constructor Detail
- VizierServiceClient
```
protected VizierServiceClient(VizierServiceSettings settings)
                       throws IOException
```
  Constructs an instance of VizierServiceClient, 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
- VizierServiceClient
```
protected VizierServiceClient(VizierServiceStub stub)
```

Method Detail

create

public static final VizierServiceClient create()
                                        throws IOException

Constructs an instance of VizierServiceClient with default settings.

Throws:: IOException

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

getSettings

public final VizierServiceSettings getSettings()

getStub
```
public VizierServiceStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createStudy

public final Study createStudy(LocationName parent,
                               Study study)

Creates a Study. A resource name will be generated after creation of the Study.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Study study = Study.newBuilder().build();
   Study response = vizierServiceClient.createStudy(parent, study);
 }

Parameters:: parent - Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`; study - Required. The Study configuration used to create the Study.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createStudy

public final Study createStudy(String parent,
                               Study study)

Creates a Study. A resource name will be generated after creation of the Study.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Study study = Study.newBuilder().build();
   Study response = vizierServiceClient.createStudy(parent, study);
 }

Parameters:: parent - Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`; study - Required. The Study configuration used to create the Study.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createStudy

public final Study createStudy(CreateStudyRequest request)

Creates a Study. A resource name will be generated after creation of the Study.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   CreateStudyRequest request =
       CreateStudyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setStudy(Study.newBuilder().build())
           .build();
   Study response = vizierServiceClient.createStudy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createStudyCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateStudyRequest,Study> createStudyCallable()

Creates a Study. A resource name will be generated after creation of the Study.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   CreateStudyRequest request =
       CreateStudyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setStudy(Study.newBuilder().build())
           .build();
   ApiFuture<Study> future = vizierServiceClient.createStudyCallable().futureCall(request);
   // Do something.
   Study response = future.get();
 }

getStudy

public final Study getStudy(StudyName name)

Gets a Study by name.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   StudyName name = StudyName.of("[PROJECT]", "[LOCATION]", "[STUDY]");
   Study response = vizierServiceClient.getStudy(name);
 }

Parameters:: name - Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getStudy

public final Study getStudy(String name)

Gets a Study by name.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   String name = StudyName.of("[PROJECT]", "[LOCATION]", "[STUDY]").toString();
   Study response = vizierServiceClient.getStudy(name);
 }

Parameters:: name - Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getStudy

public final Study getStudy(GetStudyRequest request)

Gets a Study by name.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   GetStudyRequest request =
       GetStudyRequest.newBuilder()
           .setName(StudyName.of("[PROJECT]", "[LOCATION]", "[STUDY]").toString())
           .build();
   Study response = vizierServiceClient.getStudy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getStudyCallable

public final com.google.api.gax.rpc.UnaryCallable<GetStudyRequest,Study> getStudyCallable()

Gets a Study by name.

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 (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
   GetStudyRequest request =
       GetStudyRequest.newBuilder()
           .setName(StudyName.of("[PROJECT]", "[LOCATION]", "[STUDY]").toString())
           .build();
   ApiFuture<Study> future = vizierServiceClient.getStudyCallable().futureCall(request);
   // Do something.
   Study response = future.get();
 }