Google Cloud Monitoring v3 API - Class GroupServiceClientImpl (3.2.0)

Stay organized with collections Save and categorize content based on your preferences. 
public sealed class GroupServiceClientImpl : GroupServiceClient

Reference documentation and code samples for the Google Cloud Monitoring v3 API class GroupServiceClientImpl.

GroupService client wrapper implementation, for convenient use.

Inheritance

Object > GroupServiceClient > GroupServiceClientImpl

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Remarks

The Group API lets you inspect and manage your groups.

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.

Constructors

GroupServiceClientImpl(GroupService.GroupServiceClient, GroupServiceSettings, ILogger)

public GroupServiceClientImpl(GroupService.GroupServiceClient grpcClient, GroupServiceSettings settings, ILogger logger)

Constructs a client wrapper for the GroupService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientGroupService.GroupServiceClient

The underlying gRPC client.

settingsGroupServiceSettings

The base GroupServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override GroupService.GroupServiceClient GrpcClient { get; }

The underlying gRPC GroupService client

Property Value
TypeDescription
GroupService.GroupServiceClient
Overrides

Methods

CreateGroup(CreateGroupRequest, CallSettings)

public override Group CreateGroup(CreateGroupRequest request, CallSettings callSettings = null)

Creates a new group.

Parameters
NameDescription
requestCreateGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Group

The RPC response.

Overrides

CreateGroupAsync(CreateGroupRequest, CallSettings)

public override Task<Group> CreateGroupAsync(CreateGroupRequest request, CallSettings callSettings = null)

Creates a new group.

Parameters
NameDescription
requestCreateGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Group>

A Task containing the RPC response.

Overrides

DeleteGroup(DeleteGroupRequest, CallSettings)

public override void DeleteGroup(DeleteGroupRequest request, CallSettings callSettings = null)

Deletes an existing group.

Parameters
NameDescription
requestDeleteGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteGroupAsync(DeleteGroupRequest, CallSettings)

public override Task DeleteGroupAsync(DeleteGroupRequest request, CallSettings callSettings = null)

Deletes an existing group.

Parameters
NameDescription
requestDeleteGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetGroup(GetGroupRequest, CallSettings)

public override Group GetGroup(GetGroupRequest request, CallSettings callSettings = null)

Gets a single group.

Parameters
NameDescription
requestGetGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Group

The RPC response.

Overrides

GetGroupAsync(GetGroupRequest, CallSettings)

public override Task<Group> GetGroupAsync(GetGroupRequest request, CallSettings callSettings = null)

Gets a single group.

Parameters
NameDescription
requestGetGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Group>

A Task containing the RPC response.

Overrides

ListGroupMembers(ListGroupMembersRequest, CallSettings)

public override PagedEnumerable<ListGroupMembersResponse, MonitoredResource> ListGroupMembers(ListGroupMembersRequest request, CallSettings callSettings = null)

Lists the monitored resources that are members of a group.

Parameters
NameDescription
requestListGroupMembersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListGroupMembersResponse, MonitoredResource>

A pageable sequence of MonitoredResource resources.

Overrides

ListGroupMembersAsync(ListGroupMembersRequest, CallSettings)

public override PagedAsyncEnumerable<ListGroupMembersResponse, MonitoredResource> ListGroupMembersAsync(ListGroupMembersRequest request, CallSettings callSettings = null)

Lists the monitored resources that are members of a group.

Parameters
NameDescription
requestListGroupMembersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListGroupMembersResponse, MonitoredResource>

A pageable asynchronous sequence of MonitoredResource resources.

Overrides

ListGroups(ListGroupsRequest, CallSettings)

public override PagedEnumerable<ListGroupsResponse, Group> ListGroups(ListGroupsRequest request, CallSettings callSettings = null)

Lists the existing groups.

Parameters
NameDescription
requestListGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListGroupsResponse, Group>

A pageable sequence of Group resources.

Overrides

ListGroupsAsync(ListGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListGroupsResponse, Group> ListGroupsAsync(ListGroupsRequest request, CallSettings callSettings = null)

Lists the existing groups.

Parameters
NameDescription
requestListGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListGroupsResponse, Group>

A pageable asynchronous sequence of Group resources.

Overrides

UpdateGroup(UpdateGroupRequest, CallSettings)

public override Group UpdateGroup(UpdateGroupRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Group

The RPC response.

Overrides

UpdateGroupAsync(UpdateGroupRequest, CallSettings)

public override Task<Group> UpdateGroupAsync(UpdateGroupRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Group>

A Task containing the RPC response.

Overrides