Package com.google.cloud.aiplatform.v1

Class ListSchedulesRequest

  • All Implemented Interfaces:
    ListSchedulesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListSchedulesRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListSchedulesRequestOrBuilder
     Request message for
 [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules].
    Protobuf type google.cloud.aiplatform.v1.ListSchedulesRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListSchedulesRequest.Builder
      Request message for [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules].

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public String getParent()
         Required. The resource name of the Location to list the Schedules from.
 Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListSchedulesRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the Location to list the Schedules from.
 Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListSchedulesRequestOrBuilder
        Returns:
        The bytes for parent.

      • getFilter

        public String 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:*`
        string filter = 2;
        Specified by:
        getFilter in interface ListSchedulesRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         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:*`
        string filter = 2;
        Specified by:
        getFilterBytes in interface ListSchedulesRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageSize

        public int getPageSize()
         The standard list page size.
 Default to 100 if not specified.
        int32 page_size = 3;
        Specified by:
        getPageSize in interface ListSchedulesRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public String getPageToken()
         The standard list page token.
 Typically obtained via
 [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token]
 of the previous
 [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules]
 call.
        string page_token = 4;
        Specified by:
        getPageToken in interface ListSchedulesRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The standard list page token.
 Typically obtained via
 [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token]
 of the previous
 [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules]
 call.
        string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ListSchedulesRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getOrderBy

        public String 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`
        string order_by = 5;
        Specified by:
        getOrderBy in interface ListSchedulesRequestOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         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`
        string order_by = 5;
        Specified by:
        getOrderByBytes in interface ListSchedulesRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListSchedulesRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListSchedulesRequest parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListSchedulesRequest parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListSchedulesRequest parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListSchedulesRequest parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListSchedulesRequest parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ListSchedulesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListSchedulesRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListSchedulesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListSchedulesRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ListSchedulesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder