Lists Schedules in a Location.
HTTP request
GET https://{service-endpoint}/v1/{parent}/schedules
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the Location to list the Schedules from. Format: |
Query parameters
Parameters | |
---|---|
filter |
Lists the Schedules that match the filter expression. The following fields are supported:
Filter expressions can be combined together using logical operators ( Examples:
|
pageSize |
The standard list page size. Default to 100 if not specified. |
pageToken |
The standard list page token. Typically obtained via |
orderBy |
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 orderBy fields provided. For example, using "createTime desc, endTime" 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 orderBy is not specified, it will order by default with createTime in descending order. Supported fields:
|
Request body
The request body must be empty.
Response body
Response message for ScheduleService.ListSchedules
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"schedules": [
{
object ( |
Fields | |
---|---|
schedules[] |
List of Schedules in the requested page. |
nextPageToken |
A token to retrieve the next page of results. Pass to |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
aiplatform.schedules.list
For more information, see the IAM documentation.