com.google.cloud.aiplatform.v1beta1

Interface ListEventsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListEventsRequest, ListEventsRequest.Builder

@Generated
public interface ListEventsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
String	getOrderBy() Optional.
com.google.protobuf.ByteString	getOrderByBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The resource name of the session to list events from.
 Format:
 `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
 

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

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The resource name of the session to list events from.
 Format:
 `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
 

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

Returns:

The bytes for parent.

getPageSize

int getPageSize()

 Optional. The maximum number of events to return. The service may return
 fewer than this value. If unspecified, at most 100 events will be returned.
 These events are ordered by timestamp in ascending order.
 

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageSize.

getPageToken

String getPageToken()

 Optional. The
 [next_page_token][google.cloud.aiplatform.v1beta1.ListEventsResponse.next_page_token]
 value returned from a previous list
 [SessionService.ListEvents][google.cloud.aiplatform.v1beta1.SessionService.ListEvents]
 call.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 Optional. The
 [next_page_token][google.cloud.aiplatform.v1beta1.ListEventsResponse.next_page_token]
 value returned from a previous list
 [SessionService.ListEvents][google.cloud.aiplatform.v1beta1.SessionService.ListEvents]
 call.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for pageToken.

getFilter

String getFilter()

 Optional. The standard list filter.
 Supported fields:
 * `timestamp` range (i.e. `timestamp>="2025-01-31T11:30:00-04:00"` where
 the timestamp is in RFC 3339 format)

 More detail in [AIP-160](https://google.aip.dev/160).
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Optional. The standard list filter.
 Supported fields:
 * `timestamp` range (i.e. `timestamp>="2025-01-31T11:30:00-04:00"` where
 the timestamp is in RFC 3339 format)

 More detail in [AIP-160](https://google.aip.dev/160).
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for filter.

getOrderBy

String getOrderBy()

 Optional. A comma-separated list of fields to order by, sorted in ascending
 order. Use "desc" after a field name for descending. Supported fields:
 * `timestamp`

 Example: `timestamp desc`.
 

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 Optional. A comma-separated list of fields to order by, sorted in ascending
 order. Use "desc" after a field name for descending. Supported fields:
 * `timestamp`

 Example: `timestamp desc`.
 

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for orderBy.