com.google.cloud.monitoring.v3

Class GroupServiceClient

java.lang.Object

com.google.cloud.monitoring.v3.GroupServiceClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
public class GroupServiceClient
extends Object
implements BackgroundResource

Service Description: The Group API lets you inspect and manage your [groups](#google.monitoring.v3.Group).

A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   Group response = groupServiceClient.getGroup(name);
 }
 
 

Note: close() needs to be called on the groupServiceClient 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 GroupServiceSettings to create(). For example:

To customize credentials:

 
 GroupServiceSettings groupServiceSettings =
     GroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GroupServiceClient groupServiceClient =
     GroupServiceClient.create(groupServiceSettings);
 
 

To customize the endpoint:

 
 GroupServiceSettings groupServiceSettings =
     GroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 GroupServiceClient groupServiceClient =
     GroupServiceClient.create(groupServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupServiceClient.ListGroupMembersFixedSizeCollection
static class	GroupServiceClient.ListGroupMembersPage
static class	GroupServiceClient.ListGroupMembersPagedResponse
static class	GroupServiceClient.ListGroupsFixedSizeCollection
static class	GroupServiceClient.ListGroupsPage
static class	GroupServiceClient.ListGroupsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GroupServiceClient(GroupServiceSettings settings) Constructs an instance of GroupServiceClient, using the given settings.
protected	GroupServiceClient(GroupServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static GroupServiceClient	create() Constructs an instance of GroupServiceClient with default settings.
static GroupServiceClient	create(GroupServiceSettings settings) Constructs an instance of GroupServiceClient, using the given settings.
static GroupServiceClient	create(GroupServiceStub stub) Constructs an instance of GroupServiceClient, using the given stub for making calls.
com.google.monitoring.v3.Group	createGroup(com.google.monitoring.v3.CreateGroupRequest request) Creates a new group.
com.google.monitoring.v3.Group	createGroup(com.google.monitoring.v3.ProjectName name, com.google.monitoring.v3.Group group) Creates a new group.
com.google.monitoring.v3.Group	createGroup(String name, com.google.monitoring.v3.Group group) Creates a new group.
UnaryCallable<com.google.monitoring.v3.CreateGroupRequest,com.google.monitoring.v3.Group>	createGroupCallable() Creates a new group.
void	deleteGroup(com.google.monitoring.v3.DeleteGroupRequest request) Deletes an existing group.
void	deleteGroup(com.google.monitoring.v3.GroupName name) Deletes an existing group.
void	deleteGroup(String name) Deletes an existing group.
UnaryCallable<com.google.monitoring.v3.DeleteGroupRequest,Empty>	deleteGroupCallable() Deletes an existing group.
com.google.monitoring.v3.Group	getGroup(com.google.monitoring.v3.GetGroupRequest request) Gets a single group.
com.google.monitoring.v3.Group	getGroup(com.google.monitoring.v3.GroupName name) Gets a single group.
com.google.monitoring.v3.Group	getGroup(String name) Gets a single group.
UnaryCallable<com.google.monitoring.v3.GetGroupRequest,com.google.monitoring.v3.Group>	getGroupCallable() Gets a single group.
GroupServiceSettings	getSettings()
GroupServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
GroupServiceClient.ListGroupMembersPagedResponse	listGroupMembers(com.google.monitoring.v3.GroupName name) Lists the monitored resources that are members of a group.
GroupServiceClient.ListGroupMembersPagedResponse	listGroupMembers(com.google.monitoring.v3.ListGroupMembersRequest request) Lists the monitored resources that are members of a group.
GroupServiceClient.ListGroupMembersPagedResponse	listGroupMembers(String name) Lists the monitored resources that are members of a group.
UnaryCallable<com.google.monitoring.v3.ListGroupMembersRequest,com.google.monitoring.v3.ListGroupMembersResponse>	listGroupMembersCallable() Lists the monitored resources that are members of a group.
UnaryCallable<com.google.monitoring.v3.ListGroupMembersRequest,GroupServiceClient.ListGroupMembersPagedResponse>	listGroupMembersPagedCallable() Lists the monitored resources that are members of a group.
GroupServiceClient.ListGroupsPagedResponse	listGroups(com.google.monitoring.v3.ListGroupsRequest request) Lists the existing groups.
UnaryCallable<com.google.monitoring.v3.ListGroupsRequest,com.google.monitoring.v3.ListGroupsResponse>	listGroupsCallable() Lists the existing groups.
UnaryCallable<com.google.monitoring.v3.ListGroupsRequest,GroupServiceClient.ListGroupsPagedResponse>	listGroupsPagedCallable() Lists the existing groups.
void	shutdown()
void	shutdownNow()
com.google.monitoring.v3.Group	updateGroup(com.google.monitoring.v3.Group group) Updates an existing group.
com.google.monitoring.v3.Group	updateGroup(com.google.monitoring.v3.UpdateGroupRequest request) Updates an existing group.
UnaryCallable<com.google.monitoring.v3.UpdateGroupRequest,com.google.monitoring.v3.Group>	updateGroupCallable() Updates an existing group.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupServiceClient

protected GroupServiceClient(GroupServiceSettings settings)
                      throws IOException

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

GroupServiceClient

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

Method Detail

create

public static final GroupServiceClient create()
                                       throws IOException

Constructs an instance of GroupServiceClient with default settings.

Throws:

IOException

create

public static final GroupServiceClient create(GroupServiceSettings settings)
                                       throws IOException

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

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

getSettings

public final GroupServiceSettings getSettings()

getStub

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

listGroups

public final GroupServiceClient.ListGroupsPagedResponse listGroups(com.google.monitoring.v3.ListGroupsRequest request)

Lists the existing groups.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListGroupsRequest request = ListGroupsRequest.newBuilder()
     .setName(name.toString())
     .build();
   for (Group element : groupServiceClient.listGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

listGroupsPagedCallable

public final UnaryCallable<com.google.monitoring.v3.ListGroupsRequest,GroupServiceClient.ListGroupsPagedResponse> listGroupsPagedCallable()

Lists the existing groups.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListGroupsRequest request = ListGroupsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListGroupsPagedResponse> future = groupServiceClient.listGroupsPagedCallable().futureCall(request);
   // Do something
   for (Group element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listGroupsCallable

public final UnaryCallable<com.google.monitoring.v3.ListGroupsRequest,com.google.monitoring.v3.ListGroupsResponse> listGroupsCallable()

Lists the existing groups.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListGroupsRequest request = ListGroupsRequest.newBuilder()
     .setName(name.toString())
     .build();
   while (true) {
     ListGroupsResponse response = groupServiceClient.listGroupsCallable().call(request);
     for (Group element : response.getGroupList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getGroup

public final com.google.monitoring.v3.Group getGroup(com.google.monitoring.v3.GroupName name)

Gets a single group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   Group response = groupServiceClient.getGroup(name);
 }
 

Parameters:

name - The group to retrieve. The format is `"projects/{project_id_or_number}/groups/{group_id}"`.

Throws:

ApiException - if the remote call fails

getGroup

public final com.google.monitoring.v3.Group getGroup(String name)

Gets a single group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   Group response = groupServiceClient.getGroup(name.toString());
 }
 

Parameters:

name - The group to retrieve. The format is `"projects/{project_id_or_number}/groups/{group_id}"`.

Throws:

ApiException - if the remote call fails

getGroup

public final com.google.monitoring.v3.Group getGroup(com.google.monitoring.v3.GetGroupRequest request)

Gets a single group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   GetGroupRequest request = GetGroupRequest.newBuilder()
     .setName(name.toString())
     .build();
   Group response = groupServiceClient.getGroup(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

getGroupCallable

public final UnaryCallable<com.google.monitoring.v3.GetGroupRequest,com.google.monitoring.v3.Group> getGroupCallable()

Gets a single group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   GetGroupRequest request = GetGroupRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Group> future = groupServiceClient.getGroupCallable().futureCall(request);
   // Do something
   Group response = future.get();
 }
 

createGroup

public final com.google.monitoring.v3.Group createGroup(com.google.monitoring.v3.ProjectName name,
                                                        com.google.monitoring.v3.Group group)

Creates a new group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Group group = Group.newBuilder().build();
   Group response = groupServiceClient.createGroup(name, group);
 }
 

Parameters:

name - The project in which to create the group. The format is `"projects/{project_id_or_number}"`.

group - A group definition. It is an error to define the `name` field because the system assigns the name.

Throws:

ApiException - if the remote call fails

createGroup

public final com.google.monitoring.v3.Group createGroup(String name,
                                                        com.google.monitoring.v3.Group group)

Creates a new group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Group group = Group.newBuilder().build();
   Group response = groupServiceClient.createGroup(name.toString(), group);
 }
 

Parameters:

name - The project in which to create the group. The format is `"projects/{project_id_or_number}"`.

group - A group definition. It is an error to define the `name` field because the system assigns the name.

Throws:

ApiException - if the remote call fails

createGroup

public final com.google.monitoring.v3.Group createGroup(com.google.monitoring.v3.CreateGroupRequest request)

Creates a new group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Group group = Group.newBuilder().build();
   CreateGroupRequest request = CreateGroupRequest.newBuilder()
     .setName(name.toString())
     .setGroup(group)
     .build();
   Group response = groupServiceClient.createGroup(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

createGroupCallable

public final UnaryCallable<com.google.monitoring.v3.CreateGroupRequest,com.google.monitoring.v3.Group> createGroupCallable()

Creates a new group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Group group = Group.newBuilder().build();
   CreateGroupRequest request = CreateGroupRequest.newBuilder()
     .setName(name.toString())
     .setGroup(group)
     .build();
   ApiFuture<Group> future = groupServiceClient.createGroupCallable().futureCall(request);
   // Do something
   Group response = future.get();
 }
 

updateGroup

public final com.google.monitoring.v3.Group updateGroup(com.google.monitoring.v3.Group group)

Updates an existing group. You can change any group attributes except `name`.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   Group group = Group.newBuilder().build();
   Group response = groupServiceClient.updateGroup(group);
 }
 

Parameters:

group - The new definition of the group. All fields of the existing group, excepting `name`, are replaced with the corresponding fields of this group.

Throws:

ApiException - if the remote call fails

updateGroup

public final com.google.monitoring.v3.Group updateGroup(com.google.monitoring.v3.UpdateGroupRequest request)

Updates an existing group. You can change any group attributes except `name`.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   Group group = Group.newBuilder().build();
   UpdateGroupRequest request = UpdateGroupRequest.newBuilder()
     .setGroup(group)
     .build();
   Group response = groupServiceClient.updateGroup(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

updateGroupCallable

public final UnaryCallable<com.google.monitoring.v3.UpdateGroupRequest,com.google.monitoring.v3.Group> updateGroupCallable()

Updates an existing group. You can change any group attributes except `name`.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   Group group = Group.newBuilder().build();
   UpdateGroupRequest request = UpdateGroupRequest.newBuilder()
     .setGroup(group)
     .build();
   ApiFuture<Group> future = groupServiceClient.updateGroupCallable().futureCall(request);
   // Do something
   Group response = future.get();
 }
 

deleteGroup

public final void deleteGroup(com.google.monitoring.v3.GroupName name)

Deletes an existing group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   groupServiceClient.deleteGroup(name);
 }
 

