Send feedback
  
   
 
  
    
      Class SearchFilesRequest (0.67.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 0.67.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  SearchFilesRequest   extends   GeneratedMessageV3   implements   SearchFilesRequestOrBuilder  
   
   Configuration containing file search request parameters.
 Protobuf type google.cloud.dataform.v1.SearchFilesRequest
 
  
  
  
    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
   
  
  
    
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  
         
       
     
  
  
  
    
public   static   final   int   WORKSPACE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Static Methods
   
   
  
  
    
public   static   SearchFilesRequest   getDefaultInstance ()  
   
  
   
  
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  
  
    
public   static   SearchFilesRequest . Builder   newBuilder ()  
   
  
   
  
  
    
public   static   SearchFilesRequest . Builder   newBuilder ( SearchFilesRequest   prototype )  
   
  
  
   
  
  
    
public   static   SearchFilesRequest   parseDelimitedFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( ByteString   data )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( CodedInputStream   input )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( ByteBuffer   data )  
   
  
  
  
   
  
  
    
public   static   SearchFilesRequest   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   Parser<SearchFilesRequest>   parser ()  
   
  
  Methods
   
   
  
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  
  
    
public   SearchFilesRequest   getDefaultInstanceForType ()  
   
  
   
  
  
    
public   String   getFilter ()  
   
   Optional. Optional filter for the returned list in filtering format.
 Filtering is only currently supported on the path field.
 See https://google.aip.dev/160  for details.
 string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The filter.
 
       
     
  
   
  
  
    
public   ByteString   getFilterBytes ()  
   
   Optional. Optional filter for the returned list in filtering format.
 Filtering is only currently supported on the path field.
 See https://google.aip.dev/160  for details.
 string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for filter.
 
       
     
  
   
  getPageSize() 
  
   Optional. Maximum number of search results to return. The server may return
 fewer items than requested. If unspecified, the server will pick an
 appropriate default.
 int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
        The pageSize.
 
       
     
  
   
  getPageToken() 
  
    
public   String   getPageToken ()  
   
   Optional. Page token received from a previous SearchFilesRequest
 call. Provide this to retrieve the subsequent page.
 When paginating, all other parameters provided to SearchFilesRequest,
 with the exception of page_size, must match the call that provided the
 page token.
 string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The pageToken.
 
       
     
  
   
  getPageTokenBytes() 
  
    
public   ByteString   getPageTokenBytes ()  
   
   Optional. Page token received from a previous SearchFilesRequest
 call. Provide this to retrieve the subsequent page.
 When paginating, all other parameters provided to SearchFilesRequest,
 with the exception of page_size, must match the call that provided the
 page token.
 string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for pageToken.
 
       
     
  
   
  
  
    
public   Parser<SearchFilesRequest>   getParserForType ()  
   
  
  Overrides 
  
   
  
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  
  
    
public   String   getWorkspace ()  
   
   Required. The workspace's name.
 
 string workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The workspace.
 
       
     
  
   
  
  
    
public   ByteString   getWorkspaceBytes ()  
   
   Required. The workspace's name.
 
 string workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for workspace.
 
       
     
  
   
  
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  
  
    
public   SearchFilesRequest . Builder   newBuilderForType ()  
   
  
   
  
  
    
protected   SearchFilesRequest . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  
  
    
public   SearchFilesRequest . Builder   toBuilder ()  
   
  
   
  
  
    
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-10-30 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-10-30 UTC."],[],[]]