Send feedback
Class ListFilesRequest (0.68.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class ListFilesRequest extends GeneratedMessageV3 implements ListFilesRequestOrBuilder
Request message for
SessionService.ListFiles
method.
Protobuf type google.cloud.discoveryengine.v1alpha.ListFilesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static ListFilesRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ListFilesRequest . Builder newBuilder ()
newBuilder(ListFilesRequest prototype)
public static ListFilesRequest . Builder newBuilder ( ListFilesRequest prototype )
public static ListFilesRequest parseDelimitedFrom ( InputStream input )
public static ListFilesRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ListFilesRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListFilesRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ListFilesRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListFilesRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ListFilesRequest parseFrom ( CodedInputStream input )
public static ListFilesRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ListFilesRequest parseFrom ( InputStream input )
public static ListFilesRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ListFilesRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListFilesRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ListFilesRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public ListFilesRequest getDefaultInstanceForType ()
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()
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.
getParserForType()
public Parser<ListFilesRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ListFilesRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListFilesRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public ListFilesRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-18 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-18 UTC."],[],[],null,[]]