Parameters:

name - The group to delete. The format is `"projects/{project_id_or_number}/groups/{group_id}"`.

Throws:

ApiException - if the remote call fails

deleteGroup

public final void deleteGroup(String name)

Deletes an existing group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   groupServiceClient.deleteGroup(name.toString());
 }
 

Parameters:

name - The group to delete. The format is `"projects/{project_id_or_number}/groups/{group_id}"`.

Throws:

ApiException - if the remote call fails

deleteGroup

public final void deleteGroup(com.google.monitoring.v3.DeleteGroupRequest request)

Deletes an existing group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   DeleteGroupRequest request = DeleteGroupRequest.newBuilder()
     .setName(name.toString())
     .build();
   groupServiceClient.deleteGroup(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

deleteGroupCallable

public final UnaryCallable<com.google.monitoring.v3.DeleteGroupRequest,Empty> deleteGroupCallable()

Deletes an existing group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   DeleteGroupRequest request = DeleteGroupRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = groupServiceClient.deleteGroupCallable().futureCall(request);
   // Do something
   future.get();
 }
 

listGroupMembers

public final GroupServiceClient.ListGroupMembersPagedResponse listGroupMembers(com.google.monitoring.v3.GroupName name)

Lists the monitored resources that are members of a group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   for (MonitoredResource element : groupServiceClient.listGroupMembers(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The group whose members are listed. The format is `"projects/{project_id_or_number}/groups/{group_id}"`.

Throws:

ApiException - if the remote call fails

listGroupMembers

public final GroupServiceClient.ListGroupMembersPagedResponse listGroupMembers(String name)

Lists the monitored resources that are members of a group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   for (MonitoredResource element : groupServiceClient.listGroupMembers(name.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The group whose members are listed. The format is `"projects/{project_id_or_number}/groups/{group_id}"`.

Throws:

ApiException - if the remote call fails

listGroupMembers

public final GroupServiceClient.ListGroupMembersPagedResponse listGroupMembers(com.google.monitoring.v3.ListGroupMembersRequest request)

Lists the monitored resources that are members of a group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   ListGroupMembersRequest request = ListGroupMembersRequest.newBuilder()
     .setName(name.toString())
     .build();
   for (MonitoredResource element : groupServiceClient.listGroupMembers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

listGroupMembersPagedCallable

public final UnaryCallable<com.google.monitoring.v3.ListGroupMembersRequest,GroupServiceClient.ListGroupMembersPagedResponse> listGroupMembersPagedCallable()

Lists the monitored resources that are members of a group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   ListGroupMembersRequest request = ListGroupMembersRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListGroupMembersPagedResponse> future = groupServiceClient.listGroupMembersPagedCallable().futureCall(request);
   // Do something
   for (MonitoredResource element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listGroupMembersCallable

public final UnaryCallable<com.google.monitoring.v3.ListGroupMembersRequest,com.google.monitoring.v3.ListGroupMembersResponse> listGroupMembersCallable()

Lists the monitored resources that are members of a group.

Sample code:

 try (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[GROUP]");
   ListGroupMembersRequest request = ListGroupMembersRequest.newBuilder()
     .setName(name.toString())
     .build();
   while (true) {
     ListGroupMembersResponse response = groupServiceClient.listGroupMembersCallable().call(request);
     for (MonitoredResource element : response.getMembersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

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