Stackdriver Error Reporting V1beta1 Client - Class ListEventsRequest (0.21.1)

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

Specifies a set of error events to return.

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

Namespace

Google \ Cloud \ ErrorReporting \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
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}, where {projectID} is the Google Cloud Platform project ID. Example: projects/my-project-123.

↳ group_id string

Required. The group for which events shall be returned.

↳ service_filter Google\Cloud\ErrorReporting\V1beta1\ServiceContextFilter

Optional. List only ErrorGroups 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 only 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.

↳ page_size int

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

↳ page_token string

Optional. A next_page_token provided by a previous response.

getProjectName

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

Example: projects/my-project-123.

Returns
TypeDescription
string

setProjectName

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

Example: projects/my-project-123.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGroupId

Required. The group for which events shall be returned.

Returns
TypeDescription
string

setGroupId

Required. The group for which events shall be returned.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getServiceFilter

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

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

Returns
TypeDescription
Google\Cloud\ErrorReporting\V1beta1\ServiceContextFilter|null

hasServiceFilter

clearServiceFilter

setServiceFilter

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

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

Parameter
NameDescription
var Google\Cloud\ErrorReporting\V1beta1\ServiceContextFilter
Returns
TypeDescription
$this

getTimeRange

Optional. List only 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.

Returns
TypeDescription
Google\Cloud\ErrorReporting\V1beta1\QueryTimeRange|null

hasTimeRange

clearTimeRange

setTimeRange

Optional. List only 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.

Parameter
NameDescription
var Google\Cloud\ErrorReporting\V1beta1\QueryTimeRange
Returns
TypeDescription
$this

getPageSize

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

Returns
TypeDescription
int

setPageSize

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. A next_page_token provided by a previous response.

Returns
TypeDescription
string

setPageToken

Optional. A next_page_token provided by a previous response.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
projectName string

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

Example: projects/my-project-123. Please see Google\Cloud\ErrorReporting\V1beta1\ErrorStatsServiceClient::projectName() for help formatting this field.

groupId string

Required. The group for which events shall be returned.

Returns
TypeDescription
Google\Cloud\ErrorReporting\V1beta1\ListEventsRequest