Class ListSpaceEventsRequest (0.15.0)

public final class ListSpaceEventsRequest extends GeneratedMessageV3 implements ListSpaceEventsRequestOrBuilder

Request message for listing space events.

Protobuf type google.chat.v1.ListSpaceEventsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListSpaceEventsRequest getDefaultInstance()
Returns
TypeDescription
ListSpaceEventsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ListSpaceEventsRequest.Builder newBuilder()
Returns
TypeDescription
ListSpaceEventsRequest.Builder

newBuilder(ListSpaceEventsRequest )

public static ListSpaceEventsRequest.Builder newBuilder(ListSpaceEventsRequest )
Parameter
NameDescription
ListSpaceEventsRequest
Returns
TypeDescription
ListSpaceEventsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListSpaceEventsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSpaceEventsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListSpaceEventsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListSpaceEventsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListSpaceEventsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListSpaceEventsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListSpaceEventsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSpaceEventsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListSpaceEventsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSpaceEventsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListSpaceEventsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListSpaceEventsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListSpaceEventsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListSpaceEventsRequest> parser()
Returns
TypeDescription
Parser<ListSpaceEventsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ListSpaceEventsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListSpaceEventsRequest

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 anINVALID_ARGUMENT` error.

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

Returns
TypeDescription
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 anINVALID_ARGUMENT` error.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<ListSpaceEventsRequest> getParserForType()
Returns
TypeDescription
Parser<ListSpaceEventsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListSpaceEventsRequest.Builder newBuilderForType()
Returns
TypeDescription
ListSpaceEventsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListSpaceEventsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListSpaceEventsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListSpaceEventsRequest.Builder toBuilder()
Returns
TypeDescription
ListSpaceEventsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException