Class: Google::Cloud::AIPlatform::V1::Dataset

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

Overview

A collection of DataItems and Annotations on them.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Dataset was created.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_item_count ⇒ ::Integer (readonly)

Returns Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.

Returns:

  • (::Integer) —

    Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns The description of the Dataset.

Returns:

  • (::String) —

    The description of the Dataset.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

Returns Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String) —

    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The labels with user-defined metadata to organize your Datasets.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

  • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The labels with user-defined metadata to organize your Datasets.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

    • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.


106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metadata ⇒ ::Google::Protobuf::Value

Returns Required. Additional information about the Dataset.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metadata_artifact ⇒ ::String (readonly)

Returns Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.

Returns:

  • (::String) —

    Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metadata_schema_uri ⇒ ::String

Returns Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

Returns:

  • (::String) —

    Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model_reference ⇒ ::String

Returns Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.

Returns:

  • (::String) —

    Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Identifier. The resource name of the Dataset.

Returns:

  • (::String) —

    Output only. Identifier. The resource name of the Dataset.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#saved_queries ⇒ ::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>

Returns All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

Returns:

  • (::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>) —

    All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Dataset was last updated.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 106

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end