Package com.google.cloud.discoveryengine.v1alpha

Interface ListFilesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListFilesRequest, ListFilesRequest.Builder
@Generated public interface ListFilesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    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.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getParent

      String getParent()
       Required. The resource name of the Session.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
 Name of the session resource to which the file belong.
      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.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
 Name of the session resource to which the file belong.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      String getFilter()
       Optional. The filter syntax consists of an expression language for
 constructing a predicate from one or more fields of the files being
 filtered. Filter expression is case-sensitive. Currently supported field
 names are:
 * upload_time
 * last_add_time
 * last_use_time
 * file_name
 * mime_type

 Some examples of filters would be:
 * "file_name = 'file_1'"
 * "file_name = 'file_1' AND mime_type = 'text/plain'"
 * "last_use_time > '2025-06-14T12:00:00Z'"

 For a full description of the filter format, please
 see https://google.aip.dev/160.
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. The filter syntax consists of an expression language for
 constructing a predicate from one or more fields of the files being
 filtered. Filter expression is case-sensitive. Currently supported field
 names are:
 * upload_time
 * last_add_time
 * last_use_time
 * file_name
 * mime_type

 Some examples of filters would be:
 * "file_name = 'file_1'"
 * "file_name = 'file_1' AND mime_type = 'text/plain'"
 * "last_use_time > '2025-06-14T12:00:00Z'"

 For a full description of the filter format, please
 see https://google.aip.dev/160.
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.

    • getPageSize

      int getPageSize()
       Optional. The maximum number of files to return. The service may return
 fewer than this value. If unspecified, at most 100 files will be returned.
 The maximum value is 1000; values above 1000 will be coerced to 1000.
 If user specifies a value less than or equal to 0 - the request will be
 rejected with an INVALID_ARGUMENT error.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. A page token received from a previous `ListFiles` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListFiles`
 must match the call that provided the page token (except `page_size`, which
 may differ).
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A page token received from a previous `ListFiles` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListFiles`
 must match the call that provided the page token (except `page_size`, which
 may differ).
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.