class ListGroupStatsRequest extends Message

Specifies a set of ErrorGroupStats to return.

Protobuf type Google\Devtools\Clouderrorreporting\V1beta1\ListGroupStatsRequest

Methods

__construct()

No description

string
getProjectName()

[Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID.

setProjectName(string $var)

[Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID.

RepeatedField
getGroupId()

[Optional] List all ErrorGroupStats with these IDs.

setGroupId(array|RepeatedField $var)

[Optional] List all ErrorGroupStats with these IDs.

getServiceFilter()

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

setServiceFilter(ServiceContextFilter $var)

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

getTimeRange()

[Optional] List data for the given time range.

setTimeRange(QueryTimeRange $var)

[Optional] List data for the given time range.

getTimedCountDuration()

[Optional] The preferred duration for a single returned TimedCount.

setTimedCountDuration(Duration $var)

[Optional] The preferred duration for a single returned TimedCount.

int
getAlignment()

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

setAlignment(int $var)

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

getAlignmentTime()

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

setAlignmentTime(Timestamp $var)

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

int
getOrder()

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

setOrder(int $var)

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

int
getPageSize()

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

setPageSize(int $var)

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

string
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.

setPageToken(string $var)

[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.

Details

at line 98
__construct()

at line 113
string getProjectName()

[Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID.

Example: projects/my-project-123.

Generated from protobuf field string project_name = 1;

Return Value

string

at line 128
setProjectName(string $var)

[Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID.

Example: projects/my-project-123.

Generated from protobuf field string project_name = 1;

Parameters

string $var

at line 140
RepeatedField getGroupId()

[Optional] List all ErrorGroupStats with these IDs.

Generated from protobuf field repeated string group_id = 2;

Return Value

RepeatedField

at line 151
setGroupId(array|RepeatedField $var)

[Optional] List all ErrorGroupStats with these IDs.

Generated from protobuf field repeated string group_id = 2;

Parameters

array|RepeatedField $var

at line 165
ServiceContextFilter 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.

Generated from protobuf field .google.devtools.clouderrorreporting.v1beta1.ServiceContextFilter service_filter = 3;

Return Value

ServiceContextFilter

at line 178
setServiceFilter(ServiceContextFilter $var)

[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.

Generated from protobuf field .google.devtools.clouderrorreporting.v1beta1.ServiceContextFilter service_filter = 3;

Parameters

ServiceContextFilter $var

at line 196
QueryTimeRange 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.

Generated from protobuf field .google.devtools.clouderrorreporting.v1beta1.QueryTimeRange time_range = 5;

Return Value

QueryTimeRange

at line 213
setTimeRange(QueryTimeRange $var)

[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.

Generated from protobuf field .google.devtools.clouderrorreporting.v1beta1.QueryTimeRange time_range = 5;

Parameters

QueryTimeRange $var

at line 226
Duration getTimedCountDuration()

[Optional] The preferred duration for a single returned TimedCount.

If not set, no timed counts are returned.

Generated from protobuf field .google.protobuf.Duration timed_count_duration = 6;

Return Value

Duration

at line 238
setTimedCountDuration(Duration $var)

[Optional] The preferred duration for a single returned TimedCount.

If not set, no timed counts are returned.

Generated from protobuf field .google.protobuf.Duration timed_count_duration = 6;

Parameters

Duration $var

at line 251
int getAlignment()

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

Default is ALIGNMENT_EQUAL_AT_END.

Generated from protobuf field .google.devtools.clouderrorreporting.v1beta1.TimedCountAlignment alignment = 7;

Return Value

int

at line 263
setAlignment(int $var)

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

Default is ALIGNMENT_EQUAL_AT_END.

Generated from protobuf field .google.devtools.clouderrorreporting.v1beta1.TimedCountAlignment alignment = 7;

Parameters

int $var

at line 276
Timestamp getAlignmentTime()

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

Generated from protobuf field .google.protobuf.Timestamp alignment_time = 8;

Return Value

Timestamp

at line 288
setAlignmentTime(Timestamp $var)

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

Generated from protobuf field .google.protobuf.Timestamp alignment_time = 8;

Parameters

Timestamp $var

at line 301
int getOrder()

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

Default is COUNT_DESC.

Generated from protobuf field .google.devtools.clouderrorreporting.v1beta1.ErrorGroupOrder order = 9;

Return Value

int

at line 313
setOrder(int $var)

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

Default is COUNT_DESC.

Generated from protobuf field .google.devtools.clouderrorreporting.v1beta1.ErrorGroupOrder order = 9;

Parameters

int $var

at line 326
int getPageSize()

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

Default is 20.

Generated from protobuf field int32 page_size = 11;

Return Value

int

at line 338
setPageSize(int $var)

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

Default is 20.

Generated from protobuf field int32 page_size = 11;

Parameters

int $var

at line 352
string 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.

Generated from protobuf field string page_token = 12;

Return Value

string

at line 365
setPageToken(string $var)

[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.

Generated from protobuf field string page_token = 12;

Parameters

string $var