ReportErrorsServiceClient (Google Cloud 0.89.0-alpha API)

java.lang.Object
- com.google.cloud.errorreporting.v1beta1.ReportErrorsServiceClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
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:
```
 
 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:
```
 
 ReportErrorsServiceSettings reportErrorsServiceSettings =
     ReportErrorsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReportErrorsServiceClient reportErrorsServiceClient =
     ReportErrorsServiceClient.create(reportErrorsServiceSettings);
 
 
```
To customize the endpoint:
```
 
 ReportErrorsServiceSettings reportErrorsServiceSettings =
     ReportErrorsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReportErrorsServiceClient reportErrorsServiceClient =
     ReportErrorsServiceClient.create(reportErrorsServiceSettings);
 
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ReportErrorsServiceClient(ReportErrorsServiceSettings settings)` Constructs an instance of ReportErrorsServiceClient, using the given settings.
`protected`	`ReportErrorsServiceClient(ReportErrorsServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ReportErrorsServiceClient`	`create()` Constructs an instance of ReportErrorsServiceClient with default settings.
`static ReportErrorsServiceClient`	`create(ReportErrorsServiceSettings settings)` Constructs an instance of ReportErrorsServiceClient, using the given settings.
`static ReportErrorsServiceClient`	`create(ReportErrorsServiceStub stub)` Constructs an instance of ReportErrorsServiceClient, using the given stub for making calls.
`ReportErrorsServiceSettings`	`getSettings()`
`ReportErrorsServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse`	`reportErrorEvent(com.google.devtools.clouderrorreporting.v1beta1.ProjectName projectName, com.google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent event)` Report an individual error event.
`com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse`	`reportErrorEvent(com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventRequest request)` Report an individual error event.
`com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse`	`reportErrorEvent(String projectName, com.google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent event)` Report an individual error event.
`UnaryCallable<com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventRequest,com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse>`	`reportErrorEventCallable()` Report an individual error event.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected ReportErrorsServiceClient(ReportErrorsServiceStub stub)

Method Detail

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use ReportErrorsServiceSettings}.

getSettings

public final ReportErrorsServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public ReportErrorsServiceStub getStub()

reportErrorEvent
```
public final com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse reportErrorEvent(com.google.devtools.clouderrorreporting.v1beta1.ProjectName projectName,
 com.google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent event)
```
Report an individual error event.
This endpoint accepts either an OAuth token, or an <a href="https://support.google.com/cloud/answer/6158862">API key</a> for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: <pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>
Sample code:
```
 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/` plus 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 com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse reportErrorEvent(String projectName,
 com.google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent event)
```
Report an individual error event.
This endpoint accepts either an OAuth token, or an <a href="https://support.google.com/cloud/answer/6158862">API key</a> for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: <pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>
Sample code:
```
 try (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
 ProjectName projectName = ProjectName.of("[PROJECT]");
 ReportedErrorEvent event = ReportedErrorEvent.newBuilder().build();
 ReportErrorEventResponse response = reportErrorsServiceClient.reportErrorEvent(projectName.toString(), event);
 }
 
```
Parameters:

projectName - [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus 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 com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse reportErrorEvent(com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventRequest request)

Report an individual error event.

This endpoint accepts either an OAuth token, or an <a href="https://support.google.com/cloud/answer/6158862">API key</a> for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: <pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>

Sample code:


 try (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   ReportedErrorEvent event = ReportedErrorEvent.newBuilder().build();
   ReportErrorEventRequest request = ReportErrorEventRequest.newBuilder()
     .setProjectName(projectName.toString())
     .setEvent(event)
     .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<com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventRequest,com.google.devtools.clouderrorreporting.v1beta1.ReportErrorEventResponse> reportErrorEventCallable()

Report an individual error event.

Sample code:


 try (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   ReportedErrorEvent event = ReportedErrorEvent.newBuilder().build();
   ReportErrorEventRequest request = ReportErrorEventRequest.newBuilder()
     .setProjectName(projectName.toString())
     .setEvent(event)
     .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

Class ReportErrorsServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReportErrorsServiceClient

ReportErrorsServiceClient

Method Detail

create

create

create

getSettings

getStub

reportErrorEvent

reportErrorEvent

reportErrorEvent

reportErrorEventCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination