Class ModelServiceClient

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

    @Generated("by gapic-generator-java")
    public class ModelServiceClient
    extends Object
    implements com.google.api.gax.core.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:

    1. 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.
    2. 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.
    3. 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.

    • Constructor Detail

      • ModelServiceClient

        protected ModelServiceClient​(ModelServiceSettings settings)
                              throws IOException
        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.
        Throws:
        IOException
    • Method Detail

      • create

        public static final ModelServiceClient create​(ModelServiceSettings settings)
                                               throws IOException
        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.
        Throws:
        IOException
      • create

        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).
      • 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.
      • getHttpJsonOperationsClient

        @BetaApi
        public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
      • createModelAsync

        public final com.google.api.gax.longrunning.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:
        parent - Required. The parent resource under which to create the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        model - Required. The payload of the [Model][google.cloud.retail.v2.Model] to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createModelAsync

        public final com.google.api.gax.longrunning.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:
        parent - Required. The parent resource under which to create the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        model - Required. The payload of the [Model][google.cloud.retail.v2.Model] to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createModelAsync

        public final com.google.api.gax.longrunning.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();
         }
         
        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
      • createModelOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • createModelCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateModelRequest,​com.google.longrunning.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();
         }
         
      • getModel

        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);
         }
         
        Parameters:
        name - Required. The resource name of the [Model][google.cloud.retail.v2.Model] to get. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getModel

        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);
         }
         
        Parameters:
        name - Required. The resource name of the [Model][google.cloud.retail.v2.Model] to get. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getModel

        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);
         }
         
        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
      • getModelCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • pauseModel

        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);
         }
         
        Parameters:
        name - Required. The name of the model to pause. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • pauseModel

        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);
         }
         
        Parameters:
        name - Required. The name of the model to pause. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • pauseModel

        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);
         }
         
        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
      • pauseModelCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • resumeModel

        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);
         }
         
        Parameters:
        name - Required. The name of the model to resume. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • resumeModel

        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);
         }
         
        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
      • resumeModelCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • deleteModel

        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);
         }
         
        Parameters:
        name - Required. The resource name of the [Model][google.cloud.retail.v2.Model] to delete. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteModel

        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);
         }
         
        Parameters:
        name - Required. The resource name of the [Model][google.cloud.retail.v2.Model] to delete. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteModel

        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);
         }
         
        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
      • deleteModelCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteModelRequest,​com.google.protobuf.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();
         }
         
      • listModels

        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);
           }
         }
         
        Parameters:
        parent - Required. The parent for which to list models. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listModels

        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);
           }
         }
         
        Parameters:
        parent - Required. The parent for which to list models. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listModels

        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);
           }
         }
         
        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
      • listModelsPagedCallable

        public final com.google.api.gax.rpc.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);
           }
         }
         
      • listModelsCallable

        public final com.google.api.gax.rpc.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;
             }
           }
         }
         
      • updateModel

        public final Model updateModel​(Model model,
                                       com.google.protobuf.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:
        model - Required. The body of the updated [Model][google.cloud.retail.v2.Model].
        updateMask - Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • updateModel

        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);
         }
         
        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
      • updateModelCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • tuneModelAsync

        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        name - Required. The resource name of the model to tune. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • tuneModelAsync

        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        name - Required. The resource name of the model to tune. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • tuneModelAsync

        public final com.google.api.gax.longrunning.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();
         }
         
        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
      • tuneModelOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • tuneModelCallable

        public final com.google.api.gax.rpc.UnaryCallable<TuneModelRequest,​com.google.longrunning.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();
         }
         
      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource
      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource
      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource
      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource