Package com.google.devtools.clouderrorreporting.v1beta1 (0.134.0-beta)

A client to Error Reporting API

The interfaces provided are listed below, along with usage samples.

ErrorGroupServiceClient

Service Description: Service for retrieving and updating individual error groups.

Sample for ErrorGroupServiceClient:


 // 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);
 }

ErrorStatsServiceClient

Service Description: An API for retrieving and managing error statistics as well as data for individual events.

Sample for ErrorStatsServiceClient:


 // 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);
 }

ReportErrorsServiceClient

Service Description: An API for reporting error events.

Sample for ReportErrorsServiceClient:


 // 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 (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   ReportedErrorEvent event = ReportedErrorEvent.newBuilder().build();
   ReportErrorEventResponse response =
       reportErrorsServiceClient.reportErrorEvent(projectName, event);
 }

Classes

DeleteEventsRequest

Deletes all events in the project.

Protobuf type google.devtools.clouderrorreporting.v1beta1.DeleteEventsRequest

DeleteEventsRequest.Builder

Deletes all events in the project.

Protobuf type google.devtools.clouderrorreporting.v1beta1.DeleteEventsRequest

DeleteEventsResponse

Response message for deleting error events.

Protobuf type google.devtools.clouderrorreporting.v1beta1.DeleteEventsResponse

DeleteEventsResponse.Builder

Response message for deleting error events.

Protobuf type google.devtools.clouderrorreporting.v1beta1.DeleteEventsResponse

A description of the context in which an error occurred. This data should be provided by the application when reporting an error, unless the error report has been generated automatically from Google App Engine logs.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ErrorContext

ErrorContext.Builder

Protobuf type google.devtools.clouderrorreporting.v1beta1.ErrorContext

ErrorEvent

An error event which is returned by the Error Reporting system.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ErrorEvent

ErrorEvent.Builder

An error event which is returned by the Error Reporting system.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ErrorEvent

ErrorGroup

Description of a group of similar error events.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ErrorGroup

ErrorGroup.Builder

Description of a group of similar error events.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ErrorGroup

ErrorGroupName

ErrorGroupName.Builder

Builder for projects/{project}/groups/{group}.

ErrorGroupServiceClient

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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of 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.

ErrorGroupServiceGrpc

Service for retrieving and updating individual error groups.

ErrorGroupServiceGrpc.ErrorGroupServiceBlockingStub

Service for retrieving and updating individual error groups.

ErrorGroupServiceGrpc.ErrorGroupServiceFutureStub

Service for retrieving and updating individual error groups.

ErrorGroupServiceGrpc.ErrorGroupServiceImplBase

Service for retrieving and updating individual error groups.

ErrorGroupServiceGrpc.ErrorGroupServiceStub

Service for retrieving and updating individual error groups.

ErrorGroupServiceProto

ErrorGroupServiceSettings

Settings class to configure an instance of ErrorGroupServiceClient.

The default instance has everything set to sensible defaults:

The default service address (clouderrorreporting.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getGroup to 30 seconds:


 // 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.Builder errorGroupServiceSettingsBuilder =
     ErrorGroupServiceSettings.newBuilder();
 errorGroupServiceSettingsBuilder
     .getGroupSettings()
     .setRetrySettings(
         errorGroupServiceSettingsBuilder
             .getGroupSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ErrorGroupServiceSettings errorGroupServiceSettings = errorGroupServiceSettingsBuilder.build();

ErrorGroupServiceSettings.Builder

Builder for ErrorGroupServiceSettings.

ErrorGroupStats

Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats

ErrorGroupStats.Builder

Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats

ErrorStatsServiceClient

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:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

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.

ErrorStatsServiceClient.ListEventsFixedSizeCollection

ErrorStatsServiceClient.ListEventsPage

ErrorStatsServiceClient.ListEventsPagedResponse