com.google.cloud.monitoring.v3.GroupServiceClient Maven / Gradle / Ivy
Show all versions of google-cloud-monitoring Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.monitoring.v3;
import com.google.api.MonitoredResource;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.resourcenames.ResourceName;
import com.google.cloud.monitoring.v3.stub.GroupServiceStub;
import com.google.cloud.monitoring.v3.stub.GroupServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.monitoring.v3.CreateGroupRequest;
import com.google.monitoring.v3.DeleteGroupRequest;
import com.google.monitoring.v3.GetGroupRequest;
import com.google.monitoring.v3.Group;
import com.google.monitoring.v3.GroupName;
import com.google.monitoring.v3.ListGroupMembersRequest;
import com.google.monitoring.v3.ListGroupMembersResponse;
import com.google.monitoring.v3.ListGroupsRequest;
import com.google.monitoring.v3.ListGroupsResponse;
import com.google.monitoring.v3.OrganizationName;
import com.google.monitoring.v3.ProjectName;
import com.google.monitoring.v3.UpdateGroupRequest;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@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);
* }
* }
*
* 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:
*
*
{@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
* GroupServiceSettings groupServiceSettings =
* GroupServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* GroupServiceClient groupServiceClient = GroupServiceClient.create(groupServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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.
*/
@Generated("by gapic-generator-java")
public class GroupServiceClient implements BackgroundResource {
private final GroupServiceSettings settings;
private final GroupServiceStub stub;
/** Constructs an instance of GroupServiceClient with default settings. */
public static final GroupServiceClient create() throws IOException {
return create(GroupServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final GroupServiceClient create(GroupServiceSettings settings) throws IOException {
return new GroupServiceClient(settings);
}
/**
* Constructs an instance of GroupServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(GroupServiceSettings).
*/
public static final GroupServiceClient create(GroupServiceStub stub) {
return new GroupServiceClient(stub);
}
/**
* 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.
*/
protected GroupServiceClient(GroupServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((GroupServiceStubSettings) settings.getStubSettings()).createStub();
}
protected GroupServiceClient(GroupServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final GroupServiceSettings getSettings() {
return settings;
}
public GroupServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing groups.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListGroupsPagedResponse listGroups(ResourceName name) {
ListGroupsRequest request =
ListGroupsRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return listGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing groups.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListGroupsPagedResponse listGroups(OrganizationName name) {
ListGroupsRequest request =
ListGroupsRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return listGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing groups.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListGroupsPagedResponse listGroups(ProjectName name) {
ListGroupsRequest request =
ListGroupsRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return listGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing groups.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListGroupsPagedResponse listGroups(String name) {
ListGroupsRequest request = ListGroupsRequest.newBuilder().setName(name).build();
return listGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing groups.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListGroupsPagedResponse listGroups(ListGroupsRequest request) {
return listGroupsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing groups.
*
* Sample code:
*
*
{@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 future = groupServiceClient.listGroupsPagedCallable().futureCall(request);
* // Do something.
* for (Group element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable listGroupsPagedCallable() {
return stub.listGroupsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing groups.
*
* Sample code:
*
*
{@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;
* }
* }
* }
* }
*/
public final UnaryCallable listGroupsCallable() {
return stub.listGroupsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a single group.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Group getGroup(GroupName name) {
GetGroupRequest request =
GetGroupRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a single group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Group getGroup(String name) {
GetGroupRequest request = GetGroupRequest.newBuilder().setName(name).build();
return getGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a single group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Group getGroup(GetGroupRequest request) {
return getGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a single group.
*
* Sample code:
*
*
{@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 future = groupServiceClient.getGroupCallable().futureCall(request);
* // Do something.
* Group response = future.get();
* }
* }
*/
public final UnaryCallable getGroupCallable() {
return stub.getGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new group.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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]
* @param 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
*/
public final Group createGroup(ResourceName name, Group group) {
CreateGroupRequest request =
CreateGroupRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setGroup(group)
.build();
return createGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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]
* @param 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
*/
public final Group createGroup(OrganizationName name, Group group) {
CreateGroupRequest request =
CreateGroupRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setGroup(group)
.build();
return createGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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]
* @param 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
*/
public final Group createGroup(ProjectName name, Group group) {
CreateGroupRequest request =
CreateGroupRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setGroup(group)
.build();
return createGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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]
* @param 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
*/
public final Group createGroup(String name, Group group) {
CreateGroupRequest request =
CreateGroupRequest.newBuilder().setName(name).setGroup(group).build();
return createGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Group createGroup(CreateGroupRequest request) {
return createGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new group.
*
* Sample code:
*
*
{@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 future = groupServiceClient.createGroupCallable().futureCall(request);
* // Do something.
* Group response = future.get();
* }
* }
*/
public final UnaryCallable createGroupCallable() {
return stub.createGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing group. You can change any group attributes except `name`.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Group updateGroup(Group group) {
UpdateGroupRequest request = UpdateGroupRequest.newBuilder().setGroup(group).build();
return updateGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing group. You can change any group attributes except `name`.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Group updateGroup(UpdateGroupRequest request) {
return updateGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing group. You can change any group attributes except `name`.
*
* Sample code:
*
*
{@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 future = groupServiceClient.updateGroupCallable().futureCall(request);
* // Do something.
* Group response = future.get();
* }
* }
*/
public final UnaryCallable updateGroupCallable() {
return stub.updateGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing group.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final void deleteGroup(GroupName name) {
DeleteGroupRequest request =
DeleteGroupRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final void deleteGroup(String name) {
DeleteGroupRequest request = DeleteGroupRequest.newBuilder().setName(name).build();
deleteGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final void deleteGroup(DeleteGroupRequest request) {
deleteGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing group.
*
* Sample code:
*
*
{@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 future = groupServiceClient.deleteGroupCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteGroupCallable() {
return stub.deleteGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the monitored resources that are members of a group.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListGroupMembersPagedResponse listGroupMembers(GroupName name) {
ListGroupMembersRequest request =
ListGroupMembersRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return listGroupMembers(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the monitored resources that are members of a group.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListGroupMembersPagedResponse listGroupMembers(String name) {
ListGroupMembersRequest request = ListGroupMembersRequest.newBuilder().setName(name).build();
return listGroupMembers(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the monitored resources that are members of a group.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListGroupMembersPagedResponse listGroupMembers(ListGroupMembersRequest request) {
return listGroupMembersPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the monitored resources that are members of a group.
*
* Sample code:
*
*
{@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 future =
* groupServiceClient.listGroupMembersPagedCallable().futureCall(request);
* // Do something.
* for (MonitoredResource element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listGroupMembersPagedCallable() {
return stub.listGroupMembersPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the monitored resources that are members of a group.
*
* Sample code:
*
*
{@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;
* }
* }
* }
* }
*/
public final UnaryCallable
listGroupMembersCallable() {
return stub.listGroupMembersCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListGroupsPagedResponse
extends AbstractPagedListResponse<
ListGroupsRequest,
ListGroupsResponse,
Group,
ListGroupsPage,
ListGroupsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListGroupsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage, input -> new ListGroupsPagedResponse(input), MoreExecutors.directExecutor());
}
private ListGroupsPagedResponse(ListGroupsPage page) {
super(page, ListGroupsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListGroupsPage
extends AbstractPage {
private ListGroupsPage(
PageContext context,
ListGroupsResponse response) {
super(context, response);
}
private static ListGroupsPage createEmptyPage() {
return new ListGroupsPage(null, null);
}
@Override
protected ListGroupsPage createPage(
PageContext context,
ListGroupsResponse response) {
return new ListGroupsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListGroupsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListGroupsRequest,
ListGroupsResponse,
Group,
ListGroupsPage,
ListGroupsFixedSizeCollection> {
private ListGroupsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListGroupsFixedSizeCollection createEmptyCollection() {
return new ListGroupsFixedSizeCollection(null, 0);
}
@Override
protected ListGroupsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListGroupsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListGroupMembersPagedResponse
extends AbstractPagedListResponse<
ListGroupMembersRequest,
ListGroupMembersResponse,
MonitoredResource,
ListGroupMembersPage,
ListGroupMembersFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListGroupMembersPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListGroupMembersPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListGroupMembersPagedResponse(ListGroupMembersPage page) {
super(page, ListGroupMembersFixedSizeCollection.createEmptyCollection());
}
}
public static class ListGroupMembersPage
extends AbstractPage<
ListGroupMembersRequest,
ListGroupMembersResponse,
MonitoredResource,
ListGroupMembersPage> {
private ListGroupMembersPage(
PageContext context,
ListGroupMembersResponse response) {
super(context, response);
}
private static ListGroupMembersPage createEmptyPage() {
return new ListGroupMembersPage(null, null);
}
@Override
protected ListGroupMembersPage createPage(
PageContext context,
ListGroupMembersResponse response) {
return new ListGroupMembersPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListGroupMembersFixedSizeCollection
extends AbstractFixedSizeCollection<
ListGroupMembersRequest,
ListGroupMembersResponse,
MonitoredResource,
ListGroupMembersPage,
ListGroupMembersFixedSizeCollection> {
private ListGroupMembersFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListGroupMembersFixedSizeCollection createEmptyCollection() {
return new ListGroupMembersFixedSizeCollection(null, 0);
}
@Override
protected ListGroupMembersFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListGroupMembersFixedSizeCollection(pages, collectionSize);
}
}
}