Package com.google.devtools.clouderrorreporting.v1beta1

Class ErrorStatsServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @BetaApi
@Generated("by gapic-generator-java")
public class ErrorStatsServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: An API for retrieving and managing error statistics as well as data for individual events.

    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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   DeleteEventsResponse response = errorStatsServiceClient.deleteEvents(projectName);
 }

    Note: close() needs to be called on the ErrorStatsServiceClient 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 ErrorStatsServiceSettings 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
 ErrorStatsServiceSettings errorStatsServiceSettings =
     ErrorStatsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ErrorStatsServiceClient errorStatsServiceClient =
     ErrorStatsServiceClient.create(errorStatsServiceSettings);

    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
 ErrorStatsServiceSettings errorStatsServiceSettings =
     ErrorStatsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ErrorStatsServiceClient errorStatsServiceClient =
     ErrorStatsServiceClient.create(errorStatsServiceSettings);

    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
 ErrorStatsServiceSettings errorStatsServiceSettings =
     ErrorStatsServiceSettings.newHttpJsonBuilder().build();
 ErrorStatsServiceClient errorStatsServiceClient =
     ErrorStatsServiceClient.create(errorStatsServiceSettings);

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

    • Constructor Detail

      • ErrorStatsServiceClient

        protected ErrorStatsServiceClient​(ErrorStatsServiceSettings settings)
                           throws IOException
        Constructs an instance of ErrorStatsServiceClient, 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 ErrorStatsServiceClient create​(ErrorStatsServiceStub stub)
        Constructs an instance of ErrorStatsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ErrorStatsServiceSettings).

      • listGroupStats

        public final ErrorStatsServiceClient.ListGroupStatsPagedResponse listGroupStats​(ProjectName projectName,
                                                                                QueryTimeRange timeRange)
        Lists the specified groups.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
   for (ErrorGroupStats element :
       errorStatsServiceClient.listGroupStats(projectName, timeRange).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        projectName - Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud Console](https://support.google.com/cloud/answer/6158840).

        Examples: `projects/my-project-123`, `projects/5551234`.

        timeRange - Optional. List data for the given time range. If not set, a default time range is used. The field <code>time_range_begin</code> in the response will specify the beginning of this time range. Only <code>ErrorGroupStats</code> with a non-zero count in the given time range are returned, unless the request contains an explicit <code>group_id</code> list. If a <code>group_id</code> list is given, also <code>ErrorGroupStats</code> with zero occurrences are returned.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listGroupStats

        public final ErrorStatsServiceClient.ListGroupStatsPagedResponse listGroupStats​(String projectName,
                                                                                QueryTimeRange timeRange)
        Lists the specified groups.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   String projectName = ProjectName.of("[PROJECT]").toString();
   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
   for (ErrorGroupStats element :
       errorStatsServiceClient.listGroupStats(projectName, timeRange).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        projectName - Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud Console](https://support.google.com/cloud/answer/6158840).

        Examples: `projects/my-project-123`, `projects/5551234`.

        timeRange - Optional. List data for the given time range. If not set, a default time range is used. The field <code>time_range_begin</code> in the response will specify the beginning of this time range. Only <code>ErrorGroupStats</code> with a non-zero count in the given time range are returned, unless the request contains an explicit <code>group_id</code> list. If a <code>group_id</code> list is given, also <code>ErrorGroupStats</code> with zero occurrences are returned.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listGroupStats

        public final ErrorStatsServiceClient.ListGroupStatsPagedResponse listGroupStats​(ListGroupStatsRequest request)
        Lists the specified groups.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListGroupStatsRequest request =
       ListGroupStatsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .addAllGroupId(new ArrayList<String>())
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setTimedCountDuration(Duration.newBuilder().build())
           .setAlignment(TimedCountAlignment.forNumber(0))
           .setAlignmentTime(Timestamp.newBuilder().build())
           .setOrder(ErrorGroupOrder.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ErrorGroupStats element : errorStatsServiceClient.listGroupStats(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

      • listGroupStatsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListGroupStatsRequest,​ErrorStatsServiceClient.ListGroupStatsPagedResponse> listGroupStatsPagedCallable()
        Lists the specified groups.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListGroupStatsRequest request =
       ListGroupStatsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .addAllGroupId(new ArrayList<String>())
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setTimedCountDuration(Duration.newBuilder().build())
           .setAlignment(TimedCountAlignment.forNumber(0))
           .setAlignmentTime(Timestamp.newBuilder().build())
           .setOrder(ErrorGroupOrder.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ErrorGroupStats> future =
       errorStatsServiceClient.listGroupStatsPagedCallable().futureCall(request);
   // Do something.
   for (ErrorGroupStats element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listGroupStatsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListGroupStatsRequest,​ListGroupStatsResponse> listGroupStatsCallable()
        Lists the specified groups.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListGroupStatsRequest request =
       ListGroupStatsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .addAllGroupId(new ArrayList<String>())
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setTimedCountDuration(Duration.newBuilder().build())
           .setAlignment(TimedCountAlignment.forNumber(0))
           .setAlignmentTime(Timestamp.newBuilder().build())
           .setOrder(ErrorGroupOrder.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListGroupStatsResponse response =
         errorStatsServiceClient.listGroupStatsCallable().call(request);
     for (ErrorGroupStats element : response.getErrorGroupStatsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • listEvents

        public final ErrorStatsServiceClient.ListEventsPagedResponse listEvents​(ProjectName projectName,
                                                                        String groupId)
        Lists the specified events.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   String groupId = "groupId293428218";
   for (ErrorEvent element :
       errorStatsServiceClient.listEvents(projectName, groupId).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        projectName - Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).

        Example: `projects/my-project-123`.

        groupId - Required. The group for which events shall be returned.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listEvents

        public final ErrorStatsServiceClient.ListEventsPagedResponse listEvents​(String projectName,
                                                                        String groupId)
        Lists the specified events.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   String projectName = ProjectName.of("[PROJECT]").toString();
   String groupId = "groupId293428218";
   for (ErrorEvent element :
       errorStatsServiceClient.listEvents(projectName, groupId).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        projectName - Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).

        Example: `projects/my-project-123`.

        groupId - Required. The group for which events shall be returned.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listEvents

        public final ErrorStatsServiceClient.ListEventsPagedResponse listEvents​(ListEventsRequest request)
        Lists the specified events.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .setGroupId("groupId293428218")
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ErrorEvent element : errorStatsServiceClient.listEvents(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

      • listEventsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,​ErrorStatsServiceClient.ListEventsPagedResponse> listEventsPagedCallable()
        Lists the specified events.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .setGroupId("groupId293428218")
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ErrorEvent> future =
       errorStatsServiceClient.listEventsPagedCallable().futureCall(request);
   // Do something.
   for (ErrorEvent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listEventsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,​ListEventsResponse> listEventsCallable()
        Lists the specified events.

        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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .setGroupId("groupId293428218")
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEventsResponse response = errorStatsServiceClient.listEventsCallable().call(request);
     for (ErrorEvent element : response.getErrorEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • deleteEvents

        public final DeleteEventsResponse deleteEvents​(ProjectName projectName)
        Deletes all error events of a given 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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   DeleteEventsResponse response = errorStatsServiceClient.deleteEvents(projectName);
 }
        Parameters:
        projectName - Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).

        Example: `projects/my-project-123`.

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteEvents

        public final DeleteEventsResponse deleteEvents​(String projectName)
        Deletes all error events of a given 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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   String projectName = ProjectName.of("[PROJECT]").toString();
   DeleteEventsResponse response = errorStatsServiceClient.deleteEvents(projectName);
 }
        Parameters:
        projectName - Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).

        Example: `projects/my-project-123`.

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteEvents

        public final DeleteEventsResponse deleteEvents​(DeleteEventsRequest request)
        Deletes all error events of a given 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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   DeleteEventsRequest request =
       DeleteEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .build();
   DeleteEventsResponse response = errorStatsServiceClient.deleteEvents(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

      • deleteEventsCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteEventsRequest,​DeleteEventsResponse> deleteEventsCallable()
        Deletes all error events of a given 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 (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   DeleteEventsRequest request =
       DeleteEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .build();
   ApiFuture<DeleteEventsResponse> future =
       errorStatsServiceClient.deleteEventsCallable().futureCall(request);
   // Do something.
   DeleteEventsResponse 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