com.google.cloud.monitoring.v3

Class GroupServiceClient

java.lang.Object

com.google.cloud.monitoring.v3.GroupServiceClient

All Implemented Interfaces:

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

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

 // 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.ofProjectGroupName("[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().

Methods

Method	Description	Method Variants
ListGroups	Lists the existing groups.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listGroups(ListGroupsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listGroups(ResourceName name) listGroups(OrganizationName name) listGroups(ProjectName name) listGroups(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listGroupsPagedCallable() listGroupsCallable()
GetGroup	Gets a single group.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getGroup(GetGroupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getGroup(GroupName name) getGroup(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getGroupCallable()
CreateGroup	Creates a new group.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createGroup(CreateGroupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createGroup(ResourceName name, Group group) createGroup(OrganizationName name, Group group) createGroup(ProjectName name, Group group) createGroup(String name, Group group) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createGroupCallable()
UpdateGroup	Updates an existing group. You can change any group attributes except `name`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateGroup(UpdateGroupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateGroup(Group group) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateGroupCallable()
DeleteGroup	Deletes an existing group.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteGroup(DeleteGroupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteGroup(GroupName name) deleteGroup(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteGroupCallable()
ListGroupMembers	Lists the monitored resources that are members of a group.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listGroupMembers(ListGroupMembersRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listGroupMembers(GroupName name) listGroupMembers(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listGroupMembersPagedCallable() listGroupMembersCallable()

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:

 // 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
 GroupServiceSettings groupServiceSettings =
     GroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GroupServiceClient groupServiceClient = GroupServiceClient.create(groupServiceSettings);
 

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
 GroupServiceSettings groupServiceSettings =
     GroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 GroupServiceClient groupServiceClient = GroupServiceClient.create(groupServiceSettings);
 

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

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.
Group	createGroup(CreateGroupRequest request) Creates a new group.
Group	createGroup(OrganizationName name, Group group) Creates a new group.
Group	createGroup(ProjectName name, Group group) Creates a new group.
Group	createGroup(com.google.api.resourcenames.ResourceName name, Group group) Creates a new group.
Group	createGroup(String name, Group group) Creates a new group.
com.google.api.gax.rpc.UnaryCallable<CreateGroupRequest,Group>	createGroupCallable() Creates a new group.
void	deleteGroup(DeleteGroupRequest request) Deletes an existing group.
void	deleteGroup(GroupName name) Deletes an existing group.
void	deleteGroup(String name) Deletes an existing group.
com.google.api.gax.rpc.UnaryCallable<DeleteGroupRequest,com.google.protobuf.Empty>	deleteGroupCallable() Deletes an existing group.
Group	getGroup(GetGroupRequest request) Gets a single group.
Group	getGroup(GroupName name) Gets a single group.
Group	getGroup(String name) Gets a single group.
com.google.api.gax.rpc.UnaryCallable<GetGroupRequest,Group>	getGroupCallable() Gets a single group.
GroupServiceSettings	getSettings()
GroupServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
GroupServiceClient.ListGroupMembersPagedResponse	listGroupMembers(GroupName name) Lists the monitored resources that are members of a group.
GroupServiceClient.ListGroupMembersPagedResponse	listGroupMembers(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.
com.google.api.gax.rpc.UnaryCallable<ListGroupMembersRequest,ListGroupMembersResponse>	listGroupMembersCallable() Lists the monitored resources that are members of a group.
com.google.api.gax.rpc.UnaryCallable<ListGroupMembersRequest,GroupServiceClient.ListGroupMembersPagedResponse>	listGroupMembersPagedCallable() Lists the monitored resources that are members of a group.
GroupServiceClient.ListGroupsPagedResponse	listGroups(ListGroupsRequest request) Lists the existing groups.
GroupServiceClient.ListGroupsPagedResponse	listGroups(OrganizationName name) Lists the existing groups.
GroupServiceClient.ListGroupsPagedResponse	listGroups(ProjectName name) Lists the existing groups.
GroupServiceClient.ListGroupsPagedResponse	listGroups(com.google.api.resourcenames.ResourceName name) Lists the existing groups.
GroupServiceClient.ListGroupsPagedResponse	listGroups(String name) Lists the existing groups.
com.google.api.gax.rpc.UnaryCallable<ListGroupsRequest,ListGroupsResponse>	listGroupsCallable() Lists the existing groups.
com.google.api.gax.rpc.UnaryCallable<ListGroupsRequest,GroupServiceClient.ListGroupsPagedResponse>	listGroupsPagedCallable() Lists the existing groups.
void	shutdown()
void	shutdownNow()
Group	updateGroup(Group group) Updates an existing group.
Group	updateGroup(UpdateGroupRequest request) Updates an existing group.
com.google.api.gax.rpc.UnaryCallable<UpdateGroupRequest,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

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

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

getSettings

public final GroupServiceSettings getSettings()

getStub

public GroupServiceStub getStub()

listGroups

public final GroupServiceClient.ListGroupsPagedResponse listGroups(com.google.api.resourcenames.ResourceName name)

Lists the existing groups.

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ResourceName name = ResourceName.of("[FOLDER]");
   for (Group element : groupServiceClient.listGroups(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

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

listGroups

public final GroupServiceClient.ListGroupsPagedResponse listGroups(OrganizationName name)

Lists the existing groups.

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   for (Group element : groupServiceClient.listGroups(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

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

listGroups

public final GroupServiceClient.ListGroupsPagedResponse listGroups(ProjectName name)

Lists the existing groups.

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (Group element : groupServiceClient.listGroups(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

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

listGroups

public final GroupServiceClient.ListGroupsPagedResponse listGroups(String name)

Lists the existing groups.

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   String name = ProjectName.of("[PROJECT]").toString();
   for (Group element : groupServiceClient.listGroups(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

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

listGroups

public final GroupServiceClient.ListGroupsPagedResponse listGroups(ListGroupsRequest request)

Lists the existing groups.

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ListGroupsRequest request =
       ListGroupsRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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:

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

listGroupsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGroupsRequest,GroupServiceClient.ListGroupsPagedResponse> listGroupsPagedCallable()

Lists the existing groups.

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ListGroupsRequest request =
       ListGroupsRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Group> future = groupServiceClient.listGroupsPagedCallable().futureCall(request);
   // Do something.
   for (Group element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listGroupsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGroupsRequest,ListGroupsResponse> listGroupsCallable()

Lists the existing groups.

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ListGroupsRequest request =
       ListGroupsRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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 Group getGroup(GroupName name)

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

Parameters:

name - Required. The group to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Throws:

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

getGroup

public final Group getGroup(String name)

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

Parameters:

name - Required. The group to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Throws:

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

getGroup

public final Group getGroup(GetGroupRequest request)

Gets a single 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GetGroupRequest request =
       GetGroupRequest.newBuilder()
           .setName(GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString())
           .build();
   Group response = groupServiceClient.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,Group> getGroupCallable()

Gets a single 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GetGroupRequest request =
       GetGroupRequest.newBuilder()
           .setName(GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString())
           .build();
   ApiFuture<Group> future = groupServiceClient.getGroupCallable().futureCall(request);
   // Do something.
   Group response = future.get();
 }
 

createGroup

public final Group createGroup(com.google.api.resourcenames.ResourceName name,
                               Group group)

Creates a new 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ResourceName name = ResourceName.of("[FOLDER]");
   Group group = Group.newBuilder().build();
   Group response = groupServiceClient.createGroup(name, group);
 }
 

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is:

projects/[PROJECT_ID_OR_NUMBER]

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

Throws:

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

createGroup

public final Group createGroup(OrganizationName name,
                               Group group)

Creates a new 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   Group group = Group.newBuilder().build();
   Group response = groupServiceClient.createGroup(name, group);
 }
 

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is:

projects/[PROJECT_ID_OR_NUMBER]

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

Throws:

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

createGroup

public final Group createGroup(ProjectName name,
                               Group group)

Creates a new 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Group group = Group.newBuilder().build();
   Group response = groupServiceClient.createGroup(name, group);
 }
 

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is:

projects/[PROJECT_ID_OR_NUMBER]

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

Throws:

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

createGroup

public final Group createGroup(String name,
                               Group group)

Creates a new 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   String name = ProjectName.of("[PROJECT]").toString();
   Group group = Group.newBuilder().build();
   Group response = groupServiceClient.createGroup(name, group);
 }
 

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is:

projects/[PROJECT_ID_OR_NUMBER]

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

Throws:

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

createGroup

public final Group createGroup(CreateGroupRequest request)

Creates a new 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   CreateGroupRequest request =
       CreateGroupRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setGroup(Group.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Group response = groupServiceClient.createGroup(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

createGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateGroupRequest,Group> createGroupCallable()

Creates a new 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   CreateGroupRequest request =
       CreateGroupRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setGroup(Group.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Group> future = groupServiceClient.createGroupCallable().futureCall(request);
   // Do something.
   Group response = future.get();
 }
 

updateGroup

public final Group updateGroup(Group group)

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

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   Group group = Group.newBuilder().build();
   Group response = groupServiceClient.updateGroup(group);
 }
 

Parameters:

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

Throws:

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

updateGroup

public final Group updateGroup(UpdateGroupRequest request)

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

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   UpdateGroupRequest request =
       UpdateGroupRequest.newBuilder()
           .setGroup(Group.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Group response = groupServiceClient.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,Group> updateGroupCallable()

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

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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   UpdateGroupRequest request =
       UpdateGroupRequest.newBuilder()
           .setGroup(Group.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Group> future = groupServiceClient.updateGroupCallable().futureCall(request);
   // Do something.
   Group response = future.get();
 }
 

deleteGroup

public final void deleteGroup(GroupName name)

Deletes an existing 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]");
   groupServiceClient.deleteGroup(name);
 }
 

Parameters:

name - Required. The group to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Throws:

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

deleteGroup

public final void deleteGroup(String name)

Deletes an existing 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   String name = GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString();
   groupServiceClient.deleteGroup(name);
 }
 

Parameters:

name - Required. The group to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Throws:

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

deleteGroup

public final void deleteGroup(DeleteGroupRequest request)

Deletes an existing 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   DeleteGroupRequest request =
       DeleteGroupRequest.newBuilder()
           .setName(GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString())
           .setRecursive(true)
           .build();
   groupServiceClient.deleteGroup(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

deleteGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteGroupRequest,com.google.protobuf.Empty> deleteGroupCallable()

Deletes an existing 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   DeleteGroupRequest request =
       DeleteGroupRequest.newBuilder()
           .setName(GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString())
           .setRecursive(true)
           .build();
   ApiFuture<Empty> future = groupServiceClient.deleteGroupCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

listGroupMembers

public final GroupServiceClient.ListGroupMembersPagedResponse listGroupMembers(GroupName name)

Lists the monitored resources that are members of a 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   GroupName name = GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]");
   for (MonitoredResource element : groupServiceClient.listGroupMembers(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - Required. The group whose members are listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Throws:

com.google.api.gax.rpc.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:

 // 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   String name = GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString();
   for (MonitoredResource element : groupServiceClient.listGroupMembers(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - Required. The group whose members are listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Throws:

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

listGroupMembers

public final GroupServiceClient.ListGroupMembersPagedResponse listGroupMembers(ListGroupMembersRequest request)

Lists the monitored resources that are members of a 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ListGroupMembersRequest request =
       ListGroupMembersRequest.newBuilder()
           .setName(GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setInterval(TimeInterval.newBuilder().build())
           .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:

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

listGroupMembersPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGroupMembersRequest,GroupServiceClient.ListGroupMembersPagedResponse> listGroupMembersPagedCallable()

Lists the monitored resources that are members of a 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ListGroupMembersRequest request =
       ListGroupMembersRequest.newBuilder()
           .setName(GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setInterval(TimeInterval.newBuilder().build())
           .build();
   ApiFuture<MonitoredResource> future =
       groupServiceClient.listGroupMembersPagedCallable().futureCall(request);
   // Do something.
   for (MonitoredResource element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listGroupMembersCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGroupMembersRequest,ListGroupMembersResponse> listGroupMembersCallable()

Lists the monitored resources that are members of a 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 (GroupServiceClient groupServiceClient = GroupServiceClient.create()) {
   ListGroupMembersRequest request =
       ListGroupMembersRequest.newBuilder()
           .setName(GroupName.ofProjectGroupName("[PROJECT]", "[GROUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setInterval(TimeInterval.newBuilder().build())
           .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 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