Class ProjectsResource.LocationsResource.SchedulesResource.ListRequest
Lists Schedules in a Location.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class ProjectsResource.LocationsResource.SchedulesResource.ListRequest : AiplatformBaseServiceRequest<GoogleCloudAiplatformV1ListSchedulesResponse>, IClientServiceRequest<GoogleCloudAiplatformV1ListSchedulesResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
Filter
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 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:*
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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 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
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type | Description |
---|---|
string |
PageSize
The standard list page size. Default to 100 if not specified.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
Required. The resource name of the Location to list the Schedules from. Format:
projects/{project}/locations/{location}
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()