Stackdriver Error Reporting V1beta1 Client - Class ErrorGroupStats (0.22.9)

Reference documentation and code samples for the Stackdriver Error Reporting V1beta1 Client class ErrorGroupStats.

Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter.

Generated from protobuf message google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats

Namespace

Google \ Cloud \ ErrorReporting \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ group ErrorGroup

Group data that is independent of the filter criteria.
↳ count int|string

Approximate total number of events in the given group that match the filter criteria.
↳ affected_users_count int|string

Approximate number of affected users in the given group that match the filter criteria. Users are distinguished by data in the [ErrorContext] [google.devtools.clouderrorreporting.v1beta1.ErrorContext] of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here.
↳ timed_counts array<TimedCount>

Approximate number of occurrences over time. Timed counts returned by ListGroups are guaranteed to be: - Inside the requested time interval - Non-overlapping, and - Ordered by ascending time.
↳ first_seen_time Google\Protobuf\Timestamp

Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
↳ last_seen_time Google\Protobuf\Timestamp

Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
↳ affected_services array<ServiceContext>

Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected. Refer to num_affected_services for the total count.
↳ num_affected_services int

The total number of services with a non-zero error count for the given filter criteria.
↳ representative ErrorEvent

An arbitrary event that is chosen as representative for the whole group. The representative event is intended to be used as a quick preview for the whole group. Events in the group are usually sufficiently similar to each other such that showing an arbitrary representative provides insight into the characteristics of the group as a whole.

getGroup

Group data that is independent of the filter criteria.

Returns
Type Description
ErrorGroup|null

hasGroup

clearGroup

setGroup

Group data that is independent of the filter criteria.

Parameter
Name Description
var ErrorGroup
Returns
Type Description
$this

getCount

Approximate total number of events in the given group that match the filter criteria.

Returns
Type Description
int|string

setCount

Approximate total number of events in the given group that match the filter criteria.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getAffectedUsersCount

Approximate number of affected users in the given group that match the filter criteria.

Users are distinguished by data in the ErrorContext of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here.

Returns
Type Description
int|string

setAffectedUsersCount

Approximate number of affected users in the given group that match the filter criteria.

Users are distinguished by data in the ErrorContext of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTimedCounts

Approximate number of occurrences over time.

Timed counts returned by ListGroups are guaranteed to be:

  • Inside the requested time interval
  • Non-overlapping, and
  • Ordered by ascending time.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTimedCounts

Approximate number of occurrences over time.

Timed counts returned by ListGroups are guaranteed to be:

  • Inside the requested time interval
  • Non-overlapping, and
  • Ordered by ascending time.
Parameter
Name Description
var array<TimedCount>
Returns
Type Description
$this

getFirstSeenTime

Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasFirstSeenTime

clearFirstSeenTime

setFirstSeenTime

Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLastSeenTime

Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastSeenTime

clearLastSeenTime

setLastSeenTime

Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getAffectedServices

Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected.

Refer to num_affected_services for the total count.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAffectedServices

Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected.

Refer to num_affected_services for the total count.

Parameter
Name Description
var array<ServiceContext>
Returns
Type Description
$this

getNumAffectedServices

The total number of services with a non-zero error count for the given filter criteria.

Returns
Type Description
int

setNumAffectedServices

The total number of services with a non-zero error count for the given filter criteria.

Parameter
Name Description
var int
Returns
Type Description
$this

getRepresentative

An arbitrary event that is chosen as representative for the whole group.

The representative event is intended to be used as a quick preview for the whole group. Events in the group are usually sufficiently similar to each other such that showing an arbitrary representative provides insight into the characteristics of the group as a whole.

Returns
Type Description
ErrorEvent|null

hasRepresentative

clearRepresentative

setRepresentative

An arbitrary event that is chosen as representative for the whole group.

The representative event is intended to be used as a quick preview for the whole group. Events in the group are usually sufficiently similar to each other such that showing an arbitrary representative provides insight into the characteristics of the group as a whole.

Parameter
Name Description
var ErrorEvent
Returns
Type Description
$this