GroupServiceClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.monitoring.v3.GroupServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
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:
```
 
 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

All Methods Static Methods Instance Methods Concrete Methods
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(ProjectName 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,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(ProjectName 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
```
@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(ProjectName name)

Lists the existing groups.

Sample code:


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

Parameters:: name - The project 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:


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

Parameters:: name - The project 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:


 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:: 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:


 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 com.google.api.gax.rpc.UnaryCallable<ListGroupsRequest,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 Group getGroup(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:: com.google.api.gax.rpc.ApiException - if the remote call fails

getGroup

public final 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:: com.google.api.gax.rpc.ApiException - if the remote call fails

getGroup

public final Group getGroup(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:: 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:


 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 Group createGroup(ProjectName name,
                               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:: 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:


 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:: com.google.api.gax.rpc.ApiException - if the remote call fails

createGroup

public final Group createGroup(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:: 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:


 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 Group updateGroup(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:

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:


 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:: 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:


 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(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:: com.google.api.gax.rpc.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:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGroup

public final void deleteGroup(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:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<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();
 }