public class GroupService.GroupServiceClient : ClientBase<GroupService.GroupServiceClient>Reference documentation and code samples for the Google Cloud Monitoring v3 API class GroupService.GroupServiceClient.
Client for GroupService
Inheritance
object > ClientBase > ClientBaseGroupServiceGroupServiceClient > GroupService.GroupServiceClientNamespace
Google.Cloud.Monitoring.V3Assembly
Google.Cloud.Monitoring.V3.dll
Constructors
GroupServiceClient()
protected GroupServiceClient()Protected parameterless constructor to allow creation of test doubles.
GroupServiceClient(CallInvoker)
public GroupServiceClient(CallInvoker callInvoker)Creates a new client for GroupService that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
GroupServiceClient(ChannelBase)
public GroupServiceClient(ChannelBase channel)Creates a new client for GroupService
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
GroupServiceClient(ClientBaseConfiguration)
protected GroupServiceClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CreateGroup(CreateGroupRequest, CallOptions)
public virtual Group CreateGroup(CreateGroupRequest request, CallOptions options)Creates a new group.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateGroupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Group |
The response received from the server. |
CreateGroup(CreateGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual Group CreateGroup(CreateGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new group.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateGroupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Group |
The response received from the server. |
CreateGroupAsync(CreateGroupRequest, CallOptions)
public virtual AsyncUnaryCall<Group> CreateGroupAsync(CreateGroupRequest request, CallOptions options)Creates a new group.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateGroupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGroup |
The call object. |
CreateGroupAsync(CreateGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Group> CreateGroupAsync(CreateGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new group.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateGroupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGroup |
The call object. |
DeleteGroup(DeleteGroupRequest, CallOptions)
public virtual Empty DeleteGroup(DeleteGroupRequest request, CallOptions options)Deletes an existing group.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteGroupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteGroup(DeleteGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteGroup(DeleteGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes an existing group.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteGroupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteGroupAsync(DeleteGroupRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteGroupAsync(DeleteGroupRequest request, CallOptions options)Deletes an existing group.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteGroupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteGroupAsync(DeleteGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteGroupAsync(DeleteGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes an existing group.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteGroupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
GetGroup(GetGroupRequest, CallOptions)
public virtual Group GetGroup(GetGroupRequest request, CallOptions options)Gets a single group.
| Parameters | |
|---|---|
| Name | Description |
request |
GetGroupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Group |
The response received from the server. |
GetGroup(GetGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual Group GetGroup(GetGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a single group.
| Parameters | |
|---|---|
| Name | Description |
request |
GetGroupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Group |
The response received from the server. |
GetGroupAsync(GetGroupRequest, CallOptions)
public virtual AsyncUnaryCall<Group> GetGroupAsync(GetGroupRequest request, CallOptions options)Gets a single group.
| Parameters | |
|---|---|
| Name | Description |
request |
GetGroupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGroup |
The call object. |
GetGroupAsync(GetGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Group> GetGroupAsync(GetGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a single group.
| Parameters | |
|---|---|
| Name | Description |
request |
GetGroupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGroup |
The call object. |
ListGroupMembers(ListGroupMembersRequest, CallOptions)
public virtual ListGroupMembersResponse ListGroupMembers(ListGroupMembersRequest request, CallOptions options)Lists the monitored resources that are members of a group.
| Parameters | |
|---|---|
| Name | Description |
request |
ListGroupMembersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListGroupMembersResponse |
The response received from the server. |
ListGroupMembers(ListGroupMembersRequest, Metadata, DateTime?, CancellationToken)
public virtual ListGroupMembersResponse ListGroupMembers(ListGroupMembersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists the monitored resources that are members of a group.
| Parameters | |
|---|---|
| Name | Description |
request |
ListGroupMembersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListGroupMembersResponse |
The response received from the server. |
ListGroupMembersAsync(ListGroupMembersRequest, CallOptions)
public virtual AsyncUnaryCall<ListGroupMembersResponse> ListGroupMembersAsync(ListGroupMembersRequest request, CallOptions options)Lists the monitored resources that are members of a group.
| Parameters | |
|---|---|
| Name | Description |
request |
ListGroupMembersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListGroupMembersResponse |
The call object. |
ListGroupMembersAsync(ListGroupMembersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListGroupMembersResponse> ListGroupMembersAsync(ListGroupMembersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists the monitored resources that are members of a group.
| Parameters | |
|---|---|
| Name | Description |
request |
ListGroupMembersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListGroupMembersResponse |
The call object. |
ListGroups(ListGroupsRequest, CallOptions)
public virtual ListGroupsResponse ListGroups(ListGroupsRequest request, CallOptions options)Lists the existing groups.
| Parameters | |
|---|---|
| Name | Description |
request |
ListGroupsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListGroupsResponse |
The response received from the server. |
ListGroups(ListGroupsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListGroupsResponse ListGroups(ListGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists the existing groups.
| Parameters | |
|---|---|
| Name | Description |
request |
ListGroupsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListGroupsResponse |
The response received from the server. |
ListGroupsAsync(ListGroupsRequest, CallOptions)
public virtual AsyncUnaryCall<ListGroupsResponse> ListGroupsAsync(ListGroupsRequest request, CallOptions options)Lists the existing groups.
| Parameters | |
|---|---|
| Name | Description |
request |
ListGroupsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListGroupsResponse |
The call object. |
ListGroupsAsync(ListGroupsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListGroupsResponse> ListGroupsAsync(ListGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists the existing groups.
| Parameters | |
|---|---|
| Name | Description |
request |
ListGroupsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListGroupsResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override GroupService.GroupServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
GroupServiceGroupServiceClient |
|
UpdateGroup(UpdateGroupRequest, CallOptions)
public virtual Group UpdateGroup(UpdateGroupRequest request, CallOptions options)Updates an existing group.
You can change any group attributes except name.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateGroupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Group |
The response received from the server. |
UpdateGroup(UpdateGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual Group UpdateGroup(UpdateGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates an existing group.
You can change any group attributes except name.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateGroupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Group |
The response received from the server. |
UpdateGroupAsync(UpdateGroupRequest, CallOptions)
public virtual AsyncUnaryCall<Group> UpdateGroupAsync(UpdateGroupRequest request, CallOptions options)Updates an existing group.
You can change any group attributes except name.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateGroupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGroup |
The call object. |
UpdateGroupAsync(UpdateGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Group> UpdateGroupAsync(UpdateGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates an existing group.
You can change any group attributes except name.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateGroupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallGroup |
The call object. |