Class GroupService.GroupServiceClient (3.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public class GroupServiceClient : ClientBase<GroupService.GroupServiceClient>

Client for GroupService

Inheritance

Object > ClientBase > ClientBase<GroupService.GroupServiceClient> > GroupService.GroupServiceClient

Namespace

Google.Cloud.Monitoring.V3

Assembly

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

GroupServiceClient(ChannelBase)

public GroupServiceClient(ChannelBase channel)

Creates a new client for GroupService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

GroupServiceClient(ClientBase.ClientBaseConfiguration)

protected GroupServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateGroup(CreateGroupRequest, CallOptions)

public virtual Group CreateGroup(CreateGroupRequest request, CallOptions options)

Creates a new group.

Parameters
NameDescription
requestCreateGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Group

The response received from the server.

CreateGroup(CreateGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Group CreateGroup(CreateGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new group.

Parameters
NameDescription
requestCreateGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Group

The response received from the server.

CreateGroupAsync(CreateGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Group> CreateGroupAsync(CreateGroupRequest request, CallOptions options)

Creates a new group.

Parameters
NameDescription
requestCreateGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Group>

The call object.

CreateGroupAsync(CreateGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Group> CreateGroupAsync(CreateGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new group.

Parameters
NameDescription
requestCreateGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Group>

The call object.

DeleteGroup(DeleteGroupRequest, CallOptions)

public virtual Empty DeleteGroup(DeleteGroupRequest request, CallOptions options)

Deletes an existing group.

Parameters
NameDescription
requestDeleteGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteGroup(DeleteGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteGroup(DeleteGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes an existing group.

Parameters
NameDescription
requestDeleteGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteGroupAsync(DeleteGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteGroupAsync(DeleteGroupRequest request, CallOptions options)

Deletes an existing group.

Parameters
NameDescription
requestDeleteGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteGroupAsync(DeleteGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteGroupAsync(DeleteGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes an existing group.

Parameters
NameDescription
requestDeleteGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

GetGroup(GetGroupRequest, CallOptions)

public virtual Group GetGroup(GetGroupRequest request, CallOptions options)

Gets a single group.

Parameters
NameDescription
requestGetGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Group

The response received from the server.

GetGroup(GetGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Group GetGroup(GetGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a single group.

Parameters
NameDescription
requestGetGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Group

The response received from the server.

GetGroupAsync(GetGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Group> GetGroupAsync(GetGroupRequest request, CallOptions options)

Gets a single group.

Parameters
NameDescription
requestGetGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Group>

The call object.

GetGroupAsync(GetGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Group> GetGroupAsync(GetGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a single group.

Parameters
NameDescription
requestGetGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Group>

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
NameDescription
requestListGroupMembersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListGroupMembersResponse

The response received from the server.

ListGroupMembers(ListGroupMembersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListGroupMembersResponse ListGroupMembers(ListGroupMembersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists the monitored resources that are members of a group.

Parameters
NameDescription
requestListGroupMembersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListGroupMembersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListGroupMembersResponse>

The call object.

ListGroupMembersAsync(ListGroupMembersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListGroupMembersResponse> ListGroupMembersAsync(ListGroupMembersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists the monitored resources that are members of a group.

Parameters
NameDescription
requestListGroupMembersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListGroupMembersResponse>

The call object.

ListGroups(ListGroupsRequest, CallOptions)

public virtual ListGroupsResponse ListGroups(ListGroupsRequest request, CallOptions options)

Lists the existing groups.

Parameters
NameDescription
requestListGroupsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListGroupsResponse

The response received from the server.

ListGroups(ListGroupsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListGroupsResponse ListGroups(ListGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists the existing groups.

Parameters
NameDescription
requestListGroupsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListGroupsResponse

The response received from the server.

ListGroupsAsync(ListGroupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListGroupsResponse> ListGroupsAsync(ListGroupsRequest request, CallOptions options)

Lists the existing groups.

Parameters
NameDescription
requestListGroupsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListGroupsResponse>

The call object.

ListGroupsAsync(ListGroupsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListGroupsResponse> ListGroupsAsync(ListGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists the existing groups.

Parameters
NameDescription
requestListGroupsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListGroupsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override GroupService.GroupServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
GroupService.GroupServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Monitoring.V3.GroupService.GroupServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateGroup(UpdateGroupRequest, CallOptions)

public virtual Group UpdateGroup(UpdateGroupRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Group

The response received from the server.

UpdateGroup(UpdateGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Group UpdateGroup(UpdateGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestUpdateGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpdateGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Group>

The call object.

UpdateGroupAsync(UpdateGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Group> UpdateGroupAsync(UpdateGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestUpdateGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Group>

The call object.