com.google.cloud.errorreporting.v1beta1

Class ErrorGroupServiceClient

java.lang.Object

com.google.cloud.errorreporting.v1beta1.ErrorGroupServiceClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class ErrorGroupServiceClient
extends Object
implements com.google.api.gax.core.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:

 
 try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   GroupName groupName = GroupName.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:

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 ErrorGroupServiceSettings to create(). For example:

To customize credentials:

 
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);
 
 

To customize the endpoint:

 
 ErrorGroupServiceSettings errorGroupServiceSettings =
     ErrorGroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ErrorGroupServiceClient errorGroupServiceClient =
     ErrorGroupServiceClient.create(errorGroupServiceSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ErrorGroupServiceClient(ErrorGroupServiceSettings settings) Constructs an instance of ErrorGroupServiceClient, using the given settings.
protected	ErrorGroupServiceClient(ErrorGroupServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ErrorGroupServiceClient	create() Constructs an instance of ErrorGroupServiceClient with default settings.
static ErrorGroupServiceClient	create(ErrorGroupServiceSettings settings) Constructs an instance of ErrorGroupServiceClient, using the given settings.
static ErrorGroupServiceClient	create(ErrorGroupServiceStub stub) Constructs an instance of ErrorGroupServiceClient, using the given stub for making calls.
ErrorGroup	getGroup(GetGroupRequest request) Get the specified group.
ErrorGroup	getGroup(GroupName groupName) Get the specified group.
ErrorGroup	getGroup(String groupName) Get the specified group.
com.google.api.gax.rpc.UnaryCallable<GetGroupRequest,ErrorGroup>	getGroupCallable() Get the specified group.
ErrorGroupServiceSettings	getSettings()
ErrorGroupServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
ErrorGroup	updateGroup(ErrorGroup group) Replace the data for the specified group.
ErrorGroup	updateGroup(UpdateGroupRequest request) Replace the data for the specified group.
com.google.api.gax.rpc.UnaryCallable<UpdateGroupRequest,ErrorGroup>	updateGroupCallable() Replace the data for the specified group.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorGroupServiceClient

protected ErrorGroupServiceClient(ErrorGroupServiceSettings settings)
                           throws IOException

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.

Throws:

IOException

ErrorGroupServiceClient

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

Method Detail

create

public static final ErrorGroupServiceClient create()
                                            throws IOException

Constructs an instance of ErrorGroupServiceClient with default settings.

Throws:

IOException

create

public static final ErrorGroupServiceClient create(ErrorGroupServiceSettings settings)
                                            throws IOException

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.

Throws:

IOException

create

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

getSettings

public final ErrorGroupServiceSettings getSettings()

getStub

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

getGroup

public final ErrorGroup getGroup(GroupName groupName)

Get the specified group.

Sample code:

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

Parameters:

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>

Throws:

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

getGroup

public final ErrorGroup getGroup(String groupName)

Get the specified group.

Sample code:

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

Parameters:

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>

Throws:

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

getGroup

public final ErrorGroup getGroup(GetGroupRequest request)

Get the specified group.

Sample code:

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

getGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<GetGroupRequest,ErrorGroup> getGroupCallable()

Get the specified group.

Sample code:

 try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   GroupName groupName = GroupName.of("[PROJECT]", "[GROUP]");
   GetGroupRequest request = GetGroupRequest.newBuilder()
     .setGroupName(groupName.toString())
     .build();
   ApiFuture<ErrorGroup> future = errorGroupServiceClient.getGroupCallable().futureCall(request);
   // Do something
   ErrorGroup response = future.get();
 }
 

updateGroup

public final ErrorGroup updateGroup(ErrorGroup group)

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

Sample code:

 try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
   ErrorGroup group = ErrorGroup.newBuilder().build();
   ErrorGroup response = errorGroupServiceClient.updateGroup(group);
 }
 

Parameters:

group - [Required] The group which replaces the resource on the server.

Throws:

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

updateGroup

public final ErrorGroup updateGroup(UpdateGroupRequest request)

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

Sample code:

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

updateGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateGroupRequest,ErrorGroup> updateGroupCallable()

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

Sample code:

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