# Error Reporting V1beta1 API - Class Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client (v0.17.0)

0.17.0 (latest) 0.16.0 0.15.1 0.14.0 0.13.1 0.12.0 0.11.1 0.10.0 0.9.2 0.8.0 0.7.0 0.6.0 0.5.1 0.4.5 Reference documentation and code samples for the Error Reporting V1beta1 API class Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.

Client for the ErrorGroupService service.


<br />

Service for retrieving and updating individual error groups.

## Inherits

- Object

## Includes

- [Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Paths](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Paths)

## Methods

### .configure

    def self.configure() { |config| ... } -> Client::Configuration

Configure the ErrorGroupService Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client-Configuration "Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client-Configuration))
**Example**

```ruby
# Modify the configuration for all ErrorGroupService clients
::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.configure do |config|
  config.timeout = 10.0
end
```

### #configure

    def configure() { |config| ... } -> Client::Configuration

Configure the ErrorGroupService Client instance.


The configuration is set to the derived mode, meaning that values can be changed,
but structural changes (adding new fields, etc.) are not allowed. Structural changes
should be made on [Client.configure](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client#Google__Cloud__ErrorReporting__V1beta1__ErrorGroupService__Client_configure_class_ "Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client-Configuration "Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client-Configuration))

### #get_group

    def get_group(request, options = nil) -> ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup
    def get_group(group_name: nil) -> ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup

Get the specified group.
**Overloads**

    def get_group(request, options = nil) -> ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup

Pass arguments to `get_group` via a request object, either of type [GetGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-GetGroupRequest "Google::Cloud::ErrorReporting::V1beta1::GetGroupRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::ErrorReporting::V1beta1::GetGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-GetGroupRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_group(group_name: nil) -> ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup

Pass arguments to `get_group` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **group_name** (::String) --- Required. The group resource name. Written as either `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}`. Call \[groupStats.list\] \[google.devtools.clouderrorreporting.v1beta1.ErrorStatsService.ListGroupStats\] to return a list of groups belonging to this project.


  Examples: `projects/my-project-123/groups/my-group`,
  `projects/my-project-123/locations/global/groups/my-group`

  In the group resource name, the `group_id` is a unique identifier for a
  particular error group. The identifier is derived from key parts of the
  error-log content and is treated as Service Data. For information about
  how Service Data is handled, see [Google Cloud Privacy
  Notice](https://cloud.google.com/terms/cloud-privacy-notice).

  For a list of supported locations, see [Supported
  Regions](https://cloud.google.com/logging/docs/region-support). `global` is
  the default when unspecified.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroup))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroup))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/error_reporting/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ErrorReporting::V1beta1::GetGroupRequest.new

# Call the get_group method.
result = client.get_group request

# The returned object is of type Google::Cloud::ErrorReporting::V1beta1::ErrorGroup.
p result
```

### #initialize

    def initialize() { |config| ... } -> Client

Create a new ErrorGroupService client object.
**Yields**

- (config) --- Configure the ErrorGroupService client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroupService-Client)) --- a new instance of Client
**Example**

```ruby
# Create a client using the default configuration
client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new do |config|
  config.timeout = 10.0
end
```

### #logger

    def logger() -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)

### #update_group

    def update_group(request, options = nil) -> ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup
    def update_group(group: nil) -> ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup

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

    def update_group(request, options = nil) -> ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup

Pass arguments to `update_group` via a request object, either of type [UpdateGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-UpdateGroupRequest "Google::Cloud::ErrorReporting::V1beta1::UpdateGroupRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::ErrorReporting::V1beta1::UpdateGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-UpdateGroupRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def update_group(group: nil) -> ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup

Pass arguments to `update_group` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **group** ([::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroup), ::Hash) --- Required. The group which replaces the resource on the server.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroup))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-error_reporting-v1beta1/latest/Google-Cloud-ErrorReporting-V1beta1-ErrorGroup))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/error_reporting/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ErrorReporting::V1beta1::UpdateGroupRequest.new

# Call the update_group method.
result = client.update_group request

# The returned object is of type Google::Cloud::ErrorReporting::V1beta1::ErrorGroup.
p result
```