Stackdriver Error Reporting V1beta1 Client - Class ListGroupStatsRequest (0.22.6)

Version 0.22.6

• 0.22.8 (latest)
• 0.22.7
• 0.21.1
• 0.20.2
• 0.19.12

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Specifies a set of ErrorGroupStats to return.

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

Namespace

Google \ Cloud \ ErrorReporting \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ project_name	string Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud Console. Examples: projects/my-project-123, projects/5551234.
↳ group_id	array Optional. List all ErrorGroupStats with these IDs.
↳ service_filter	Google\Cloud\ErrorReporting\V1beta1\ServiceContextFilter Optional. List only ErrorGroupStats which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified.
↳ time_range	Google\Cloud\ErrorReporting\V1beta1\QueryTimeRange Optional. List data for the given time range. If not set, a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only ErrorGroupStats with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also ErrorGroupStats with zero occurrences are returned.
↳ timed_count_duration	Google\Protobuf\Duration Optional. The preferred duration for a single returned TimedCount. If not set, no timed counts are returned.
↳ alignment	int Optional. The alignment of the timed counts to be returned. Default is ALIGNMENT_EQUAL_AT_END.
↳ alignment_time	Google\Protobuf\Timestamp Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.
↳ order	int Optional. The sort order in which the results are returned. Default is COUNT_DESC.
↳ page_size	int Optional. The maximum number of results to return per response. Default is 20.
↳ page_token	string Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

getProjectName

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud Console.

Examples: projects/my-project-123, projects/5551234.

Returns
Type	Description
string

setProjectName

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud Console.

Examples: projects/my-project-123, projects/5551234.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGroupId

Optional. List all ErrorGroupStats with these IDs.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setGroupId

Optional. List all ErrorGroupStats with these IDs.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getServiceFilter

Optional. List only ErrorGroupStats which belong to a service context that matches the filter.

Data for all service contexts is returned if this field is not specified.

Returns
Type	Description
Google\Cloud\ErrorReporting\V1beta1\ServiceContextFilter|null

hasServiceFilter

clearServiceFilter

setServiceFilter

Optional. List only ErrorGroupStats which belong to a service context that matches the filter.

Data for all service contexts is returned if this field is not specified.

Parameter
Name	Description
var	Google\Cloud\ErrorReporting\V1beta1\ServiceContextFilter

Returns
Type	Description
$this

getTimeRange

Optional. List data for the given time range.

If not set, a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only ErrorGroupStats with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also ErrorGroupStats with zero occurrences are returned.

Returns
Type	Description
Google\Cloud\ErrorReporting\V1beta1\QueryTimeRange|null

hasTimeRange

clearTimeRange

setTimeRange

Optional. List data for the given time range.

If not set, a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only ErrorGroupStats with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also ErrorGroupStats with zero occurrences are returned.

Parameter
Name	Description
var	Google\Cloud\ErrorReporting\V1beta1\QueryTimeRange

Returns
Type	Description
$this

getTimedCountDuration

Optional. The preferred duration for a single returned TimedCount.

If not set, no timed counts are returned.

Returns
Type	Description
Google\Protobuf\Duration|null

hasTimedCountDuration

clearTimedCountDuration

setTimedCountDuration

Optional. The preferred duration for a single returned TimedCount.

If not set, no timed counts are returned.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getAlignment

Optional. The alignment of the timed counts to be returned.

Default is ALIGNMENT_EQUAL_AT_END.

Returns
Type	Description
int

setAlignment

Optional. The alignment of the timed counts to be returned.

Default is ALIGNMENT_EQUAL_AT_END.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getAlignmentTime

Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasAlignmentTime

clearAlignmentTime

setAlignmentTime

Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getOrder

Optional. The sort order in which the results are returned.

Default is COUNT_DESC.

Returns
Type	Description
int

setOrder

Optional. The sort order in which the results are returned.

Default is COUNT_DESC.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of results to return per response.

Default is 20.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of results to return per response.

Default is 20.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

Returns
Type	Description
string

setPageToken

Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
projectName	string Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud Console. Examples: projects/my-project-123, projects/5551234. Please see Google\Cloud\ErrorReporting\V1beta1\ErrorStatsServiceClient::projectName() for help formatting this field.
timeRange	Google\Cloud\ErrorReporting\V1beta1\QueryTimeRange Optional. List data for the given time range. If not set, a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only ErrorGroupStats with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also ErrorGroupStats with zero occurrences are returned.

Returns
Type	Description
Google\Cloud\ErrorReporting\V1beta1\ListGroupStatsRequest