Class ErrorStatsServiceClient

public class ErrorStatsServiceClient implements 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);
 

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

Inheritance

java.lang.Object > ErrorStatsServiceClient

Implements

BackgroundResource

Constructors

ErrorStatsServiceClient(ErrorStatsServiceSettings settings)

protected ErrorStatsServiceClient(ErrorStatsServiceSettings settings)

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.

Parameter
NameDescription
settingsErrorStatsServiceSettings

ErrorStatsServiceClient(ErrorStatsServiceStub stub)

protected ErrorStatsServiceClient(ErrorStatsServiceStub stub)
Parameter
NameDescription
stubErrorStatsServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

create()

public static final ErrorStatsServiceClient create()

Constructs an instance of ErrorStatsServiceClient with default settings.

Returns
TypeDescription
ErrorStatsServiceClient
Exceptions
TypeDescription
IOException

create(ErrorStatsServiceSettings settings)

public static final ErrorStatsServiceClient create(ErrorStatsServiceSettings settings)

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.

Parameter
NameDescription
settingsErrorStatsServiceSettings
Returns
TypeDescription
ErrorStatsServiceClient
Exceptions
TypeDescription
IOException

create(ErrorStatsServiceStub stub)

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 using create(ErrorStatsServiceSettings).

Parameter
NameDescription
stubErrorStatsServiceStub
Returns
TypeDescription
ErrorStatsServiceClient

deleteEvents(DeleteEventsRequest request)

public final DeleteEventsResponse deleteEvents(DeleteEventsRequest request)

Deletes all error events of a given project.

Sample code:


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

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

Returns
TypeDescription
DeleteEventsResponse

deleteEvents(ProjectName projectName)

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);
 }
 
Parameter
NameDescription
projectNameProjectName

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.

Returns
TypeDescription
DeleteEventsResponse

deleteEvents(String projectName)

public final DeleteEventsResponse deleteEvents(String projectName)

Deletes all error events of a given project.

Sample code:


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

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.

Returns
TypeDescription
DeleteEventsResponse

deleteEventsCallable()

public final UnaryCallable<DeleteEventsRequest,DeleteEventsResponse> deleteEventsCallable()

Deletes all error events of a given project.

Sample code:


 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   DeleteEventsRequest request =
       DeleteEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<DeleteEventsRequest,DeleteEventsResponse>

getSettings()

public final ErrorStatsServiceSettings getSettings()
Returns
TypeDescription
ErrorStatsServiceSettings

getStub()

public ErrorStatsServiceStub getStub()
Returns
TypeDescription
ErrorStatsServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listEvents(ListEventsRequest request)

public final ErrorStatsServiceClient.ListEventsPagedResponse listEvents(ListEventsRequest request)

Lists the specified events.

Sample code:


 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .setGroupId("groupId293428218")
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ErrorEvent element : errorStatsServiceClient.listEvents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListEventsRequest

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

Returns
TypeDescription
ErrorStatsServiceClient.ListEventsPagedResponse

