Reference documentation and code samples for the Google Apps Chat V1 Client class ListSpaceEventsRequest.
Request message for listing space events.
Generated from protobuf message google.chat.v1.ListSpaceEventsRequest
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Resource name of the Google Chat space where the events occurred. Format: |
↳ page_size |
int
Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an |
↳ page_token |
string
Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
↳ filter |
string
Required. A query filter. You must specify at least one event type ( |
getParent
Required. Resource name of the Google Chat space where the events occurred.
Format: spaces/{space}
.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. Resource name of the Google Chat space where the events occurred.
Format: spaces/{space}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Optional. The maximum number of space events returned. The service might return fewer than this value.
Negative values return an INVALID_ARGUMENT
error.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Optional. The maximum number of space events returned. The service might return fewer than this value.
Negative values return an INVALID_ARGUMENT
error.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Optional. A page token, received from a previous list space events call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Optional. A page token, received from a previous list space events call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Required. A query filter.
You must specify at least one event type (event_type
)
using the has :
operator. To filter by multiple event types, use the OR
operator. Omit batch event types in your filter. The request automatically
returns any related batch events. For example, if you filter by new
reactions
(google.workspace.chat.reaction.v1.created
), the server also returns
batch new reactions events
(google.workspace.chat.reaction.v1.batchCreated
). For a list of supported
event types, see the SpaceEvents
reference
documentation.
Optionally, you can also filter by start time (start_time
) and
end time (end_time
):
start_time
: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days.end_time
: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals=
operator and format in RFC-3339. To filter by bothstart_time
andend_time
, use theAND
operator. For example, the following queries are valid:php start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00"
php start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created")
The following queries are invalid:php start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00"
php event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created"
Invalid queries are rejected by the server with anINVALID_ARGUMENT
error.
Returns | |
---|---|
Type | Description |
string |
setFilter
Required. A query filter.
You must specify at least one event type (event_type
)
using the has :
operator. To filter by multiple event types, use the OR
operator. Omit batch event types in your filter. The request automatically
returns any related batch events. For example, if you filter by new
reactions
(google.workspace.chat.reaction.v1.created
), the server also returns
batch new reactions events
(google.workspace.chat.reaction.v1.batchCreated
). For a list of supported
event types, see the SpaceEvents
reference
documentation.
Optionally, you can also filter by start time (start_time
) and
end time (end_time
):
start_time
: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days.end_time
: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals=
operator and format in RFC-3339. To filter by bothstart_time
andend_time
, use theAND
operator. For example, the following queries are valid:php start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00"
php start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created")
The following queries are invalid:php start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00"
php event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created"
Invalid queries are rejected by the server with anINVALID_ARGUMENT
error.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
parent |
string
Required. Resource name of the Google Chat space where the events occurred. Format: |
filter |
string
Required. A query filter. You must specify at least one event type ( Optionally, you can also filter by start time (
To specify a start or end time, use the equals For example, the following queries are valid:
The following queries are invalid:
Invalid queries are rejected by the server with an |
Returns | |
---|---|
Type | Description |
ListSpaceEventsRequest |