Send feedback
Class ListStudiesRequest (3.5.0)
Version 3.5.0keyboard_arrow_down
public final class ListStudiesRequest extends GeneratedMessageV3 implements ListStudiesRequestOrBuilder
Request message for VizierService.ListStudies .
Protobuf type google.cloud.aiplatform.v1beta1.ListStudiesRequest
Static Fields
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
Static Methods
public static ListStudiesRequest getDefaultInstance ()
Returns
public static final Descriptors . Descriptor getDescriptor ()
Returns
public static ListStudiesRequest . Builder newBuilder ()
Returns
public static ListStudiesRequest . Builder newBuilder ( ListStudiesRequest prototype )
Parameter
Returns
public static ListStudiesRequest parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ListStudiesRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListStudiesRequest parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
public static ListStudiesRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListStudiesRequest parseFrom ( ByteString data )
Parameter
Returns
Exceptions
public static ListStudiesRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListStudiesRequest parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ListStudiesRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListStudiesRequest parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ListStudiesRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListStudiesRequest parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
public static ListStudiesRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Parser<ListStudiesRequest> parser ()
Returns
Methods
public boolean equals ( Object obj )
Parameter
Returns
Overrides
public ListStudiesRequest getDefaultInstanceForType ()
Returns
getPageSize()
Optional. The maximum number of studies to return per "page" of results.
If unspecified, service will pick an appropriate default.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The pageSize.
getPageToken()
public String getPageToken ()
Optional. A page token to request the next page of results.
If unspecified, there are no subsequent pages.
string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The pageToken.
getPageTokenBytes()
public ByteString getPageTokenBytes ()
Optional. A page token to request the next page of results.
If unspecified, there are no subsequent pages.
string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for pageToken.
public String getParent ()
Required. The resource name of the Location to list the Study 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 Study from.
Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
public Parser<ListStudiesRequest> getParserForType ()
Returns
Overrides
public int getSerializedSize ()
Returns
Overrides
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
public final boolean isInitialized ()
Returns
Overrides
public ListStudiesRequest . Builder newBuilderForType ()
Returns
protected ListStudiesRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public ListStudiesRequest . 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-29 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-29 UTC."],[],[]]
