Package com.google.devtools.clouderrorreporting.v1beta1

Class ReportErrorsServiceClient

java.lang.Object
com.google.devtools.clouderrorreporting.v1beta1.ReportErrorsServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class ReportErrorsServiceClient extends Object implements BackgroundResource
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](https://support.google.com/cloud/answer/6158862) 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] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true:

  • Customer-managed encryption keys (CMEK) are disabled on the log bucket.
  • The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.

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.

  • Constructor Details

    • ReportErrorsServiceClient

      protected ReportErrorsServiceClient(ReportErrorsServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • ReportErrorsServiceClient

      protected ReportErrorsServiceClient(ReportErrorsServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final ReportErrorsServiceClient create(ReportErrorsServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final ReportErrorsServiceSettings getSettings()

    • getStub

      public ReportErrorsServiceStub getStub()

    • reportErrorEvent

      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](https://support.google.com/cloud/answer/6158862) 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] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true:

      • Customer-managed encryption keys (CMEK) are disabled on the log bucket.
      • The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.

      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:
      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`.

      event - Required. The error event to be reported.
      Throws:
      ApiException - if the remote call fails

    • reportErrorEvent

      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](https://support.google.com/cloud/answer/6158862) 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] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true:

      • Customer-managed encryption keys (CMEK) are disabled on the log bucket.
      • The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.

      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:
      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`.

      event - Required. The error event to be reported.
      Throws:
      ApiException - if the remote call fails

    • reportErrorEvent

      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](https://support.google.com/cloud/answer/6158862) 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] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true:

      • Customer-managed encryption keys (CMEK) are disabled on the log bucket.
      • The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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](https://support.google.com/cloud/answer/6158862) 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] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true:

      • Customer-managed encryption keys (CMEK) are disabled on the log bucket.
      • The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.

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

    • 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