Package com.google.cloud.aiplatform.v1

Class ListPipelineJobsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.ListPipelineJobsRequest
All Implemented Interfaces:
ListPipelineJobsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListPipelineJobsRequest extends com.google.protobuf.GeneratedMessage implements ListPipelineJobsRequestOrBuilder
 Request message for
 [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs].
Protobuf type google.cloud.aiplatform.v1.ListPipelineJobsRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListPipelineJobsRequest.Builder
    Request message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    ORDER_BY_FIELD_NUMBER
     
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    PARENT_FIELD_NUMBER
     
    static final int
    READ_MASK_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ListPipelineJobsRequest
    getDefaultInstance()
     
    ListPipelineJobsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFilter()
    Lists the PipelineJobs that match the filter expression.
    com.google.protobuf.ByteString
    getFilterBytes()
    Lists the PipelineJobs that match the filter expression.
    String
    getOrderBy()
    A comma-separated list of fields to order by.
    com.google.protobuf.ByteString
    getOrderByBytes()
    A comma-separated list of fields to order by.
    int
    getPageSize()
    The standard list page size.
    String
    getPageToken()
    The standard list page token.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    The standard list page token.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<ListPipelineJobsRequest>
    getParserForType()
     
    com.google.protobuf.FieldMask
    getReadMask()
    Mask specifying which fields to read.
    com.google.protobuf.FieldMaskOrBuilder
    getReadMaskOrBuilder()
    Mask specifying which fields to read.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasReadMask()
    Mask specifying which fields to read.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListPipelineJobsRequest.Builder
    newBuilder()
     
    static ListPipelineJobsRequest.Builder
    newBuilder(ListPipelineJobsRequest prototype)
     
    ListPipelineJobsRequest.Builder
    newBuilderForType()
     
    protected ListPipelineJobsRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ListPipelineJobsRequest
    parseDelimitedFrom(InputStream input)
     
    static ListPipelineJobsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPipelineJobsRequest
    parseFrom(byte[] data)
     
    static ListPipelineJobsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPipelineJobsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListPipelineJobsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPipelineJobsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListPipelineJobsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPipelineJobsRequest
    parseFrom(InputStream input)
     
    static ListPipelineJobsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPipelineJobsRequest
    parseFrom(ByteBuffer data)
     
    static ListPipelineJobsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListPipelineJobsRequest>
    parser()
     
    ListPipelineJobsRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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.

    • getPageSize

      public int getPageSize()
       The standard list page size.
      int32 page_size = 3;
      Specified by:
      getPageSize in interface ListPipelineJobsRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       The standard list page token.
 Typically obtained via
 [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token]
 of the previous
 [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.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.v1.ListPipelineJobsResponse.next_page_token]
 of the previous
 [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.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.

    • getReadMaskOrBuilder

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

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static ListPipelineJobsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListPipelineJobsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListPipelineJobsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListPipelineJobsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListPipelineJobsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListPipelineJobsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static ListPipelineJobsRequest.Builder newBuilder()

    • newBuilder

      public static ListPipelineJobsRequest.Builder newBuilder(ListPipelineJobsRequest prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListPipelineJobsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListPipelineJobsRequest> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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