Class: Google::Cloud::AIPlatform::V1::ListArtifactsRequest

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

Overview

Request message for MetadataService.ListArtifacts.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following:

  • Attribute filtering: For example: display_name = "test". Supported fields include: name, display_name, uri, state, schema_title, create_time, and update_time. Time fields, such as create_time and update_time, require values specified in RFC-3339 format. For example: create_time = "2020-11-19T11:30:00-04:00"
  • Metadata field: To filter on metadata fields use traversal operation as follows: metadata.<field_name>.<type_value>. For example: metadata.field_1.number_value = 10.0
  • Context based filtering: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name in_context(<context-name>). For example: in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")

Each of the above supported filter types can be combined together using logical operators (AND & OR).

For example: display_name = "test" AND metadata.field1.bool_value = true.

Returns:

  • (::String) —

    Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following:

    • Attribute filtering: For example: display_name = "test". Supported fields include: name, display_name, uri, state, schema_title, create_time, and update_time. Time fields, such as create_time and update_time, require values specified in RFC-3339 format. For example: create_time = "2020-11-19T11:30:00-04:00"
    • Metadata field: To filter on metadata fields use traversal operation as follows: metadata.<field_name>.<type_value>. For example: metadata.field_1.number_value = 10.0
    • Context based filtering: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name in_context(<context-name>). For example: in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")

    Each of the above supported filter types can be combined together using logical operators (AND & OR).

    For example: display_name = "test" AND metadata.field1.bool_value = true.



212
213
214
215
 
# File 'proto_docs/google/cloud/aiplatform/v1/metadata_service.rb', line 212

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

#page_size ⇒ ::Integer

Returns The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

Returns:

  • (::Integer) —

    The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.



212
213
214
215
 
# File 'proto_docs/google/cloud/aiplatform/v1/metadata_service.rb', line 212

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

#page_token ⇒ ::String

Returns A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.).

Returns:

  • (::String) —

    A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page.

    When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)



212
213
214
215
 
# File 'proto_docs/google/cloud/aiplatform/v1/metadata_service.rb', line 212

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

#parent ⇒ ::String

Returns Required. The MetadataStore whose Artifacts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}.

Returns:

  • (::String) —

    Required. The MetadataStore whose Artifacts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}



212
213
214
215
 
# File 'proto_docs/google/cloud/aiplatform/v1/metadata_service.rb', line 212

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