public sealed class GroupServiceClientImpl : GroupServiceClientReference documentation and code samples for the Google Cloud Monitoring v3 API class GroupServiceClientImpl.
GroupService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Monitoring.V3Assembly
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 | |
|---|---|
| Name | Description |
grpcClient | GroupService.GroupServiceClientThe underlying gRPC client. |
settings | GroupServiceSettingsThe base GroupServiceSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override GroupService.GroupServiceClient GrpcClient { get; }The underlying gRPC GroupService client
| Property Value | |
|---|---|
| Type | Description |
GroupService.GroupServiceClient | |
Methods
CreateGroup(CreateGroupRequest, CallSettings)
public override Group CreateGroup(CreateGroupRequest request, CallSettings callSettings = null)Creates a new group.
| Parameters | |
|---|---|
| Name | Description |
request | CreateGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Group | The RPC response. |
CreateGroupAsync(CreateGroupRequest, CallSettings)
public override Task<Group> CreateGroupAsync(CreateGroupRequest request, CallSettings callSettings = null)Creates a new group.
| Parameters | |
|---|---|
| Name | Description |
request | CreateGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Group> | A Task containing the RPC response. |
DeleteGroup(DeleteGroupRequest, CallSettings)
public override void DeleteGroup(DeleteGroupRequest request, CallSettings callSettings = null)Deletes an existing group.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteGroupAsync(DeleteGroupRequest, CallSettings)
public override Task DeleteGroupAsync(DeleteGroupRequest request, CallSettings callSettings = null)Deletes an existing group.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetGroup(GetGroupRequest, CallSettings)
public override Group GetGroup(GetGroupRequest request, CallSettings callSettings = null)Gets a single group.
| Parameters | |
|---|---|
| Name | Description |
request | GetGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Group | The RPC response. |
GetGroupAsync(GetGroupRequest, CallSettings)
public override Task<Group> GetGroupAsync(GetGroupRequest request, CallSettings callSettings = null)Gets a single group.
| Parameters | |
|---|---|
| Name | Description |
request | GetGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Group> | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | ListGroupMembersRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListGroupMembersResponse, MonitoredResource> | A pageable sequence of MonitoredResource resources. |
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 | |
|---|---|
| Name | Description |
request | ListGroupMembersRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListGroupMembersResponse, MonitoredResource> | A pageable asynchronous sequence of MonitoredResource resources. |
ListGroups(ListGroupsRequest, CallSettings)
public override PagedEnumerable<ListGroupsResponse, Group> ListGroups(ListGroupsRequest request, CallSettings callSettings = null)Lists the existing groups.
| Parameters | |
|---|---|
| Name | Description |
request | ListGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListGroupsResponse, Group> | A pageable sequence of Group resources. |
ListGroupsAsync(ListGroupsRequest, CallSettings)
public override PagedAsyncEnumerable<ListGroupsResponse, Group> ListGroupsAsync(ListGroupsRequest request, CallSettings callSettings = null)Lists the existing groups.
| Parameters | |
|---|---|
| Name | Description |
request | ListGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListGroupsResponse, Group> | A pageable asynchronous sequence of Group resources. |
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 | |
|---|---|
| Name | Description |
request | UpdateGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Group | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | UpdateGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Group> | A Task containing the RPC response. |