Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListStudiesRequest.
Request message for VizierService.ListStudies.
Generated from protobuf message google.cloud.aiplatform.v1.ListStudiesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the Location to list the Study from. Format: |
↳ page_token |
string
Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. |
↳ page_size |
int
Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. |
getParent
Required. The resource name of the Location to list the Study from.
Format: projects/{project}/locations/{location}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource name of the Location to list the Study from.
Format: projects/{project}/locations/{location}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Optional. A page token to request the next page of results.
If unspecified, there are no subsequent pages.
Generated from protobuf field string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. A page token to request the next page of results.
If unspecified, there are no subsequent pages.
Generated from protobuf field string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. The maximum number of studies to return per "page" of results.
If unspecified, service will pick an appropriate default.
Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. The maximum number of studies to return per "page" of results.
If unspecified, service will pick an appropriate default.
Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |