- 2.50.0 (latest)
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public class ModelServiceClient implements BackgroundResource
Service Description: Service for performing CRUD operations on models. Recommendation models
contain all the metadata necessary to generate a set of models for the Predict()
API. A model
is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g.
Frequently Bought Together on Home Page).
This service allows you to do the following:
- Initiate training of a model.
- Pause training of an existing model.
- List all the available models along with their metadata.
- Control their tuning schedule.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]");
Model response = modelServiceClient.getModel(name);
}
Note: close() needs to be called on the ModelServiceClient 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 ModelServiceSettings 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
ModelServiceSettings modelServiceSettings =
ModelServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
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
ModelServiceSettings modelServiceSettings =
ModelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
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
ModelServiceSettings modelServiceSettings = ModelServiceSettings.newHttpJsonBuilder().build();
ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final ModelServiceClient create()
Constructs an instance of ModelServiceClient with default settings.
Returns | |
---|---|
Type | Description |
ModelServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ModelServiceSettings settings)
public static final ModelServiceClient create(ModelServiceSettings settings)
Constructs an instance of ModelServiceClient, 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 | ModelServiceSettings |
Returns | |
---|---|
Type | Description |
ModelServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ModelServiceStub stub)
public static final ModelServiceClient create(ModelServiceStub stub)
Constructs an instance of ModelServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ModelServiceSettings).
Parameter | |
---|---|
Name | Description |
stub | ModelServiceStub |
Returns | |
---|---|
Type | Description |
ModelServiceClient |
Constructors
ModelServiceClient(ModelServiceSettings settings)
protected ModelServiceClient(ModelServiceSettings settings)
Constructs an instance of ModelServiceClient, 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 | ModelServiceSettings |
ModelServiceClient(ModelServiceStub stub)
protected ModelServiceClient(ModelServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | ModelServiceStub |
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()
createModelAsync(CatalogName parent, Model model)
public final OperationFuture<Model,CreateModelMetadata> createModelAsync(CatalogName parent, Model model)
Creates a new model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
Model model = Model.newBuilder().build();
Model response = modelServiceClient.createModelAsync(parent, model).get();
}
Parameters | |
---|---|
Name | Description |
parent | CatalogName Required. The parent resource under which to create the model. Format:
|
model | Model Required. The payload of the Model to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<Model,CreateModelMetadata> |
createModelAsync(CreateModelRequest request)
public final OperationFuture<Model,CreateModelMetadata> createModelAsync(CreateModelRequest request)
Creates a new model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
CreateModelRequest request =
CreateModelRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
.setModel(Model.newBuilder().build())
.setDryRun(true)
.build();
Model response = modelServiceClient.createModelAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateModelRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Model,CreateModelMetadata> |
createModelAsync(String parent, Model model)
public final OperationFuture<Model,CreateModelMetadata> createModelAsync(String parent, Model model)
Creates a new model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
Model model = Model.newBuilder().build();
Model response = modelServiceClient.createModelAsync(parent, model).get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent resource under which to create the model. Format:
|
model | Model Required. The payload of the Model to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<Model,CreateModelMetadata> |
createModelCallable()
public final UnaryCallable<CreateModelRequest,Operation> createModelCallable()
Creates a new model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
CreateModelRequest request =
CreateModelRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
.setModel(Model.newBuilder().build())
.setDryRun(true)
.build();
ApiFuture<Operation> future = modelServiceClient.createModelCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateModelRequest,Operation> |
createModelOperationCallable()
public final OperationCallable<CreateModelRequest,Model,CreateModelMetadata> createModelOperationCallable()
Creates a new model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
CreateModelRequest request =
CreateModelRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
.setModel(Model.newBuilder().build())
.setDryRun(true)
.build();
OperationFuture<Model, CreateModelMetadata> future =
modelServiceClient.createModelOperationCallable().futureCall(request);
// Do something.
Model response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateModelRequest,Model,CreateModelMetadata> |
deleteModel(DeleteModelRequest request)
public final void deleteModel(DeleteModelRequest request)
Deletes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
DeleteModelRequest request =
DeleteModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
modelServiceClient.deleteModel(request);
}
Parameter | |
---|---|
Name | Description |
request | DeleteModelRequest The request object containing all of the parameters for the API call. |
deleteModel(ModelName name)
public final void deleteModel(ModelName name)
Deletes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]");
modelServiceClient.deleteModel(name);
}
Parameter | |
---|---|
Name | Description |
name | ModelName Required. The resource name of the Model to
delete. Format:
|
deleteModel(String name)
public final void deleteModel(String name)
Deletes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString();
modelServiceClient.deleteModel(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The resource name of the Model to
delete. Format:
|
deleteModelCallable()
public final UnaryCallable<DeleteModelRequest,Empty> deleteModelCallable()
Deletes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
DeleteModelRequest request =
DeleteModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
ApiFuture<Empty> future = modelServiceClient.deleteModelCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteModelRequest,Empty> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getModel(GetModelRequest request)
public final Model getModel(GetModelRequest request)
Gets a model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetModelRequest request =
GetModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
Model response = modelServiceClient.getModel(request);
}
Parameter | |
---|---|
Name | Description |
request | GetModelRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Model |
getModel(ModelName name)
public final Model getModel(ModelName name)
Gets a model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]");
Model response = modelServiceClient.getModel(name);
}
Parameter | |
---|---|
Name | Description |
name | ModelName Required. The resource name of the Model to
get. Format:
|
Returns | |
---|---|
Type | Description |
Model |
getModel(String name)
public final Model getModel(String name)
Gets a model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString();
Model response = modelServiceClient.getModel(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The resource name of the Model to
get. Format:
|
Returns | |
---|---|
Type | Description |
Model |
getModelCallable()
public final UnaryCallable<GetModelRequest,Model> getModelCallable()
Gets a model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetModelRequest request =
GetModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
ApiFuture<Model> future = modelServiceClient.getModelCallable().futureCall(request);
// Do something.
Model response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetModelRequest,Model> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getSettings()
public final ModelServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
ModelServiceSettings |
getStub()
public ModelServiceStub getStub()
Returns | |
---|---|
Type | Description |
ModelServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listModels(CatalogName parent)
public final ModelServiceClient.ListModelsPagedResponse listModels(CatalogName parent)
Lists all the models linked to this event store.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
for (Model element : modelServiceClient.listModels(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | CatalogName Required. The parent for which to list models. Format:
|
Returns | |
---|---|
Type | Description |
ModelServiceClient.ListModelsPagedResponse |
listModels(ListModelsRequest request)
public final ModelServiceClient.ListModelsPagedResponse listModels(ListModelsRequest request)
Lists all the models linked to this event store.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelsRequest request =
ListModelsRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Model element : modelServiceClient.listModels(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListModelsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ModelServiceClient.ListModelsPagedResponse |
listModels(String parent)
public final ModelServiceClient.ListModelsPagedResponse listModels(String parent)
Lists all the models linked to this event store.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
for (Model element : modelServiceClient.listModels(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent for which to list models. Format:
|
Returns | |
---|---|
Type | Description |
ModelServiceClient.ListModelsPagedResponse |
listModelsCallable()
public final UnaryCallable<ListModelsRequest,ListModelsResponse> listModelsCallable()
Lists all the models linked to this event store.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelsRequest request =
ListModelsRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListModelsResponse response = modelServiceClient.listModelsCallable().call(request);
for (Model element : response.getModelsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListModelsRequest,ListModelsResponse> |
listModelsPagedCallable()
public final UnaryCallable<ListModelsRequest,ModelServiceClient.ListModelsPagedResponse> listModelsPagedCallable()
Lists all the models linked to this event store.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelsRequest request =
ListModelsRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Model> future = modelServiceClient.listModelsPagedCallable().futureCall(request);
// Do something.
for (Model element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListModelsRequest,ListModelsPagedResponse> |
pauseModel(ModelName name)
public final Model pauseModel(ModelName name)
Pauses the training of an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]");
Model response = modelServiceClient.pauseModel(name);
}
Parameter | |
---|---|
Name | Description |
name | ModelName Required. The name of the model to pause. Format:
|
Returns | |
---|---|
Type | Description |
Model |
pauseModel(PauseModelRequest request)
public final Model pauseModel(PauseModelRequest request)
Pauses the training of an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
PauseModelRequest request =
PauseModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
Model response = modelServiceClient.pauseModel(request);
}
Parameter | |
---|---|
Name | Description |
request | PauseModelRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Model |
pauseModel(String name)
public final Model pauseModel(String name)
Pauses the training of an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString();
Model response = modelServiceClient.pauseModel(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the model to pause. Format:
|
Returns | |
---|---|
Type | Description |
Model |
pauseModelCallable()
public final UnaryCallable<PauseModelRequest,Model> pauseModelCallable()
Pauses the training of an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
PauseModelRequest request =
PauseModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
ApiFuture<Model> future = modelServiceClient.pauseModelCallable().futureCall(request);
// Do something.
Model response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<PauseModelRequest,Model> |
resumeModel(ResumeModelRequest request)
public final Model resumeModel(ResumeModelRequest request)
Resumes the training of an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ResumeModelRequest request = ResumeModelRequest.newBuilder().setName("name3373707").build();
Model response = modelServiceClient.resumeModel(request);
}
Parameter | |
---|---|
Name | Description |
request | ResumeModelRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Model |
resumeModel(String name)
public final Model resumeModel(String name)
Resumes the training of an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = "name3373707";
Model response = modelServiceClient.resumeModel(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the model to resume. Format:
|
Returns | |
---|---|
Type | Description |
Model |
resumeModelCallable()
public final UnaryCallable<ResumeModelRequest,Model> resumeModelCallable()
Resumes the training of an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ResumeModelRequest request = ResumeModelRequest.newBuilder().setName("name3373707").build();
ApiFuture<Model> future = modelServiceClient.resumeModelCallable().futureCall(request);
// Do something.
Model response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ResumeModelRequest,Model> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
tuneModelAsync(ModelName name)
public final OperationFuture<TuneModelResponse,TuneModelMetadata> tuneModelAsync(ModelName name)
Tunes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]");
TuneModelResponse response = modelServiceClient.tuneModelAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | ModelName Required. The resource name of the model to tune. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<TuneModelResponse,TuneModelMetadata> |
tuneModelAsync(TuneModelRequest request)
public final OperationFuture<TuneModelResponse,TuneModelMetadata> tuneModelAsync(TuneModelRequest request)
Tunes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
TuneModelRequest request =
TuneModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
TuneModelResponse response = modelServiceClient.tuneModelAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | TuneModelRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<TuneModelResponse,TuneModelMetadata> |
tuneModelAsync(String name)
public final OperationFuture<TuneModelResponse,TuneModelMetadata> tuneModelAsync(String name)
Tunes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString();
TuneModelResponse response = modelServiceClient.tuneModelAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The resource name of the model to tune. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<TuneModelResponse,TuneModelMetadata> |
tuneModelCallable()
public final UnaryCallable<TuneModelRequest,Operation> tuneModelCallable()
Tunes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
TuneModelRequest request =
TuneModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
ApiFuture<Operation> future = modelServiceClient.tuneModelCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<TuneModelRequest,Operation> |
tuneModelOperationCallable()
public final OperationCallable<TuneModelRequest,TuneModelResponse,TuneModelMetadata> tuneModelOperationCallable()
Tunes an existing model.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
TuneModelRequest request =
TuneModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]").toString())
.build();
OperationFuture<TuneModelResponse, TuneModelMetadata> future =
modelServiceClient.tuneModelOperationCallable().futureCall(request);
// Do something.
TuneModelResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<TuneModelRequest,TuneModelResponse,TuneModelMetadata> |
updateModel(Model model, FieldMask updateMask)
public final Model updateModel(Model model, FieldMask updateMask)
Update of model metadata. Only fields that currently can be updated are: filtering_option
and
periodic_tuning_state
. If other values are provided, this API method ignores them.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
Model model = Model.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Model response = modelServiceClient.updateModel(model, updateMask);
}
Parameters | |
---|---|
Name | Description |
model | Model Required. The body of the updated Model. |
updateMask | FieldMask Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields. |
Returns | |
---|---|
Type | Description |
Model |
updateModel(UpdateModelRequest request)
public final Model updateModel(UpdateModelRequest request)
Update of model metadata. Only fields that currently can be updated are: filtering_option
and
periodic_tuning_state
. If other values are provided, this API method ignores them.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UpdateModelRequest request =
UpdateModelRequest.newBuilder()
.setModel(Model.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Model response = modelServiceClient.updateModel(request);
}
Parameter | |
---|---|
Name | Description |
request | UpdateModelRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Model |
updateModelCallable()
public final UnaryCallable<UpdateModelRequest,Model> updateModelCallable()
Update of model metadata. Only fields that currently can be updated are: filtering_option
and
periodic_tuning_state
. If other values are provided, this API method ignores them.
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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UpdateModelRequest request =
UpdateModelRequest.newBuilder()
.setModel(Model.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Model> future = modelServiceClient.updateModelCallable().futureCall(request);
// Do something.
Model response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateModelRequest,Model> |