Package com.google.cloud.aiplatform.v1beta1

Class ListBatchPredictionJobsRequest

  • All Implemented Interfaces:
    ListBatchPredictionJobsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListBatchPredictionJobsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListBatchPredictionJobsRequestOrBuilder
     Request message for
 [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs].
    Protobuf type google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsRequest
    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 BatchPredictionJobs
 from. Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListBatchPredictionJobsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

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

      • getFilter

        public String getFilter()
         The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `model_display_name` supports `=`, `!=` comparisons.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
        string filter = 2;
        Specified by:
        getFilter in interface ListBatchPredictionJobsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `model_display_name` supports `=`, `!=` comparisons.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
        string filter = 2;
        Specified by:
        getFilterBytes in interface ListBatchPredictionJobsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageToken

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

      • getPageTokenBytes

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

      • getReadMask

        public com.google.protobuf.FieldMask getReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;
        Specified by:
        getReadMask in interface ListBatchPredictionJobsRequestOrBuilder
        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 ListBatchPredictionJobsRequest parseFrom​(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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