Skip to main content

MakeLiteralForStructuredDataSet

No overview available.

def MakeLiteralForStructuredDataSet(
path: storage.DataReference,
columns: []*core.StructuredDatasetType_DatasetColumn,
format: string
) - > *core.Literal

Constructs a Literal object representing a structured dataset. This function is used to encapsulate the URI, column definitions, and format of a structured dataset within a Literal for API communication or data serialization.

Parameters

NameTypeDescription
pathstorage.DataReferenceThe data reference (URI) pointing to the location of the structured dataset.
columns[]*core.StructuredDatasetType_DatasetColumnA slice of column definitions for the structured dataset, specifying names, types, and other metadata for each column.
formatstringThe format of the structured dataset (e.g., 'csv', 'parquet'), indicating how the data is stored and should be interpreted.

Returns

TypeDescription
*core.LiteralA pointer to a core.Literal object containing the structured dataset's URI, column metadata, and format.