Class ErrorGroupServiceClient

public abstract class ErrorGroupServiceClient

ErrorGroupService client wrapper, for convenient use.

Inheritance

Object > ErrorGroupServiceClient

Namespace

Google.Cloud.ErrorReporting.V1Beta1

Assembly

Google.Cloud.ErrorReporting.V1Beta1.dll

Remarks

Service for retrieving and updating individual error groups.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ErrorGroupService service, which is a host of "clouderrorreporting.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ErrorGroupService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default ErrorGroupService scopes are:

GrpcClient

public virtual ErrorGroupService.ErrorGroupServiceClient GrpcClient { get; }

The underlying gRPC ErrorGroupService client

Property Value
TypeDescription
ErrorGroupService.ErrorGroupServiceClient

Methods

Create()

public static ErrorGroupServiceClient Create()

Synchronously creates a ErrorGroupServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ErrorGroupServiceClientBuilder.

Returns
TypeDescription
ErrorGroupServiceClient

The created ErrorGroupServiceClient.

CreateAsync(CancellationToken)

public static Task<ErrorGroupServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a ErrorGroupServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ErrorGroupServiceClientBuilder.

Parameter
TypeNameDescription
CancellationTokencancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<ErrorGroupServiceClient>

The task representing the created ErrorGroupServiceClient.

GetGroup(ErrorGroupName, CallSettings)

public virtual ErrorGroup GetGroup(ErrorGroupName groupName, CallSettings callSettings = null)

Get the specified group.

Parameters
TypeNameDescription
ErrorGroupNamegroupName

Required. The group resource name. Written as projects/{projectID}/groups/{group_name}. Call groupStats.list to return a list of groups belonging to this project.

Example: projects/my-project-123/groups/my-group

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ErrorGroup

The RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.Create();
// Initialize request argument(s)
ErrorGroupName groupName = ErrorGroupName.FromProjectGroup("[PROJECT]", "[GROUP]");
// Make the request
ErrorGroup response = errorGroupServiceClient.GetGroup(groupName);

GetGroup(GetGroupRequest, CallSettings)

public virtual ErrorGroup GetGroup(GetGroupRequest request, CallSettings callSettings = null)

Get the specified group.

Parameters
TypeNameDescription
GetGroupRequestrequest

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

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ErrorGroup

The RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.Create();
// Initialize request argument(s)
GetGroupRequest request = new GetGroupRequest
{
    GroupNameAsErrorGroupName = ErrorGroupName.FromProjectGroup("[PROJECT]", "[GROUP]"),
};
// Make the request
ErrorGroup response = errorGroupServiceClient.GetGroup(request);

GetGroup(String, CallSettings)

public virtual ErrorGroup GetGroup(string groupName, CallSettings callSettings = null)

Get the specified group.

Parameters
TypeNameDescription
StringgroupName

Required. The group resource name. Written as projects/{projectID}/groups/{group_name}. Call groupStats.list to return a list of groups belonging to this project.

Example: projects/my-project-123/groups/my-group

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ErrorGroup

The RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.Create();
// Initialize request argument(s)
string groupName = "projects/[PROJECT]/groups/[GROUP]";
// Make the request
ErrorGroup response = errorGroupServiceClient.GetGroup(groupName);

GetGroupAsync(ErrorGroupName, CallSettings)

public virtual Task<ErrorGroup> GetGroupAsync(ErrorGroupName groupName, CallSettings callSettings = null)

Get the specified group.

Parameters
TypeNameDescription
ErrorGroupNamegroupName

Required. The group resource name. Written as projects/{projectID}/groups/{group_name}. Call groupStats.list to return a list of groups belonging to this project.

Example: projects/my-project-123/groups/my-group

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
ErrorGroupName groupName = ErrorGroupName.FromProjectGroup("[PROJECT]", "[GROUP]");
// Make the request
ErrorGroup response = await errorGroupServiceClient.GetGroupAsync(groupName);

GetGroupAsync(ErrorGroupName, CancellationToken)

public virtual Task<ErrorGroup> GetGroupAsync(ErrorGroupName groupName, CancellationToken cancellationToken)

Get the specified group.

Parameters
TypeNameDescription
ErrorGroupNamegroupName

Required. The group resource name. Written as projects/{projectID}/groups/{group_name}. Call groupStats.list to return a list of groups belonging to this project.

Example: projects/my-project-123/groups/my-group

CancellationTokencancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
ErrorGroupName groupName = ErrorGroupName.FromProjectGroup("[PROJECT]", "[GROUP]");
// Make the request
ErrorGroup response = await errorGroupServiceClient.GetGroupAsync(groupName);

GetGroupAsync(GetGroupRequest, CallSettings)

public virtual Task<ErrorGroup> GetGroupAsync(GetGroupRequest request, CallSettings callSettings = null)

Get the specified group.

Parameters
TypeNameDescription
GetGroupRequestrequest

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<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
GetGroupRequest request = new GetGroupRequest
{
    GroupNameAsErrorGroupName = ErrorGroupName.FromProjectGroup("[PROJECT]", "[GROUP]"),
};
// Make the request
ErrorGroup response = await errorGroupServiceClient.GetGroupAsync(request);

