Class: Google::Cloud::AIPlatform::V1::SearchDataItemsRequest

Inherits:

Object

Object
Google::Cloud::AIPlatform::V1::SearchDataItemsRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/aiplatform/v1/dataset_service.rb

Overview

Request message for DatasetService.SearchDataItems.

Defined Under Namespace

Classes: OrderByAnnotation

Instance Attribute Summary collapse

#annotation_filters ⇒ ::Array<::String>
An expression that specifies what Annotations will be returned per DataItem.
#annotations_filter ⇒ ::String deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#annotations_limit ⇒ ::Integer
If set, only up to this many of Annotations will be returned per DataItemView.
#data_item_filter ⇒ ::String
An expression for filtering the DataItem that will be returned.
#data_labeling_job ⇒ ::String
The resource name of a DataLabelingJob.
#dataset ⇒ ::String
Required.
#field_mask ⇒ ::Google::Protobuf::FieldMask
Mask specifying which fields of DataItemView to read.
#order_by ⇒ ::String deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#order_by_annotation ⇒ ::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation
Expression that allows ranking results based on annotation's property.
#order_by_data_item ⇒ ::String
A comma-separated list of data item fields to order by, sorted in ascending order.
#page_size ⇒ ::Integer
Requested page size.
#page_token ⇒ ::String
A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.
#saved_query ⇒ ::String deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.

Instance Attribute Details

#annotation_filters ⇒ `::Array<::String>`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#annotations_filter ⇒ `::String`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns An expression for filtering the Annotations that will be returned per DataItem.

annotation_spec_id - for = or !=.

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#annotations_limit ⇒ `::Integer`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_item_filter ⇒ `::String`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_labeling_job ⇒ `::String`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dataset ⇒ `::String`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#field_mask ⇒ `::Google::Protobuf::FieldMask`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_by ⇒ `::String`

Deprecated.

This field is deprecated and may be removed in the next major version update.

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

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_by_annotation ⇒ `::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_by_data_item ⇒ `::String`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_size ⇒ `::Integer`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_token ⇒ `::String`

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#saved_query ⇒ `::String`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns The resource name of a SavedQuery(annotation set in UI). Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query} All of the search will be done in the context of this SavedQuery.

# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

Class: Google::Cloud::AIPlatform::V1::SearchDataItemsRequest

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_filters ⇒ ::Array<::String>

#annotations_filter ⇒ ::String

#annotations_limit ⇒ ::Integer

#data_item_filter ⇒ ::String

#data_labeling_job ⇒ ::String

#dataset ⇒ ::String

#field_mask ⇒ ::Google::Protobuf::FieldMask

#order_by ⇒ ::String

#order_by_annotation ⇒ ::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation

#order_by_data_item ⇒ ::String

#page_size ⇒ ::Integer

#page_token ⇒ ::String

#saved_query ⇒ ::String

#annotation_filters ⇒ `::Array<::String>`

#annotations_filter ⇒ `::String`

#annotations_limit ⇒ `::Integer`

#data_item_filter ⇒ `::String`

#data_labeling_job ⇒ `::String`

#dataset ⇒ `::String`

#field_mask ⇒ `::Google::Protobuf::FieldMask`

#order_by ⇒ `::String`

#order_by_annotation ⇒ `::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation`

#order_by_data_item ⇒ `::String`

#page_size ⇒ `::Integer`

#page_token ⇒ `::String`

#saved_query ⇒ `::String`