Class ListEventsRequest.Builder (3.73.0)

public static final class ListEventsRequest.Builder extends GeneratedMessageV3.Builder<ListEventsRequest.Builder> implements ListEventsRequestOrBuilder

Request message for SessionService.ListEvents.

Protobuf type google.cloud.aiplatform.v1beta1.ListEventsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListEventsRequest build()
Returns
Type Description
ListEventsRequest

buildPartial()

public ListEventsRequest buildPartial()
Returns
Type Description
ListEventsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListEventsRequest.Builder clearFilter()

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.

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

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListEventsRequest.Builder clearPageSize()

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
Type Description
ListEventsRequest.Builder

This builder for chaining.

clearPageToken()

public ListEventsRequest.Builder clearPageToken()

Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.

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

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

clearParent()

public ListEventsRequest.Builder clearParent()

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
Type Description
ListEventsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListEventsRequest getDefaultInstanceForType()
Returns
Type Description
ListEventsRequest

getDescriptorForType()

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

getFilter()

public 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.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public 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.

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public 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
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public 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
Type Description
String

The parent.

getParentBytes()

public 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
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(ListEventsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListEventsRequest.Builder setFilter(String value)

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.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListEventsRequest.Builder setFilterBytes(ByteString value)

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.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListEventsRequest.Builder setPageSize(int value)

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];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEventsRequest.Builder setPageToken(String value)

Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEventsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setParent(String value)

public ListEventsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEventsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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