GetGroupAsync(GetGroupRequest, CancellationToken)

public virtual Task<ErrorGroup> GetGroupAsync(GetGroupRequest request, CancellationToken cancellationToken)

Get the specified group.

Parameters
TypeNameDescription
GetGroupRequestrequest

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

CancellationTokencancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
GetGroupRequest request = new GetGroupRequest
{
    GroupNameAsErrorGroupName = ErrorGroupName.FromProjectGroup("[PROJECT]", "[GROUP]"),
};
// Make the request
ErrorGroup response = await errorGroupServiceClient.GetGroupAsync(request);

GetGroupAsync(String, CallSettings)

public virtual Task<ErrorGroup> GetGroupAsync(string groupName, CallSettings callSettings = null)

Get the specified group.

Parameters
TypeNameDescription
StringgroupName

Required. The group resource name. Written as projects/{projectID}/groups/{group_name}. Call groupStats.list to return a list of groups belonging to this project.

Example: projects/my-project-123/groups/my-group

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string groupName = "projects/[PROJECT]/groups/[GROUP]";
// Make the request
ErrorGroup response = await errorGroupServiceClient.GetGroupAsync(groupName);

GetGroupAsync(String, CancellationToken)

public virtual Task<ErrorGroup> GetGroupAsync(string groupName, CancellationToken cancellationToken)

Get the specified group.

Parameters
TypeNameDescription
StringgroupName

Required. The group resource name. Written as projects/{projectID}/groups/{group_name}. Call groupStats.list to return a list of groups belonging to this project.

Example: projects/my-project-123/groups/my-group

CancellationTokencancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string groupName = "projects/[PROJECT]/groups/[GROUP]";
// Make the request
ErrorGroup response = await errorGroupServiceClient.GetGroupAsync(groupName);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateGroup(ErrorGroup, CallSettings)

public virtual ErrorGroup UpdateGroup(ErrorGroup group, CallSettings callSettings = null)

Replace the data for the specified group. Fails if the group does not exist.

Parameters
TypeNameDescription
ErrorGroupgroup

Required. The group which replaces the resource on the server.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ErrorGroup

The RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.Create();
// Initialize request argument(s)
ErrorGroup group = new ErrorGroup();
// Make the request
ErrorGroup response = errorGroupServiceClient.UpdateGroup(group);

UpdateGroup(UpdateGroupRequest, CallSettings)

public virtual ErrorGroup UpdateGroup(UpdateGroupRequest request, CallSettings callSettings = null)

Replace the data for the specified group. Fails if the group does not exist.

Parameters
TypeNameDescription
UpdateGroupRequestrequest

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

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ErrorGroup

The RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.Create();
// Initialize request argument(s)
UpdateGroupRequest request = new UpdateGroupRequest
{
    Group = new ErrorGroup(),
};
// Make the request
ErrorGroup response = errorGroupServiceClient.UpdateGroup(request);

UpdateGroupAsync(ErrorGroup, CallSettings)

public virtual Task<ErrorGroup> UpdateGroupAsync(ErrorGroup group, CallSettings callSettings = null)

Replace the data for the specified group. Fails if the group does not exist.

Parameters
TypeNameDescription
ErrorGroupgroup

Required. The group which replaces the resource on the server.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
ErrorGroup group = new ErrorGroup();
// Make the request
ErrorGroup response = await errorGroupServiceClient.UpdateGroupAsync(group);

UpdateGroupAsync(ErrorGroup, CancellationToken)

public virtual Task<ErrorGroup> UpdateGroupAsync(ErrorGroup group, CancellationToken cancellationToken)

Replace the data for the specified group. Fails if the group does not exist.

Parameters
TypeNameDescription
ErrorGroupgroup

Required. The group which replaces the resource on the server.

CancellationTokencancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
ErrorGroup group = new ErrorGroup();
// Make the request
ErrorGroup response = await errorGroupServiceClient.UpdateGroupAsync(group);

UpdateGroupAsync(UpdateGroupRequest, CallSettings)

public virtual Task<ErrorGroup> UpdateGroupAsync(UpdateGroupRequest request, CallSettings callSettings = null)

Replace the data for the specified group. Fails if the group does not exist.

Parameters
TypeNameDescription
UpdateGroupRequestrequest

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<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGroupRequest request = new UpdateGroupRequest
{
    Group = new ErrorGroup(),
};
// Make the request
ErrorGroup response = await errorGroupServiceClient.UpdateGroupAsync(request);

UpdateGroupAsync(UpdateGroupRequest, CancellationToken)

public virtual Task<ErrorGroup> UpdateGroupAsync(UpdateGroupRequest request, CancellationToken cancellationToken)

Replace the data for the specified group. Fails if the group does not exist.

Parameters
TypeNameDescription
UpdateGroupRequestrequest

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

CancellationTokencancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ErrorGroup>

A Task containing the RPC response.

Example
// Create client
ErrorGroupServiceClient errorGroupServiceClient = await ErrorGroupServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGroupRequest request = new UpdateGroupRequest
{
    Group = new ErrorGroup(),
};
// Make the request
ErrorGroup response = await errorGroupServiceClient.UpdateGroupAsync(request);