Package com.google.cloud.aiplatform.v1beta1

Class ListPipelineJobsRequest

  • All Implemented Interfaces:
    ListPipelineJobsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListPipelineJobsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListPipelineJobsRequestOrBuilder
     Request message for
 [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs].
    Protobuf type google.cloud.aiplatform.v1beta1.ListPipelineJobsRequest
    See Also:
    Serialized Form

    • 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 PipelineJobs from.
 Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListPipelineJobsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

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

      • getFilter

        public String getFilter()
         Lists the PipelineJobs that match the filter expression. The following
 fields are supported:

 * `pipeline_name`: Supports `=` and `!=` comparisons.
 * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
 * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
   for example, can check if pipeline's display_name contains *step* by
   doing display_name:\"*step*\"
 * `state`: Supports `=` and `!=` comparisons.
 * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `labels`: Supports key-value equality and key presence.
 * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
 * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
   wildcard.

 Filter expressions can be combined together using logical operators
 (`AND` & `OR`).
 For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`.

 The syntax to define filter expression is based on
 https://google.aip.dev/160.

 Examples:

 * `create_time>"2021-05-18T00:00:00Z" OR
   update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated
   after 2020-05-18 00:00:00 UTC.
 * `labels.env = "prod"`
   PipelineJobs with label "env" set to "prod".
        string filter = 2;
        Specified by:
        getFilter in interface ListPipelineJobsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Lists the PipelineJobs that match the filter expression. The following
 fields are supported:

 * `pipeline_name`: Supports `=` and `!=` comparisons.
 * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
 * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
   for example, can check if pipeline's display_name contains *step* by
   doing display_name:\"*step*\"
 * `state`: Supports `=` and `!=` comparisons.
 * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
   Values must be in RFC 3339 format.
 * `labels`: Supports key-value equality and key presence.
 * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
 * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
   wildcard.

 Filter expressions can be combined together using logical operators
 (`AND` & `OR`).
 For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`.

 The syntax to define filter expression is based on
 https://google.aip.dev/160.

 Examples:

 * `create_time>"2021-05-18T00:00:00Z" OR
   update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated
   after 2020-05-18 00:00:00 UTC.
 * `labels.env = "prod"`
   PipelineJobs with label "env" set to "prod".
        string filter = 2;
        Specified by:
        getFilterBytes in interface ListPipelineJobsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageToken

        public String getPageToken()
         The standard list page token.
 Typically obtained via
 [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token]
 of the previous
 [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]
 call.
        string page_token = 4;
        Specified by:
        getPageToken in interface ListPipelineJobsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The standard list page token.
 Typically obtained via
 [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token]
 of the previous
 [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]
 call.
        string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ListPipelineJobsRequestOrBuilder
        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 e.g. "create_time desc, end_time",
 "end_time, start_time, update_time" For example, using "create_time desc,
 end_time" will order results by create time in descending order, and if
 there are multiple jobs 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 order is create time in descending order. Supported fields:

   * `create_time`
   * `update_time`
   * `end_time`
   * `start_time`
        string order_by = 6;
        Specified by:
        getOrderBy in interface ListPipelineJobsRequestOrBuilder
        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 e.g. "create_time desc, end_time",
 "end_time, start_time, update_time" For example, using "create_time desc,
 end_time" will order results by create time in descending order, and if
 there are multiple jobs 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 order is create time in descending order. Supported fields:

   * `create_time`
   * `update_time`
   * `end_time`
   * `start_time`
        string order_by = 6;
        Specified by:
        getOrderByBytes in interface ListPipelineJobsRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • hasReadMask

        public boolean hasReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 7;
        Specified by:
        hasReadMask in interface ListPipelineJobsRequestOrBuilder
        Returns:
        Whether the readMask field is set.

      • getReadMask

        public com.google.protobuf.FieldMask getReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 7;
        Specified by:
        getReadMask in interface ListPipelineJobsRequestOrBuilder
        Returns:
        The readMask.

      • 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 ListPipelineJobsRequest parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ListPipelineJobsRequest> 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 ListPipelineJobsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder