Stackdriver Error Reporting V1beta1 Client - Class ListEventsRequest (0.22.8)

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
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/{projectID}/locations/{location}, where {projectID} is the Google Cloud Platform project ID and {location} is a Cloud region. Examples: projects/my-project-123, projects/my-project-123/locations/global. For a list of supported locations, see Supported Regions. global is the default when unspecified.
↳ group_id string

Required. The group for which events shall be returned. 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.
↳ service_filter 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 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} or projects/{projectID}/locations/{location}, where {projectID} is the Google Cloud Platform project ID and {location} is a Cloud region.

Examples: projects/my-project-123, projects/my-project-123/locations/global. For a list of supported locations, see Supported Regions. global is the default when unspecified.

Returns
Type Description
string

setProjectName

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectID}/locations/{location}, where {projectID} is the Google Cloud Platform project ID and {location} is a Cloud region.

Examples: projects/my-project-123, projects/my-project-123/locations/global. For a list of supported locations, see Supported Regions. global is the default when unspecified.

Parameter
Name Description
var string
Returns
Type Description
$this

getGroupId

Required. The group for which events shall be returned.

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.

Returns
Type Description
string

setGroupId

Required. The group for which events shall be returned.

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.

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var ServiceContextFilter
Returns
Type Description
$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
Type Description
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
Name Description
var QueryTimeRange
Returns
Type Description
$this

getPageSize

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

Returns
Type Description
int

setPageSize

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

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A next_page_token provided by a previous response.

Returns
Type Description
string

setPageToken

Optional. A next_page_token provided by a previous response.

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/{projectID}/locations/{location}, where {projectID} is the Google Cloud Platform project ID and {location} is a Cloud region.

Examples: projects/my-project-123, projects/my-project-123/locations/global.

For a list of supported locations, see Supported Regions. global is the default when unspecified. Please see ErrorStatsServiceClient::projectName() for help formatting this field.
groupId string

Required. The group for which events shall be returned. 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.
Returns
Type Description
ListEventsRequest