Google Cloud Error Reporting v1beta1 API - Class ErrorGroupServiceClient (3.0.0-beta05)

public abstract class ErrorGroupServiceClient

Reference documentation and code samples for the Google Cloud Error Reporting v1beta1 API class ErrorGroupServiceClient.

ErrorGroupService client wrapper, for convenient use.

Inheritance

object > ErrorGroupServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ErrorGroupServiceClientImpl

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
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ErrorGroupService scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default ErrorGroupService scopes are:

https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual ErrorGroupService.ErrorGroupServiceClient GrpcClient { get; }

The underlying gRPC ErrorGroupService client

Property Value
Type	Description
`ErrorGroupServiceErrorGroupServiceClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

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
Type	Description
`ErrorGroupServiceClient`	The created ErrorGroupServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskErrorGroupServiceClient`	The task representing the created ErrorGroupServiceClient.

GetGroup(ErrorGroupName, CallSettings)

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

Get the specified group.

Parameters

Name Description

groupName

ErrorGroupName

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

callSettings

CallSettings

If not null, applies overrides to this RPC call.

Returns
Type	Description
`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
Name	Description
`request`	`GetGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`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

Name Description

groupName

string

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

callSettings

CallSettings

If not null, applies overrides to this RPC call.

Returns
Type	Description
`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

Name Description

groupName

ErrorGroupName

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

callSettings

CallSettings

If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskErrorGroup`	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

Name Description

groupName

ErrorGroupName

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

cancellationToken

CancellationToken

A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskErrorGroup`	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
Name	Description
`request`	`GetGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskErrorGroup`	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
Name	Description
`request`	`GetGroupRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskErrorGroup`	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

Name Description

groupName

string

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

callSettings

CallSettings

If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskErrorGroup`	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

Name Description

groupName

string

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

cancellationToken

CancellationToken

A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskErrorGroup`	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
Type	Description
`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
Name	Description
`group`	`ErrorGroup` Required. The group which replaces the resource on the server.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`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
Name	Description
`group`	`ErrorGroup` Required. The group which replaces the resource on the server.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskErrorGroup`	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
Name	Description
`group`	`ErrorGroup` Required. The group which replaces the resource on the server.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskErrorGroup`	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
Name	Description
`request`	`UpdateGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskErrorGroup`	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
Name	Description
`request`	`UpdateGroupRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskErrorGroup`	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);