Send feedback
  
   
 
  
    
      Class ListHyperparameterTuningJobsRequest (3.6.0)
    
    
      
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
  
   
  
    
  
  
    
    
    
    
  Version 3.6.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  ListHyperparameterTuningJobsRequest   extends   GeneratedMessageV3   implements   ListHyperparameterTuningJobsRequestOrBuilder  
   Request message for JobService.ListHyperparameterTuningJobs .
 Protobuf type google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsRequest
Static Fields
   
  
  
    
public   static   final   int   FILTER_FIELD_NUMBER  
  Field Value 
  
  PAGE_SIZE_FIELD_NUMBER 
  
    
public   static   final   int   PAGE_SIZE_FIELD_NUMBER  
  Field Value 
  
  PAGE_TOKEN_FIELD_NUMBER 
  
    
public   static   final   int   PAGE_TOKEN_FIELD_NUMBER  
  Field Value 
  
  
  
    
public   static   final   int   PARENT_FIELD_NUMBER  
  Field Value 
  
  
  
    
public   static   final   int   READ_MASK_FIELD_NUMBER  
  Field Value 
  
  Static Methods
   
  
    
public   static   ListHyperparameterTuningJobsRequest   getDefaultInstance ()  
  Returns 
  
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  Returns 
  
  
    
public   static   ListHyperparameterTuningJobsRequest . Builder   newBuilder ()  
  Returns 
  
  
    
public   static   ListHyperparameterTuningJobsRequest . Builder   newBuilder ( ListHyperparameterTuningJobsRequest   prototype )  
  Parameter 
  
  Returns 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseDelimitedFrom ( InputStream   input )  
  Parameter 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  Parameters 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( byte []   data )  
  Parameter 
  
    
      
        Name Description  
      
        data byte [] 
     
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  Parameters 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( ByteString   data )  
  Parameter 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  Parameters 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( CodedInputStream   input )  
  Parameter 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  Parameters 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( InputStream   input )  
  Parameter 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  Parameters 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( ByteBuffer   data )  
  Parameter 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   ListHyperparameterTuningJobsRequest   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  Parameters 
  
  Returns 
  
  Exceptions 
  
  
    
public   static   Parser<ListHyperparameterTuningJobsRequest>   parser ()  
  Returns 
  
  Methods
   
  
    
public   boolean   equals ( Object   obj )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  
    
public   ListHyperparameterTuningJobsRequest   getDefaultInstanceForType ()  
  Returns 
  
  
    
public   String   getFilter ()  
   The standard list filter.
 Supported fields:
display_name supports =, != comparisons, and : wildcard.state supports =, != comparisons.create_time supports =, !=,<, <=,>, >= comparisons.
create_time must be in RFC 3339 format.labels supports general map functions that is:
labels.key=value - key:value equality
labels.key:* - key existence
Some examples of using the filter are:state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*" 
state!="JOB_STATE_FAILED" OR display_name="my_job" 
NOT display_name="my_job" 
create_time>"2021-05-18T00:00:00Z" 
labels.keyA=valueA 
labels.keyB:*` 
 
 string filter = 2;
Returns 
  
    
      
        Type Description  
      
        String The filter.
 
     
  
  
    
public   ByteString   getFilterBytes ()  
   The standard list filter.
 Supported fields:
display_name supports =, != comparisons, and : wildcard.state supports =, != comparisons.create_time supports =, !=,<, <=,>, >= comparisons.
create_time must be in RFC 3339 format.labels supports general map functions that is:
labels.key=value - key:value equality
labels.key:* - key existence
Some examples of using the filter are:state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*" 
state!="JOB_STATE_FAILED" OR display_name="my_job" 
NOT display_name="my_job" 
create_time>"2021-05-18T00:00:00Z" 
labels.keyA=valueA 
labels.keyB:*` 
 
 string filter = 2;
Returns 
  
  getPageSize() 
  
   The standard list page size.
 int32 page_size = 3;
Returns 
  
    
      
        Type Description  
      
        int The pageSize.
 
     
  
  getPageToken() 
  
    
public   String   getPageToken ()  
   The standard list page token.
 Typically obtained via
 ListHyperparameterTuningJobsResponse.next_page_token  of the previous
 JobService.ListHyperparameterTuningJobs  call.
 string page_token = 4;
Returns 
  
    
      
        Type Description  
      
        String The pageToken.
 
     
  
  getPageTokenBytes() 
  
    
public   ByteString   getPageTokenBytes ()  
   The standard list page token.
 Typically obtained via
 ListHyperparameterTuningJobsResponse.next_page_token  of the previous
 JobService.ListHyperparameterTuningJobs  call.
 string page_token = 4;
Returns 
  
    
      
        Type Description  
      
        ByteString The bytes for pageToken.
 
     
  
  
    
public   String   getParent ()  
   Required. The resource name of the Location to list the HyperparameterTuningJobs
 from. Format: projects/{project}/locations/{location}
 
 string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
Returns 
  
    
      
        Type Description  
      
        String The parent.
 
     
  
  
    
public   ByteString   getParentBytes ()  
   Required. The resource name of the Location to list the HyperparameterTuningJobs
 from. Format: projects/{project}/locations/{location}
 
 string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
Returns 
  
  
    
public   Parser<ListHyperparameterTuningJobsRequest>   getParserForType ()  
  Returns 
  
  Overrides 
  
  
    
public   FieldMask   getReadMask ()  
   Mask specifying which fields to read.
 .google.protobuf.FieldMask read_mask = 5;
Returns 
  
  
    
public   FieldMaskOrBuilder   getReadMaskOrBuilder ()  
   Mask specifying which fields to read.
 .google.protobuf.FieldMask read_mask = 5;
Returns 
  
  
    
public   int   getSerializedSize ()  
  Returns 
  
  Overrides 
  
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
  Returns 
  
  Overrides 
  
  
    
public   boolean   hasReadMask ()  
   Mask specifying which fields to read.
 .google.protobuf.FieldMask read_mask = 5;
Returns 
  
    
      
        Type Description  
      
        boolean Whether the readMask field is set.
 
     
  
  Returns 
  
  Overrides 
  
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  Returns 
  
  Overrides 
  
  
    
public   final   boolean   isInitialized ()  
  Returns 
  
  Overrides 
  
  
    
public   ListHyperparameterTuningJobsRequest . Builder   newBuilderForType ()  
  Returns 
  
  
    
protected   ListHyperparameterTuningJobsRequest . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  Parameter 
  
  Returns 
  
  Overrides 
  
  
    
public   ListHyperparameterTuningJobsRequest . Builder   toBuilder ()  
  Returns 
  
  
    
public   void   writeTo ( CodedOutputStream   output )  
  Parameter 
  
  Overrides 
  
  Exceptions 
  
 
     
    
  
  
  
     
  
    
    
      
    
     
  
       
         
  
  
    
    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-11 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-11 UTC."],[],[]]