listEvents(ProjectName projectName, String groupId)

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 = "groupId293428218";
   for (ErrorEvent element :
       errorStatsServiceClient.listEvents(projectName, groupId).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameters
NameDescription
projectNameProjectName

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.

groupIdString

Required. The group for which events shall be returned.

Returns
TypeDescription
ErrorStatsServiceClient.ListEventsPagedResponse

listEvents(String projectName, String groupId)

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

Lists the specified events.

Sample code:


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

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.

groupIdString

Required. The group for which events shall be returned.

Returns
TypeDescription
ErrorStatsServiceClient.ListEventsPagedResponse

listEventsCallable()

public final UnaryCallable<ListEventsRequest,ListEventsResponse> listEventsCallable()

Lists the specified events.

Sample code:


 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .setGroupId("groupId293428218")
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEventsResponse response = errorStatsServiceClient.listEventsCallable().call(request);
     for (ErrorEvent element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListEventsRequest,ListEventsResponse>

listEventsPagedCallable()

public final UnaryCallable<ListEventsRequest,ErrorStatsServiceClient.ListEventsPagedResponse> listEventsPagedCallable()

Lists the specified events.

Sample code:


 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListEventsRequest request =
       ListEventsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .setGroupId("groupId293428218")
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<ListEventsRequest,ListEventsPagedResponse>

listGroupStats(ListGroupStatsRequest request)

public final ErrorStatsServiceClient.ListGroupStatsPagedResponse listGroupStats(ListGroupStatsRequest request)

Lists the specified groups.

Sample code:


 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListGroupStatsRequest request =
       ListGroupStatsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .addAllGroupId(new ArrayList<String>())
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setTimedCountDuration(Duration.newBuilder().build())
           .setAlignment(TimedCountAlignment.forNumber(0))
           .setAlignmentTime(Timestamp.newBuilder().build())
           .setOrder(ErrorGroupOrder.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ErrorGroupStats element : errorStatsServiceClient.listGroupStats(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListGroupStatsRequest

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

Returns
TypeDescription
ErrorStatsServiceClient.ListGroupStatsPagedResponse

listGroupStats(ProjectName projectName, QueryTimeRange timeRange)

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
NameDescription
projectNameProjectName

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud Console.

Examples: projects/my-project-123, projects/5551234.

timeRangeQueryTimeRange

Optional. List data for the given time range. If not set, a default time range is used. The field <code>time_range_begin</code> 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 <code>group_id</code> list. If a <code>group_id</code> list is given, also <code>ErrorGroupStats</code> with zero occurrences are returned.

Returns
TypeDescription
ErrorStatsServiceClient.ListGroupStatsPagedResponse

listGroupStats(String projectName, QueryTimeRange timeRange)

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

Lists the specified groups.

Sample code:


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

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud Console.

Examples: projects/my-project-123, projects/5551234.

timeRangeQueryTimeRange

Optional. List data for the given time range. If not set, a default time range is used. The field <code>time_range_begin</code> 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 <code>group_id</code> list. If a <code>group_id</code> list is given, also <code>ErrorGroupStats</code> with zero occurrences are returned.

Returns
TypeDescription
ErrorStatsServiceClient.ListGroupStatsPagedResponse

listGroupStatsCallable()

public final UnaryCallable<ListGroupStatsRequest,ListGroupStatsResponse> listGroupStatsCallable()

Lists the specified groups.

Sample code:


 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListGroupStatsRequest request =
       ListGroupStatsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .addAllGroupId(new ArrayList<String>())
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setTimedCountDuration(Duration.newBuilder().build())
           .setAlignment(TimedCountAlignment.forNumber(0))
           .setAlignmentTime(Timestamp.newBuilder().build())
           .setOrder(ErrorGroupOrder.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListGroupStatsResponse response =
         errorStatsServiceClient.listGroupStatsCallable().call(request);
     for (ErrorGroupStats element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListGroupStatsRequest,ListGroupStatsResponse>

listGroupStatsPagedCallable()

public final UnaryCallable<ListGroupStatsRequest,ErrorStatsServiceClient.ListGroupStatsPagedResponse> listGroupStatsPagedCallable()

Lists the specified groups.

Sample code:


 try (ErrorStatsServiceClient errorStatsServiceClient = ErrorStatsServiceClient.create()) {
   ListGroupStatsRequest request =
       ListGroupStatsRequest.newBuilder()
           .setProjectName(ProjectName.of("[PROJECT]").toString())
           .addAllGroupId(new ArrayList<String>())
           .setServiceFilter(ServiceContextFilter.newBuilder().build())
           .setTimeRange(QueryTimeRange.newBuilder().build())
           .setTimedCountDuration(Duration.newBuilder().build())
           .setAlignment(TimedCountAlignment.forNumber(0))
           .setAlignmentTime(Timestamp.newBuilder().build())
           .setOrder(ErrorGroupOrder.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<ListGroupStatsRequest,ListGroupStatsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()