Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

A collection of DataItems and Annotations on them.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Dataset

Returns a new instance of GoogleCloudAiplatformV1beta1Dataset.



4829
4830
4831
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4829

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp when this Dataset was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4737
4738
4739
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4737

def create_time
  @create_time
end

#data_item_count ⇒ Fixnum

Output only. The number of DataItems in this Dataset. Only apply for non- structured Dataset. Corresponds to the JSON property dataItemCount

Returns:

  • (Fixnum) 


4743
4744
4745
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4743

def data_item_count
  @data_item_count
end

#description ⇒ String

The description of the Dataset. Corresponds to the JSON property description

Returns:

  • (String) 


4748
4749
4750
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4748

def description
  @description
end

#display_name ⇒ 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. Corresponds to the JSON property displayName

Returns:

  • (String) 


4754
4755
4756
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4754

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



4760
4761
4762
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4760

def encryption_spec
  @encryption_spec
end

#etag ⇒ String

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

Returns:

  • (String) 


4766
4767
4768
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4766

def etag
  @etag
end

#labels ⇒ Hash<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 title. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4780
4781
4782
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4780

def labels
  @labels
end

#metadata ⇒ Object

Required. Additional information about the Dataset. Corresponds to the JSON property metadata

Returns:

  • (Object) 


4785
4786
4787
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4785

def metadata
  @metadata
end

#metadata_artifact ⇒ 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`. Corresponds to the JSON propertymetadataArtifact`

Returns:

  • (String) 


4793
4794
4795
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4793

def metadata_artifact
  @metadata_artifact
end

#metadata_schema_uri ⇒ 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/. Corresponds to the JSON property metadataSchemaUri

Returns:

  • (String) 


4801
4802
4803
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4801

def metadata_schema_uri
  @metadata_schema_uri
end

#model_reference ⇒ String

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

Returns:

  • (String) 


4807
4808
4809
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4807

def model_reference
  @model_reference
end

#name ⇒ String

Output only. The resource name of the Dataset. Corresponds to the JSON property name

Returns:

  • (String) 


4812
4813
4814
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4812

def name
  @name
end

#saved_queries ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SavedQuery>

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. Corresponds to the JSON property savedQueries

Returns:



4822
4823
4824
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4822

def saved_queries
  @saved_queries
end

#update_time ⇒ String

Output only. Timestamp when this Dataset was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4827
4828
4829
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4827

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4834

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_item_count = args[:data_item_count] if args.key?(:data_item_count)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metadata_artifact = args[:metadata_artifact] if args.key?(:metadata_artifact)
  @metadata_schema_uri = args[:metadata_schema_uri] if args.key?(:metadata_schema_uri)
  @model_reference = args[:model_reference] if args.key?(:model_reference)
  @name = args[:name] if args.key?(:name)
  @saved_queries = args[:saved_queries] if args.key?(:saved_queries)
  @update_time = args[:update_time] if args.key?(:update_time)
end