Class ErrorGroupServiceClient (0.139.0-beta)

public class ErrorGroupServiceClient implements BackgroundResource

Service Description: Service for retrieving and updating individual error groups.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
 }

Note: close() needs to be called on the ErrorGroupServiceClient 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:

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.
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.
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 ErrorGroupServiceSettings 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
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);

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
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);

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
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newHttpJsonBuilder().build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);

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

Inheritance

java.lang.Object > ErrorGroupServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ErrorGroupServiceClient create()

Constructs an instance of ErrorGroupServiceClient with default settings.

Returns
Type	Description
`ErrorGroupServiceClient`

Exceptions
Type	Description
`IOException`

create(ErrorGroupServiceSettings settings)

public static final ErrorGroupServiceClient create(ErrorGroupServiceSettings settings)

Constructs an instance of ErrorGroupServiceClient, 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`	`ErrorGroupServiceSettings`

Returns
Type	Description
`ErrorGroupServiceClient`

Exceptions
Type	Description
`IOException`

create(ErrorGroupServiceStub stub)

public static final ErrorGroupServiceClient create(ErrorGroupServiceStub stub)

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

Parameter
Name	Description
`stub`	`ErrorGroupServiceStub`

Returns
Type	Description
`ErrorGroupServiceClient`

Constructors

ErrorGroupServiceClient(ErrorGroupServiceSettings settings)

protected ErrorGroupServiceClient(ErrorGroupServiceSettings settings)

Constructs an instance of ErrorGroupServiceClient, 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`	`ErrorGroupServiceSettings`

ErrorGroupServiceClient(ErrorGroupServiceStub stub)

protected ErrorGroupServiceClient(ErrorGroupServiceStub stub)

Parameter
Name	Description
`stub`	`ErrorGroupServiceStub`

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

getGroup(ErrorGroupName groupName)

public final ErrorGroup getGroup(ErrorGroupName groupName)

Get the specified group.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   ErrorGroupName groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]");
   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
 }

Parameter

Name Description

groupName

ErrorGroupName

Required. The group resource name. Written as projects/{projectID}/groups/{group_name}. Call groupStats.list to return a list of groups belonging to this project.

Example: projects/my-project-123/groups/my-group

Returns
Type	Description
`ErrorGroup`

getGroup(GetGroupRequest request)

public final ErrorGroup getGroup(GetGroupRequest request)

Get the specified group.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   GetGroupRequest request =
       GetGroupRequest.newBuilder()
           .setGroupName(ErrorGroupName.of("[PROJECT]", "[GROUP]").toString())
           .build();
   ErrorGroup response = errorGroupServiceClient.getGroup(request);
 }

Parameter
Name	Description
`request`	`GetGroupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ErrorGroup`

getGroup(GroupName groupName) (deprecated)

public final ErrorGroup getGroup(GroupName groupName)

Deprecated. Use ErrorGroupServiceClient#getGroup(ErrorGroupName)

Get the specified group.

Sample code:


 try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   GroupName groupName = GroupName.of("[PROJECT]", "[GROUP]");
   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
 }

Parameter

Name Description

groupName

GroupName

Required. The group resource name. Written as <code>projects/<var>projectID</var>/groups/<var>group_name</var></code>. Call <a href="/error-reporting/reference/rest/v1beta1/projects.groupStats/list"> <code>groupStats.list</code></a> to return a list of groups belonging to this project.

Example: <code>projects/my-project-123/groups/my-group</code>

Returns
Type	Description
`ErrorGroup`

getGroup(String groupName)

public final ErrorGroup getGroup(String groupName)

Get the specified group.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   String groupName = ErrorGroupName.of("[PROJECT]", "[GROUP]").toString();
   ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
 }

Parameter

Name Description

groupName

String

Required. The group resource name. Written as projects/{projectID}/groups/{group_name}. Call groupStats.list to return a list of groups belonging to this project.

Example: projects/my-project-123/groups/my-group

Returns
Type	Description
`ErrorGroup`

getGroupCallable()

public final UnaryCallable<GetGroupRequest,ErrorGroup> getGroupCallable()

Get the specified group.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   GetGroupRequest request =
       GetGroupRequest.newBuilder()
           .setGroupName(ErrorGroupName.of("[PROJECT]", "[GROUP]").toString())
           .build();
   ApiFuture<ErrorGroup> future = errorGroupServiceClient.getGroupCallable().futureCall(request);
   // Do something.
   ErrorGroup response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetGroupRequest,ErrorGroup>`

getSettings()

public final ErrorGroupServiceSettings getSettings()

Returns
Type	Description
`ErrorGroupServiceSettings`

getStub()

public ErrorGroupServiceStub getStub()

Returns
Type	Description
`ErrorGroupServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateGroup(ErrorGroup group)

public final ErrorGroup updateGroup(ErrorGroup group)

Replace the data for the specified group. Fails if the group does not exist.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   ErrorGroup group = ErrorGroup.newBuilder().build();
   ErrorGroup response = errorGroupServiceClient.updateGroup(group);
 }

Parameter
Name	Description
`group`	`ErrorGroup` Required. The group which replaces the resource on the server.

Returns
Type	Description
`ErrorGroup`

updateGroup(UpdateGroupRequest request)

public final ErrorGroup updateGroup(UpdateGroupRequest request)

Replace the data for the specified group. Fails if the group does not exist.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   UpdateGroupRequest request =
       UpdateGroupRequest.newBuilder().setGroup(ErrorGroup.newBuilder().build()).build();
   ErrorGroup response = errorGroupServiceClient.updateGroup(request);
 }

Parameter
Name	Description
`request`	`UpdateGroupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ErrorGroup`

updateGroupCallable()

public final UnaryCallable<UpdateGroupRequest,ErrorGroup> updateGroupCallable()

Replace the data for the specified group. Fails if the group does not exist.

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 (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   UpdateGroupRequest request =
       UpdateGroupRequest.newBuilder().setGroup(ErrorGroup.newBuilder().build()).build();
   ApiFuture<ErrorGroup> future =
       errorGroupServiceClient.updateGroupCallable().futureCall(request);
   // Do something.
   ErrorGroup response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateGroupRequest,ErrorGroup>`