Class: Google::Cloud::AIPlatform::V1::ListDataLabelingJobsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/job_service.rb

Overview

Request message for JobService.ListDataLabelingJobs.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns The standard list filter.

Supported fields:

  • display_name supports =, != comparisons, and : wildcard.
  • 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:*.

Returns:

  • (::String) —

    The standard list filter.

    Supported fields:

    • display_name supports =, != comparisons, and : wildcard.
    • 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:*


208
209
210
211
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 208

class ListDataLabelingJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

Returns:

  • (::String) —

    A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.



208
209
210
211
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 208

class ListDataLabelingJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns The standard list page size.

Returns:

  • (::Integer) —

    The standard list page size.



208
209
210
211
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 208

class ListDataLabelingJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns The standard list page token.

Returns:

  • (::String) —

    The standard list page token.



208
209
210
211
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 208

class ListDataLabelingJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}.

Returns:

  • (::String) —

    Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}



208
209
210
211
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 208

class ListDataLabelingJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_mask ⇒ ::Google::Protobuf::FieldMask

Returns Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

Returns:

  • (::Google::Protobuf::FieldMask) —

    Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.



208
209
210
211
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 208

class ListDataLabelingJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end