Package com.google.devtools.clouderrorreporting.v1beta1

Class ErrorGroupServiceClient

java.lang.Object
com.google.devtools.clouderrorreporting.v1beta1.ErrorGroupServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class ErrorGroupServiceClient extends Object implements BackgroundResource
Service Description: Service for retrieving and updating individual error groups.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
 }

Note: close() needs to be called on the ErrorGroupServiceClient 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

GetGroup

Get the specified group.

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

  • getGroup(GetGroupRequest request)

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

  • getGroup(ErrorGroupName groupName)

  • getGroup(String groupName)

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

  • getGroupCallable()

UpdateGroup

Replace the data for the specified group. Fails if the group does not exist.

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

  • updateGroup(UpdateGroupRequest request)

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

  • updateGroup(ErrorGroup group)

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

  • updateGroupCallable()

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 ErrorGroupServiceSettings 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
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);

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
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);

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
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newHttpJsonBuilder().build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);

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

  • Constructor Details

    • ErrorGroupServiceClient

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

    • ErrorGroupServiceClient

      protected ErrorGroupServiceClient(ErrorGroupServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • getSettings

      public final ErrorGroupServiceSettings getSettings()

    • getStub

      public ErrorGroupServiceStub getStub()

    • getGroup

      @Deprecated public final ErrorGroup getGroup(GroupName groupName)
      Deprecated.
      Use ErrorGroupServiceClient#getGroup(ErrorGroupName)
      Get the specified group.

      Sample code: 

      
 try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   GroupName groupName = GroupName.of("[PROJECT]", "[GROUP]");
   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
 }
      Parameters:
      groupName - Required. The group resource name. Written as <code>projects/<var>projectID</var>/groups/<var>group_name</var></code>. Call <a href="/error-reporting/reference/rest/v1beta1/projects.groupStats/list"> <code>groupStats.list</code></a> to return a list of groups belonging to this project.

      Example: <code>projects/my-project-123/groups/my-group</code>

      Throws:
      ApiException - if the remote call fails

    • getGroup

      public final ErrorGroup getGroup(ErrorGroupName groupName)
      Get the specified group.

      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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
 }
      Parameters:
      groupName - Required. The group resource name. Written as either `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}`. Call [groupStats.list] [google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats] to return a list of groups belonging to this project.

      Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group`

      In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).

      For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.

      Throws:
      ApiException - if the remote call fails

    • getGroup

      public final ErrorGroup getGroup(String groupName)
      Get the specified group.

      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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   String groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]").toString();
   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
 }
      Parameters:
      groupName - Required. The group resource name. Written as either `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}`. Call [groupStats.list] [google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats] to return a list of groups belonging to this project.

      Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group`

      In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).

      For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.

      Throws:
      ApiException - if the remote call fails

    • getGroup

      public final ErrorGroup getGroup(GetGroupRequest request)
      Get the specified group.

      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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   GetGroupRequest request =
       GetGroupRequest.newBuilder()
           .setGroupName(ErrorGroupName.of("[PROJECT]", "[GROUP]").toString())
           .build();
   ErrorGroup response = errorGroupServiceClient.getGroup(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getGroupCallable

      public final UnaryCallable<GetGroupRequest,ErrorGroup> getGroupCallable()
      Get the specified group.

      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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   GetGroupRequest request =
       GetGroupRequest.newBuilder()
           .setGroupName(ErrorGroupName.of("[PROJECT]", "[GROUP]").toString())
           .build();
   ApiFuture<ErrorGroup> future = errorGroupServiceClient.getGroupCallable().futureCall(request);
   // Do something.
   ErrorGroup response = future.get();
 }

    • updateGroup

      public final ErrorGroup updateGroup(ErrorGroup group)
      Replace the data for the specified group. Fails if the group does not exist.

      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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   ErrorGroup group = ErrorGroup.newBuilder().build();
   ErrorGroup response = errorGroupServiceClient.updateGroup(group);
 }
      Parameters:
      group - Required. The group which replaces the resource on the server.
      Throws:
      ApiException - if the remote call fails

    • updateGroup

      public final ErrorGroup updateGroup(UpdateGroupRequest request)
      Replace the data for the specified group. Fails if the group does not exist.

      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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   UpdateGroupRequest request =
       UpdateGroupRequest.newBuilder().setGroup(ErrorGroup.newBuilder().build()).build();
   ErrorGroup response = errorGroupServiceClient.updateGroup(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateGroupCallable

      public final UnaryCallable<UpdateGroupRequest,ErrorGroup> updateGroupCallable()
      Replace the data for the specified group. Fails if the group does not exist.

      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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   UpdateGroupRequest request =
       UpdateGroupRequest.newBuilder().setGroup(ErrorGroup.newBuilder().build()).build();
   ApiFuture<ErrorGroup> future =
       errorGroupServiceClient.updateGroupCallable().futureCall(request);
   // Do something.
   ErrorGroup 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