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

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   ReportedErrorEvent event = ReportedErrorEvent.newBuilder().build();
   ReportErrorEventResponse response =
       reportErrorsServiceClient.reportErrorEvent(projectName, event);
 }
 

Classes

CommonProto

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

ErrorContext

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

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

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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:

  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 ErrorGroupServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newBuilder().setEndpoint(myEndpoint).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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 ErrorStatsServiceSettings errorStatsServiceSettings =
     ErrorStatsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ErrorStatsServiceClient errorStatsServiceClient =
     ErrorStatsServiceClient.create(errorStatsServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ErrorStatsServiceSettings errorStatsServiceSettings =
     ErrorStatsServiceSettings.newBuilder().setEndpoint(myEndpoint).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

ErrorStatsServiceClient.ListGroupStatsFixedSizeCollection

ErrorStatsServiceClient.ListGroupStatsPage

ErrorStatsServiceClient.ListGroupStatsPagedResponse

ErrorStatsServiceGrpc

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

ErrorStatsServiceGrpc.ErrorStatsServiceBlockingStub

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

ErrorStatsServiceGrpc.ErrorStatsServiceFutureStub

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

ErrorStatsServiceGrpc.ErrorStatsServiceImplBase

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

ErrorStatsServiceGrpc.ErrorStatsServiceStub

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

ErrorStatsServiceProto

ErrorStatsServiceSettings

Settings class to configure an instance of ErrorStatsServiceClient.

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 deleteEvents to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ErrorStatsServiceSettings.Builder errorStatsServiceSettingsBuilder =
     ErrorStatsServiceSettings.newBuilder();
 errorStatsServiceSettingsBuilder
     .deleteEventsSettings()
     .setRetrySettings(
         errorStatsServiceSettingsBuilder
             .deleteEventsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ErrorStatsServiceSettings errorStatsServiceSettings = errorStatsServiceSettingsBuilder.build();
 

ErrorStatsServiceSettings.Builder

Builder for ErrorStatsServiceSettings.

GetGroupRequest

A request to return an individual group.

Protobuf type google.devtools.clouderrorreporting.v1beta1.GetGroupRequest

GetGroupRequest.Builder

A request to return an individual group.

Protobuf type google.devtools.clouderrorreporting.v1beta1.GetGroupRequest

GroupName

GroupName.Builder

Builder for GroupName.

HttpRequestContext

HTTP request data that is related to a reported error. 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.HttpRequestContext

HttpRequestContext.Builder

HTTP request data that is related to a reported error. 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.HttpRequestContext

ListEventsRequest

Specifies a set of error events to return.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListEventsRequest

ListEventsRequest.Builder

Specifies a set of error events to return.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListEventsRequest

ListEventsResponse

Contains a set of requested error events.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListEventsResponse

ListEventsResponse.Builder

Contains a set of requested error events.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListEventsResponse

ListGroupStatsRequest

Specifies a set of ErrorGroupStats to return.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest

ListGroupStatsRequest.Builder

Specifies a set of ErrorGroupStats to return.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListGroupStatsRequest

ListGroupStatsResponse

Contains a set of requested error group stats.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse

ListGroupStatsResponse.Builder

Contains a set of requested error group stats.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ListGroupStatsResponse

ProjectName

ProjectName.Builder

Builder for projects/{project}.

QueryTimeRange

Requests might be rejected or the resulting timed count durations might be adjusted for lower durations.

Protobuf type google.devtools.clouderrorreporting.v1beta1.QueryTimeRange

QueryTimeRange.Builder

Requests might be rejected or the resulting timed count durations might be adjusted for lower durations.

Protobuf type google.devtools.clouderrorreporting.v1beta1.QueryTimeRange

ReportErrorEventRequest

A request for reporting an individual error event.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ReportErrorEventRequest

ReportErrorEventRequest.Builder

A request for reporting an individual error event.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ReportErrorEventRequest

ReportErrorEventResponse

Response for reporting an individual error event. Data may be added to this message in the future.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse

ReportErrorEventResponse.Builder

Response for reporting an individual error event. Data may be added to this message in the future.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse

ReportErrorsServiceClient

Service Description: An API for reporting error 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   ReportedErrorEvent event = ReportedErrorEvent.newBuilder().build();
   ReportErrorEventResponse response =
       reportErrorsServiceClient.reportErrorEvent(projectName, event);
 }
 

Note: close() needs to be called on the ReportErrorsServiceClient 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 ReportErrorsServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ReportErrorsServiceSettings reportErrorsServiceSettings =
     ReportErrorsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReportErrorsServiceClient reportErrorsServiceClient =
     ReportErrorsServiceClient.create(reportErrorsServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ReportErrorsServiceSettings reportErrorsServiceSettings =
     ReportErrorsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReportErrorsServiceClient reportErrorsServiceClient =
     ReportErrorsServiceClient.create(reportErrorsServiceSettings);
 

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

ReportErrorsServiceGrpc

An API for reporting error events.

ReportErrorsServiceGrpc.ReportErrorsServiceBlockingStub

An API for reporting error events.

ReportErrorsServiceGrpc.ReportErrorsServiceFutureStub

An API for reporting error events.

ReportErrorsServiceGrpc.ReportErrorsServiceImplBase

An API for reporting error events.

ReportErrorsServiceGrpc.ReportErrorsServiceStub

An API for reporting error events.

ReportErrorsServiceProto

ReportErrorsServiceSettings

Settings class to configure an instance of ReportErrorsServiceClient.

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 reportErrorEvent to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ReportErrorsServiceSettings.Builder reportErrorsServiceSettingsBuilder =
     ReportErrorsServiceSettings.newBuilder();
 reportErrorsServiceSettingsBuilder
     .reportErrorEventSettings()
     .setRetrySettings(
         reportErrorsServiceSettingsBuilder
             .reportErrorEventSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ReportErrorsServiceSettings reportErrorsServiceSettings =
     reportErrorsServiceSettingsBuilder.build();
 

ReportErrorsServiceSettings.Builder

Builder for ReportErrorsServiceSettings.

ReportedErrorEvent

An error event which is reported to the Error Reporting system.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent

ReportedErrorEvent.Builder

An error event which is reported to the Error Reporting system.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent

ServiceContext

Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ServiceContext

ServiceContext.Builder

Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ServiceContext

ServiceContextFilter

Specifies criteria for filtering a subset of service contexts. The fields in the filter correspond to the fields in ServiceContext. Only exact, case-sensitive matches are supported. If a field is unset or empty, it matches arbitrary values.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ServiceContextFilter

ServiceContextFilter.Builder

Specifies criteria for filtering a subset of service contexts. The fields in the filter correspond to the fields in ServiceContext. Only exact, case-sensitive matches are supported. If a field is unset or empty, it matches arbitrary values.

Protobuf type google.devtools.clouderrorreporting.v1beta1.ServiceContextFilter

SourceLocation

Indicates a location in the source code of the service for which errors are reported. functionName must be provided by the application when reporting an error, unless the error report contains a message with a supported exception stack trace. All fields are optional for the later case.

Protobuf type google.devtools.clouderrorreporting.v1beta1.SourceLocation

SourceLocation.Builder

Indicates a location in the source code of the service for which errors are reported. functionName must be provided by the application when reporting an error, unless the error report contains a message with a supported exception stack trace. All fields are optional for the later case.

Protobuf type google.devtools.clouderrorreporting.v1beta1.SourceLocation

TimedCount

The number of errors in a given time period. All numbers are approximate since the error events are sampled before counting them.

Protobuf type google.devtools.clouderrorreporting.v1beta1.TimedCount

TimedCount.Builder

The number of errors in a given time period. All numbers are approximate since the error events are sampled before counting them.

Protobuf type google.devtools.clouderrorreporting.v1beta1.TimedCount

TrackingIssue

Information related to tracking the progress on resolving the error.

Protobuf type google.devtools.clouderrorreporting.v1beta1.TrackingIssue

TrackingIssue.Builder

Information related to tracking the progress on resolving the error.

Protobuf type google.devtools.clouderrorreporting.v1beta1.TrackingIssue

UpdateGroupRequest

A request to replace the existing data for the given group.

Protobuf type google.devtools.clouderrorreporting.v1beta1.UpdateGroupRequest

UpdateGroupRequest.Builder

A request to replace the existing data for the given group.

Protobuf type google.devtools.clouderrorreporting.v1beta1.UpdateGroupRequest

Interfaces

DeleteEventsRequestOrBuilder

DeleteEventsResponseOrBuilder

ErrorContextOrBuilder

ErrorEventOrBuilder

ErrorGroupOrBuilder

ErrorGroupStatsOrBuilder

GetGroupRequestOrBuilder

HttpRequestContextOrBuilder

ListEventsRequestOrBuilder

ListEventsResponseOrBuilder

ListGroupStatsRequestOrBuilder

ListGroupStatsResponseOrBuilder

QueryTimeRangeOrBuilder

ReportErrorEventRequestOrBuilder

ReportErrorEventResponseOrBuilder

ReportedErrorEventOrBuilder

ServiceContextFilterOrBuilder

ServiceContextOrBuilder

SourceLocationOrBuilder

TimedCountOrBuilder

TrackingIssueOrBuilder

UpdateGroupRequestOrBuilder

Enums

ErrorGroupOrder

A sorting order of error groups.

Protobuf enum google.devtools.clouderrorreporting.v1beta1.ErrorGroupOrder

QueryTimeRange.Period

The supported time ranges.

Protobuf enum google.devtools.clouderrorreporting.v1beta1.QueryTimeRange.Period

ResolutionStatus

Resolution status of an error group.

Protobuf enum google.devtools.clouderrorreporting.v1beta1.ResolutionStatus

TimedCountAlignment

Specifies how the time periods of error group counts are aligned.

Protobuf enum google.devtools.clouderrorreporting.v1beta1.TimedCountAlignment