Package com.google.cloud.retail.v2beta

Class ProjectServiceClient

java.lang.Object
com.google.cloud.retail.v2beta.ProjectServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class ProjectServiceClient extends Object implements BackgroundResource
Service Description: Service for settings at Project level.

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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   AlertConfigName name = AlertConfigName.of("[PROJECT]");
   AlertConfig response = projectServiceClient.getAlertConfig(name);
 }

Note: close() needs to be called on the ProjectServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

GetAlertConfig

Get the [AlertConfig][google.cloud.retail.v2beta.AlertConfig] of the requested project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAlertConfig(GetAlertConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAlertConfig(AlertConfigName name)

  • getAlertConfig(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAlertConfigCallable()

UpdateAlertConfig

Update the alert config of the requested project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAlertConfig(UpdateAlertConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateAlertConfig(AlertConfig alertConfig, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAlertConfigCallable()

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 ProjectServiceSettings 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
 ProjectServiceSettings projectServiceSettings =
     ProjectServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProjectServiceClient projectServiceClient = ProjectServiceClient.create(projectServiceSettings);

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
 ProjectServiceSettings projectServiceSettings =
     ProjectServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProjectServiceClient projectServiceClient = ProjectServiceClient.create(projectServiceSettings);

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
 ProjectServiceSettings projectServiceSettings =
     ProjectServiceSettings.newHttpJsonBuilder().build();
 ProjectServiceClient projectServiceClient = ProjectServiceClient.create(projectServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

  • Constructor Details

    • ProjectServiceClient

      protected ProjectServiceClient(ProjectServiceSettings settings) throws IOException
      Constructs an instance of ProjectServiceClient, 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

    • ProjectServiceClient

      protected ProjectServiceClient(ProjectServiceStub stub)

  • Method Details

    • create

      public static final ProjectServiceClient create() throws IOException
      Constructs an instance of ProjectServiceClient with default settings.
      Throws:
      IOException

    • create

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

    • getSettings

      public final ProjectServiceSettings getSettings()

    • getStub

      public ProjectServiceStub getStub()

    • getAlertConfig

      public final AlertConfig getAlertConfig(AlertConfigName name)
      Get the [AlertConfig][google.cloud.retail.v2beta.AlertConfig] of the requested project.

      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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   AlertConfigName name = AlertConfigName.of("[PROJECT]");
   AlertConfig response = projectServiceClient.getAlertConfig(name);
 }
      Parameters:
      name - Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig
      Throws:
      ApiException - if the remote call fails

    • getAlertConfig

      public final AlertConfig getAlertConfig(String name)
      Get the [AlertConfig][google.cloud.retail.v2beta.AlertConfig] of the requested project.

      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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   String name = AlertConfigName.of("[PROJECT]").toString();
   AlertConfig response = projectServiceClient.getAlertConfig(name);
 }
      Parameters:
      name - Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig
      Throws:
      ApiException - if the remote call fails

    • getAlertConfig

      public final AlertConfig getAlertConfig(GetAlertConfigRequest request)
      Get the [AlertConfig][google.cloud.retail.v2beta.AlertConfig] of the requested project.

      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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   GetAlertConfigRequest request =
       GetAlertConfigRequest.newBuilder()
           .setName(AlertConfigName.of("[PROJECT]").toString())
           .build();
   AlertConfig response = projectServiceClient.getAlertConfig(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getAlertConfigCallable

      public final UnaryCallable<GetAlertConfigRequest,AlertConfig> getAlertConfigCallable()
      Get the [AlertConfig][google.cloud.retail.v2beta.AlertConfig] of the requested project.

      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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   GetAlertConfigRequest request =
       GetAlertConfigRequest.newBuilder()
           .setName(AlertConfigName.of("[PROJECT]").toString())
           .build();
   ApiFuture<AlertConfig> future =
       projectServiceClient.getAlertConfigCallable().futureCall(request);
   // Do something.
   AlertConfig response = future.get();
 }

    • updateAlertConfig

      public final AlertConfig updateAlertConfig(AlertConfig alertConfig, com.google.protobuf.FieldMask updateMask)
      Update the alert config of the requested project.

      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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   AlertConfig alertConfig = AlertConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AlertConfig response = projectServiceClient.updateAlertConfig(alertConfig, updateMask);
 }
      Parameters:
      alertConfig - Required. The [AlertConfig][google.cloud.retail.v2beta.AlertConfig] to update.

      If the caller does not have permission to update the [AlertConfig][google.cloud.retail.v2beta.AlertConfig], then a PERMISSION_DENIED error is returned.

      If the [AlertConfig][google.cloud.retail.v2beta.AlertConfig] to update does not exist, a NOT_FOUND error is returned.

      updateMask - Indicates which fields in the provided [AlertConfig][google.cloud.retail.v2beta.AlertConfig] to update. If not set, all supported fields are updated.
      Throws:
      ApiException - if the remote call fails

    • updateAlertConfig

      public final AlertConfig updateAlertConfig(UpdateAlertConfigRequest request)
      Update the alert config of the requested project.

      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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   UpdateAlertConfigRequest request =
       UpdateAlertConfigRequest.newBuilder()
           .setAlertConfig(AlertConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AlertConfig response = projectServiceClient.updateAlertConfig(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateAlertConfigCallable

      public final UnaryCallable<UpdateAlertConfigRequest,AlertConfig> updateAlertConfigCallable()
      Update the alert config of the requested project.

      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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   UpdateAlertConfigRequest request =
       UpdateAlertConfigRequest.newBuilder()
           .setAlertConfig(AlertConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AlertConfig> future =
       projectServiceClient.updateAlertConfigCallable().futureCall(request);
   // Do something.
   AlertConfig response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException