com.google.cloud.errorreporting.v1beta1

Class ErrorStatsServiceClient

java.lang.Object

com.google.cloud.errorreporting.v1beta1.ErrorStatsServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class ErrorStatsServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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:

 
 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:

 
 ErrorStatsServiceSettings errorStatsServiceSettings =
     ErrorStatsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ErrorStatsServiceClient errorStatsServiceClient =
     ErrorStatsServiceClient.create(errorStatsServiceSettings);
 
 

To customize the endpoint:

 
 ErrorStatsServiceSettings errorStatsServiceSettings =
     ErrorStatsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ErrorStatsServiceClient errorStatsServiceClient =
     ErrorStatsServiceClient.create(errorStatsServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorStatsServiceClient.ListEventsFixedSizeCollection
static class	ErrorStatsServiceClient.ListEventsPage
static class	ErrorStatsServiceClient.ListEventsPagedResponse
static class	ErrorStatsServiceClient.ListGroupStatsFixedSizeCollection
static class	ErrorStatsServiceClient.ListGroupStatsPage
static class	ErrorStatsServiceClient.ListGroupStatsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ErrorStatsServiceClient(ErrorStatsServiceSettings settings) Constructs an instance of ErrorStatsServiceClient, using the given settings.
protected	ErrorStatsServiceClient(ErrorStatsServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ErrorStatsServiceClient	create() Constructs an instance of ErrorStatsServiceClient with default settings.
static ErrorStatsServiceClient	create(ErrorStatsServiceSettings settings) Constructs an instance of ErrorStatsServiceClient, using the given settings.
static ErrorStatsServiceClient	create(ErrorStatsServiceStub stub) Constructs an instance of ErrorStatsServiceClient, using the given stub for making calls.
DeleteEventsResponse	deleteEvents(DeleteEventsRequest request) Deletes all error events of a given project.
DeleteEventsResponse	deleteEvents(ProjectName projectName) Deletes all error events of a given project.
DeleteEventsResponse	deleteEvents(String projectName) Deletes all error events of a given project.
com.google.api.gax.rpc.UnaryCallable<DeleteEventsRequest,DeleteEventsResponse>	deleteEventsCallable() Deletes all error events of a given project.
ErrorStatsServiceSettings	getSettings()
ErrorStatsServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ErrorStatsServiceClient.ListEventsPagedResponse	listEvents(ListEventsRequest request) Lists the specified events.
ErrorStatsServiceClient.ListEventsPagedResponse	listEvents(ProjectName projectName, String groupId) Lists the specified events.
ErrorStatsServiceClient.ListEventsPagedResponse	listEvents(String projectName, String groupId) Lists the specified events.
com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,ListEventsResponse>	listEventsCallable() Lists the specified events.
com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,ErrorStatsServiceClient.ListEventsPagedResponse>	listEventsPagedCallable() Lists the specified events.
ErrorStatsServiceClient.ListGroupStatsPagedResponse	listGroupStats(ListGroupStatsRequest request) Lists the specified groups.
ErrorStatsServiceClient.ListGroupStatsPagedResponse	listGroupStats(ProjectName projectName, QueryTimeRange timeRange) Lists the specified groups.
ErrorStatsServiceClient.ListGroupStatsPagedResponse	listGroupStats(String projectName, QueryTimeRange timeRange) Lists the specified groups.
com.google.api.gax.rpc.UnaryCallable<ListGroupStatsRequest,ListGroupStatsResponse>	listGroupStatsCallable() Lists the specified groups.
com.google.api.gax.rpc.UnaryCallable<ListGroupStatsRequest,ErrorStatsServiceClient.ListGroupStatsPagedResponse>	listGroupStatsPagedCallable() Lists the specified groups.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorStatsServiceClient

protected ErrorStatsServiceClient(ErrorStatsServiceSettings settings)
                           throws IOException

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

ErrorStatsServiceClient

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

Method Detail

create

public static final ErrorStatsServiceClient create()
                                            throws IOException

Constructs an instance of ErrorStatsServiceClient with default settings.

Throws:

IOException

create

public static final ErrorStatsServiceClient create(ErrorStatsServiceSettings settings)
                                            throws IOException

Constructs an instance of ErrorStatsServiceClient, 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 ErrorStatsServiceClient create(ErrorStatsServiceStub stub)

Constructs an instance of ErrorStatsServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use ErrorStatsServiceSettings}.

getSettings

public final ErrorStatsServiceSettings getSettings()

getStub

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

listGroupStats

public final ErrorStatsServiceClient.ListGroupStatsPagedResponse listGroupStats(ProjectName projectName,
                                                                                QueryTimeRange timeRange)

Lists the specified groups.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
   for (ErrorGroupStats element : errorStatsServiceClient.listGroupStats(projectName, timeRange).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

projectName - [Required] The resource name of the Google Cloud Platform project. Written as <code>projects/</code> plus the <a href="https://support.google.com/cloud/answer/6158840">Google Cloud Platform project ID</a>.

Example: <code>projects/my-project-123</code>.

timeRange - [Optional] List data for the given time range. If not set a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only <code>ErrorGroupStats</code> with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also <code>ErrorGroupStats</code> with zero occurrences are returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGroupStats

public final ErrorStatsServiceClient.ListGroupStatsPagedResponse listGroupStats(String projectName,
                                                                                QueryTimeRange timeRange)

Lists the specified groups.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
   for (ErrorGroupStats element : errorStatsServiceClient.listGroupStats(projectName.toString(), timeRange).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

projectName - [Required] The resource name of the Google Cloud Platform project. Written as <code>projects/</code> plus the <a href="https://support.google.com/cloud/answer/6158840">Google Cloud Platform project ID</a>.

Example: <code>projects/my-project-123</code>.

timeRange - [Optional] List data for the given time range. If not set a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only <code>ErrorGroupStats</code> with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also <code>ErrorGroupStats</code> with zero occurrences are returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGroupStats

public final ErrorStatsServiceClient.ListGroupStatsPagedResponse listGroupStats(ListGroupStatsRequest request)

Lists the specified groups.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
   ListGroupStatsRequest request = ListGroupStatsRequest.newBuilder()
     .setProjectName(projectName.toString())
     .setTimeRange(timeRange)
     .build();
   for (ErrorGroupStats element : errorStatsServiceClient.listGroupStats(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGroupStatsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGroupStatsRequest,ErrorStatsServiceClient.ListGroupStatsPagedResponse> listGroupStatsPagedCallable()

Lists the specified groups.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
   ListGroupStatsRequest request = ListGroupStatsRequest.newBuilder()
     .setProjectName(projectName.toString())
     .setTimeRange(timeRange)
     .build();
   ApiFuture<ListGroupStatsPagedResponse> future = errorStatsServiceClient.listGroupStatsPagedCallable().futureCall(request);
   // Do something
   for (ErrorGroupStats element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listGroupStatsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGroupStatsRequest,ListGroupStatsResponse> listGroupStatsCallable()

Lists the specified groups.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   QueryTimeRange timeRange = QueryTimeRange.newBuilder().build();
   ListGroupStatsRequest request = ListGroupStatsRequest.newBuilder()
     .setProjectName(projectName.toString())
     .setTimeRange(timeRange)
     .build();
   while (true) {
     ListGroupStatsResponse response = errorStatsServiceClient.listGroupStatsCallable().call(request);
     for (ErrorGroupStats element : response.getErrorGroupStatsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

listEvents

public final ErrorStatsServiceClient.ListEventsPagedResponse listEvents(ProjectName projectName,
                                                                        String groupId)

Lists the specified events.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   String groupId = "";
   for (ErrorEvent element : errorStatsServiceClient.listEvents(projectName, groupId).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

groupId - [Required] The group for which events shall be returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEvents

public final ErrorStatsServiceClient.ListEventsPagedResponse listEvents(String projectName,
                                                                        String groupId)

Lists the specified events.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   String groupId = "";
   for (ErrorEvent element : errorStatsServiceClient.listEvents(projectName.toString(), groupId).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

groupId - [Required] The group for which events shall be returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEvents

public final ErrorStatsServiceClient.ListEventsPagedResponse listEvents(ListEventsRequest request)

Lists the specified events.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   String groupId = "";
   ListEventsRequest request = ListEventsRequest.newBuilder()
     .setProjectName(projectName.toString())
     .setGroupId(groupId)
     .build();
   for (ErrorEvent element : errorStatsServiceClient.listEvents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEventsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,ErrorStatsServiceClient.ListEventsPagedResponse> listEventsPagedCallable()

Lists the specified events.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   String groupId = "";
   ListEventsRequest request = ListEventsRequest.newBuilder()
     .setProjectName(projectName.toString())
     .setGroupId(groupId)
     .build();
   ApiFuture<ListEventsPagedResponse> future = errorStatsServiceClient.listEventsPagedCallable().futureCall(request);
   // Do something
   for (ErrorEvent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listEventsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEventsRequest,ListEventsResponse> listEventsCallable()

Lists the specified events.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   String groupId = "";
   ListEventsRequest request = ListEventsRequest.newBuilder()
     .setProjectName(projectName.toString())
     .setGroupId(groupId)
     .build();
   while (true) {
     ListEventsResponse response = errorStatsServiceClient.listEventsCallable().call(request);
     for (ErrorEvent element : response.getErrorEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteEvents

public final DeleteEventsResponse deleteEvents(ProjectName projectName)

Deletes all error events of a given project.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   DeleteEventsResponse response = errorStatsServiceClient.deleteEvents(projectName);
 }
 

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEvents

public final DeleteEventsResponse deleteEvents(String projectName)

Deletes all error events of a given project.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   DeleteEventsResponse response = errorStatsServiceClient.deleteEvents(projectName.toString());
 }
 

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEvents

public final DeleteEventsResponse deleteEvents(DeleteEventsRequest request)

Deletes all error events of a given project.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   DeleteEventsRequest request = DeleteEventsRequest.newBuilder()
     .setProjectName(projectName.toString())
     .build();
   DeleteEventsResponse response = errorStatsServiceClient.deleteEvents(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEventsCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteEventsRequest,DeleteEventsResponse> deleteEventsCallable()

Deletes all error events of a given project.

Sample code:

 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ProjectName projectName = ProjectName.of("[PROJECT]");
   DeleteEventsRequest request = DeleteEventsRequest.newBuilder()
     .setProjectName(projectName.toString())
     .build();
   ApiFuture<DeleteEventsResponse> future = errorStatsServiceClient.deleteEventsCallable().futureCall(request);
   // Do something
   DeleteEventsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException