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
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__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}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the Location to list the Study from.
Format: projects/{project}/locations/{location}
| 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token to request the next page of results.
If unspecified, there are no subsequent pages.
| 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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the Location to list the Study from.
Format: |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\ListStudiesRequest |
|