Package com.google.cloud.aiplatform.v1

Class ListEventsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListEventsRequest.Builder>
com.google.cloud.aiplatform.v1.ListEventsRequest.Builder
All Implemented Interfaces:
ListEventsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListEventsRequest
public static final class ListEventsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListEventsRequest.Builder> implements ListEventsRequestOrBuilder
 Request message for
 [SessionService.ListEvents][google.cloud.aiplatform.v1.SessionService.ListEvents].
Protobuf type google.cloud.aiplatform.v1.ListEventsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListEventsRequest.Builder>

    • clear

      public ListEventsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListEventsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListEventsRequest.Builder>

    • getDefaultInstanceForType

      public ListEventsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListEventsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListEventsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListEventsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListEventsRequest.Builder>

    • mergeFrom

      public ListEventsRequest.Builder mergeFrom(ListEventsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListEventsRequest.Builder>

    • mergeFrom

      public ListEventsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListEventsRequest.Builder>
      Throws:
      IOException

    • 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) = { ... }
      Specified by:
      getParent in interface ListEventsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListEventsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      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:
      This builder for chaining.

    • setParentBytes

      public ListEventsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getPageSize in interface ListEventsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      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];
      Parameters:
      value - The pageSize to set.
      Returns:
      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:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       Optional. The
 [next_page_token][google.cloud.aiplatform.v1.ListEventsResponse.next_page_token]
 value returned from a previous list
 [SessionService.ListEvents][google.cloud.aiplatform.v1.SessionService.ListEvents]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface ListEventsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. The
 [next_page_token][google.cloud.aiplatform.v1.ListEventsResponse.next_page_token]
 value returned from a previous list
 [SessionService.ListEvents][google.cloud.aiplatform.v1.SessionService.ListEvents]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface ListEventsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListEventsRequest.Builder setPageToken(String value)
       Optional. The
 [next_page_token][google.cloud.aiplatform.v1.ListEventsResponse.next_page_token]
 value returned from a previous list
 [SessionService.ListEvents][google.cloud.aiplatform.v1.SessionService.ListEvents]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListEventsRequest.Builder clearPageToken()
       Optional. The
 [next_page_token][google.cloud.aiplatform.v1.ListEventsResponse.next_page_token]
 value returned from a previous list
 [SessionService.ListEvents][google.cloud.aiplatform.v1.SessionService.ListEvents]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListEventsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Optional. The
 [next_page_token][google.cloud.aiplatform.v1.ListEventsResponse.next_page_token]
 value returned from a previous list
 [SessionService.ListEvents][google.cloud.aiplatform.v1.SessionService.ListEvents]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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](https://google.aip.dev/160).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface ListEventsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface ListEventsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      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](https://google.aip.dev/160).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • 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](https://google.aip.dev/160).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setFilterBytes

      public ListEventsRequest.Builder setFilterBytes(com.google.protobuf.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](https://google.aip.dev/160).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getOrderBy in interface ListEventsRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public 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];
      Specified by:
      getOrderByBytes in interface ListEventsRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      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];
      Parameters:
      value - The orderBy to set.
      Returns:
      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:
      This builder for chaining.

    • setOrderByBytes

      public ListEventsRequest.Builder setOrderByBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.