Class ListFilesRequest.Builder (0.66.0)

public static final class ListFilesRequest.Builder extends GeneratedMessageV3.Builder<ListFilesRequest.Builder> implements ListFilesRequestOrBuilder

Request message for SessionService.ListFiles method.

Protobuf type google.cloud.discoveryengine.v1alpha.ListFilesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListFilesRequest build()
Returns
Type Description
ListFilesRequest

buildPartial()

public ListFilesRequest buildPartial()
Returns
Type Description
ListFilesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListFilesRequest.Builder clearFilter()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListFilesRequest.Builder clearPageSize()

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

This builder for chaining.

clearPageToken()

public ListFilesRequest.Builder clearPageToken()

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

This builder for chaining.

clearParent()

public ListFilesRequest.Builder clearParent()

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

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListFilesRequest getDefaultInstanceForType()
Returns
Type Description
ListFilesRequest

getDescriptorForType()

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

getFilter()

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

The filter.

getFilterBytes()

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

The bytes for filter.

getPageSize()

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

The pageSize.

getPageToken()

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

The pageToken.

getPageTokenBytes()

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

The bytes for pageToken.

getParent()

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

The parent.

getParentBytes()

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListFilesRequest.Builder setFilter(String value)

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListFilesRequest.Builder setFilterBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListFilesRequest.Builder setPageSize(int value)

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFilesRequest.Builder setPageToken(String value)

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFilesRequest.Builder setPageTokenBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setParent(String value)

public ListFilesRequest.Builder setParent(String value)

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFilesRequest.Builder setParentBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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