Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListSchedulesRequest.
Request message for ScheduleService.ListSchedules.
Generated from protobuf message google.cloud.aiplatform.v1.ListSchedulesRequest
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 Schedules from. Format: |
↳ filter |
string
Lists the Schedules that match the filter expression. The following fields are supported: * |
↳ page_size |
int
The standard list page size. Default to 100 if not specified. |
↳ page_token |
string
The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. |
↳ order_by |
string
A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * |
getParent
Required. The resource name of the Location to list the Schedules from.
Format: projects/{project}/locations/{location}
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The resource name of the Location to list the Schedules from.
Format: projects/{project}/locations/{location}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Lists the Schedules that match the filter expression. The following fields are supported:
display_name
: Supports=
,!=
comparisons, and:
wildcard.state
: Supports=
and!=
comparisons.request
: Supports existence of the <request_type> check. (e.g.create_pipeline_job_request:*
--> Schedule has create_pipeline_job_request).create_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format.start_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format.end_time
: Supports=
,!=
,<
,>
,<=
,>=
comparisons and:*
existence check. Values must be in RFC 3339 format.next_run_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (NOT
,AND
&OR
). The syntax to define filter expression is based on https://google.aip.dev/160. Examples:state="ACTIVE" AND display_name:"my_schedule_*"
NOT display_name="my_schedule"
create_time>"2021-05-18T00:00:00Z"
end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*
create_pipeline_job_request:*
Returns | |
---|---|
Type | Description |
string |
setFilter
Lists the Schedules that match the filter expression. The following fields are supported:
display_name
: Supports=
,!=
comparisons, and:
wildcard.state
: Supports=
and!=
comparisons.request
: Supports existence of the <request_type> check. (e.g.create_pipeline_job_request:*
--> Schedule has create_pipeline_job_request).create_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format.start_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format.end_time
: Supports=
,!=
,<
,>
,<=
,>=
comparisons and:*
existence check. Values must be in RFC 3339 format.next_run_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (NOT
,AND
&OR
). The syntax to define filter expression is based on https://google.aip.dev/160. Examples:state="ACTIVE" AND display_name:"my_schedule_*"
NOT display_name="my_schedule"
create_time>"2021-05-18T00:00:00Z"
end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*
create_pipeline_job_request:*
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
The standard list page size.
Default to 100 if not specified.
Returns | |
---|---|
Type | Description |
int |
setPageSize
The standard list page size.
Default to 100 if not specified.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
The standard list page token.
Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.
Returns | |
---|---|
Type | Description |
string |
setPageToken
The standard list page token.
Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided.
For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields:
create_time
start_time
end_time
next_run_time
Returns | |
---|---|
Type | Description |
string |
setOrderBy
A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided.
For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields:
create_time
start_time
end_time
next_run_time
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location to list the Schedules from.
Format: |
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\ListSchedulesRequest |