Class ListSpaceEventsRequest.Builder (0.17.0) 

public static final class ListSpaceEventsRequest.Builder extends GeneratedMessageV3.Builder<ListSpaceEventsRequest.Builder> implements ListSpaceEventsRequestOrBuilder

Request message for listing space events.

Protobuf type google.chat.v1.ListSpaceEventsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListSpaceEventsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListSpaceEventsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

build()

public ListSpaceEventsRequest build()
Returns
Type Description
ListSpaceEventsRequest

buildPartial()

public ListSpaceEventsRequest buildPartial()
Returns
Type Description
ListSpaceEventsRequest

clear()

public ListSpaceEventsRequest.Builder clear()
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListSpaceEventsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

clearFilter()

public ListSpaceEventsRequest.Builder clearFilter()

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 both start_time and end_time, use the AND operator.

    For example, the following queries are valid:

    ` start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" 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:

    start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" 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 an INVALID_ARGUMENT` error.

string filter = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListSpaceEventsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

clearPageSize()

public ListSpaceEventsRequest.Builder clearPageSize()

Optional. The maximum number of space events returned. The service might return fewer than this value.

Negative values return an INVALID_ARGUMENT error.

int32 page_size = 5;

Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

clearPageToken()

public ListSpaceEventsRequest.Builder clearPageToken()

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.

string page_token = 6;

Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

clearParent()

public ListSpaceEventsRequest.Builder clearParent()

Required. Resource name of the Google Chat space where the events occurred.

Format: spaces/{space}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

clone()

public ListSpaceEventsRequest.Builder clone()
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListSpaceEventsRequest getDefaultInstanceForType()
Returns
Type Description
ListSpaceEventsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String 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 both start_time and end_time, use the AND operator.

    For example, the following queries are valid:

    ` start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" 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:

    start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" 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 an INVALID_ARGUMENT` error.

string filter = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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 both start_time and end_time, use the AND operator.

    For example, the following queries are valid:

    ` start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" 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:

    start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" 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 an INVALID_ARGUMENT` error.

string filter = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of space events returned. The service might return fewer than this value.

Negative values return an INVALID_ARGUMENT error.

int32 page_size = 5;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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.

string page_token = 6;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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.

string page_token = 6;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Resource name of the Google Chat space where the events occurred.

Format: spaces/{space}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Resource name of the Google Chat space where the events occurred.

Format: spaces/{space}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListSpaceEventsRequest other)

public ListSpaceEventsRequest.Builder mergeFrom(ListSpaceEventsRequest other)
Parameter
Name Description
other ListSpaceEventsRequest
Returns
Type Description
ListSpaceEventsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListSpaceEventsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListSpaceEventsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListSpaceEventsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListSpaceEventsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

setFilter(String value)

public ListSpaceEventsRequest.Builder setFilter(String value)

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 both start_time and end_time, use the AND operator.

    For example, the following queries are valid:

    ` start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" 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:

    start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" 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 an INVALID_ARGUMENT` error.

string filter = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListSpaceEventsRequest.Builder setFilterBytes(ByteString value)

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 both start_time and end_time, use the AND operator.

    For example, the following queries are valid:

    ` start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" 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:

    start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" 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 an INVALID_ARGUMENT` error.

string filter = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListSpaceEventsRequest.Builder setPageSize(int value)

Optional. The maximum number of space events returned. The service might return fewer than this value.

Negative values return an INVALID_ARGUMENT error.

int32 page_size = 5;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListSpaceEventsRequest.Builder setPageToken(String value)

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.

string page_token = 6;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListSpaceEventsRequest.Builder setPageTokenBytes(ByteString value)

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.

string page_token = 6;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

setParent(String value)

public ListSpaceEventsRequest.Builder setParent(String value)

Required. Resource name of the Google Chat space where the events occurred.

Format: spaces/{space}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListSpaceEventsRequest.Builder setParentBytes(ByteString value)

Required. Resource name of the Google Chat space where the events occurred.

Format: spaces/{space}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListSpaceEventsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListSpaceEventsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListSpaceEventsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListSpaceEventsRequest.Builder
Overrides