Class ReportErrorsServiceClient (0.163.0-beta)

GitHub RepositoryProduct Reference

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

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

Methods
Method Description Method Variants

ReportErrorEvent

Report an individual error event and record the event to a log.

This endpoint accepts **either** an OAuth token,

  • *or** an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456

**Note:** Error Reporting is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects.

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

  • reportErrorEvent(ReportErrorEventRequest request)

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

  • reportErrorEvent(ProjectName projectName, ReportedErrorEvent event)

  • reportErrorEvent(String projectName, ReportedErrorEvent event)

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

  • reportErrorEventCallable()

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 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
 ReportErrorsServiceSettings reportErrorsServiceSettings =
     ReportErrorsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReportErrorsServiceClient reportErrorsServiceClient =
     ReportErrorsServiceClient.create(reportErrorsServiceSettings);

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
 ReportErrorsServiceSettings reportErrorsServiceSettings =
     ReportErrorsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReportErrorsServiceClient reportErrorsServiceClient =
     ReportErrorsServiceClient.create(reportErrorsServiceSettings);

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
 ReportErrorsServiceSettings reportErrorsServiceSettings =
     ReportErrorsServiceSettings.newHttpJsonBuilder().build();
 ReportErrorsServiceClient reportErrorsServiceClient =
     ReportErrorsServiceClient.create(reportErrorsServiceSettings);

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

Inheritance

java.lang.Object > ReportErrorsServiceClient

Static Methods

create()

public static final ReportErrorsServiceClient create()

Constructs an instance of ReportErrorsServiceClient with default settings.

Returns
Type Description
ReportErrorsServiceClient
Exceptions
Type Description
IOException

create(ReportErrorsServiceSettings settings)

public static final ReportErrorsServiceClient create(ReportErrorsServiceSettings settings)

Constructs an instance of ReportErrorsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings ReportErrorsServiceSettings
Returns
Type Description
ReportErrorsServiceClient
Exceptions
Type Description
IOException

create(ReportErrorsServiceStub stub)

public static final ReportErrorsServiceClient create(ReportErrorsServiceStub stub)

Constructs an instance of ReportErrorsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ReportErrorsServiceSettings).

Parameter
Name Description
stub ReportErrorsServiceStub
Returns
Type Description
ReportErrorsServiceClient

Constructors

ReportErrorsServiceClient(ReportErrorsServiceSettings settings)

protected ReportErrorsServiceClient(ReportErrorsServiceSettings settings)

Constructs an instance of ReportErrorsServiceClient, 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.

Parameter
Name Description
settings ReportErrorsServiceSettings

ReportErrorsServiceClient(ReportErrorsServiceStub stub)

protected ReportErrorsServiceClient(ReportErrorsServiceStub stub)
Parameter
Name Description
stub ReportErrorsServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

getSettings()

public final ReportErrorsServiceSettings getSettings()
Returns
Type Description
ReportErrorsServiceSettings

getStub()

public ReportErrorsServiceStub getStub()
Returns
Type Description
ReportErrorsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

reportErrorEvent(ProjectName projectName, ReportedErrorEvent event)

public final ReportErrorEventResponse reportErrorEvent(ProjectName projectName, ReportedErrorEvent event)

Report an individual error event and record the event to a log.

This endpoint accepts **either** an OAuth token,

  • *or** an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456

**Note:** Error Reporting is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects.

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

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectId}, where {projectId} is the Google Cloud Platform project ID.

Example: // projects/my-project-123.
event ReportedErrorEvent

Required. The error event to be reported.
Returns
Type Description
ReportErrorEventResponse

reportErrorEvent(ReportErrorEventRequest request)

public final ReportErrorEventResponse reportErrorEvent(ReportErrorEventRequest request)

Report an individual error event and record the event to a log.

This endpoint accepts **either** an OAuth token,

  • *or** an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456

**Note:** Error Reporting is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects.

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 (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
   ReportErrorEventRequest request =
       ReportErrorEventRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .setEvent(ReportedErrorEvent.newBuilder().build())
           .build();
   ReportErrorEventResponse response = reportErrorsServiceClient.reportErrorEvent(request);
 }
Parameter
Name Description
request ReportErrorEventRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ReportErrorEventResponse

reportErrorEvent(String projectName, ReportedErrorEvent event)

public final ReportErrorEventResponse reportErrorEvent(String projectName, ReportedErrorEvent event)

Report an individual error event and record the event to a log.

This endpoint accepts **either** an OAuth token,

  • *or** an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456

**Note:** Error Reporting is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects.

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

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectId}, where {projectId} is the Google Cloud Platform project ID.

Example: // projects/my-project-123.
event ReportedErrorEvent

Required. The error event to be reported.
Returns
Type Description
ReportErrorEventResponse

reportErrorEventCallable()

public final UnaryCallable<ReportErrorEventRequest,ReportErrorEventResponse> reportErrorEventCallable()

Report an individual error event and record the event to a log.

This endpoint accepts **either** an OAuth token,

  • *or** an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456

**Note:** Error Reporting is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects.

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 (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
   ReportErrorEventRequest request =
       ReportErrorEventRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .setEvent(ReportedErrorEvent.newBuilder().build())
           .build();
   ApiFuture<ReportErrorEventResponse> future =
       reportErrorsServiceClient.reportErrorEventCallable().futureCall(request);
   // Do something.
   ReportErrorEventResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<ReportErrorEventRequest,ReportErrorEventResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()