Class ListEventsRequest.Builder (3.89.0)

3.89.0 (latest) 3.88.0 3.86.0 3.84.0 3.83.0 3.82.0 3.81.0 3.79.0 3.77.0 3.76.0 3.75.0 3.74.0 3.73.0 3.71.0 3.69.0 3.68.0 3.65.0 3.64.0 3.63.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.0.0 2.9.8 2.8.9 2.7.4 2.5.3 2.4.0

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

Request message for SessionService.ListEvents.

Protobuf type google.cloud.aiplatform.v1.ListEventsRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListEventsRequest.Builder

Implements

ListEventsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

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

GeneratedMessage.Builder<BuilderType>.clear()

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.

clearOrderBy()

public ListEventsRequest.Builder clearOrderBy()

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
Type	Description
ListEventsRequest.Builder	This builder for chaining.

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.

getDefaultInstanceForType()

public ListEventsRequest getDefaultInstanceForType()

Returns
Type	Description
ListEventsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

getOrderBy()

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

getOrderByBytes()

public 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
Type	Description
ByteString	The bytes for orderBy.

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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListEventsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListEventsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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.

setOrderBy(String value)

public ListEventsRequest.Builder setOrderBy(String value)

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

Parameter
Name	Description
value	String The orderBy to set.

Returns
Type	Description
ListEventsRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public ListEventsRequest.Builder setOrderByBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for orderBy 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.