← Back to packages

Package intrinsic_proto.data.v1

Service DataAssets

Message DataAsset

Message DataAssetFilter

Message DataAssetList

Message FieldPathElement

Message GetDataAssetRequest

Message ListDataAssetMetadataRequest

Message ListDataAssetMetadataResponse

Message ListDataAssetsRequest

Message ListDataAssetsResponse

Message ReferencedData

Message ReferencedDataPath

Message StreamReferencedDataRequest

Message StreamReferencedDataResponse

Services

service DataAssets intrinsic/assets/data/proto/v1/data_assets.proto

Provides read-only access to Data assets within a solution.

Data assets can be installed and updated via InstalledAssets.

Streams the bytes referenced by ReferencedData in an installed Data asset.

Messages

message DataAsset intrinsic/assets/data/proto/v1/data_asset.proto

A processed, portable representation of a Data asset.

Field Type Description
1 metadata intrinsic_proto.assets.Metadata

Metadata about the asset, such as package, ID, release notes, etc.

2 data google.protobuf.Any

The Data asset payload.

ReferencedData contained in the proto must be portable within the context in which this asset will be used. E.g.: - file references should only be used if the DataAsset will only be consumed locally; - CAS IDs must be unambiguous and the corresponding CAS document accessible to any consumer.

3 file_descriptor_set google.protobuf.FileDescriptorSet

A complete descriptor for the data message type.

message DataAssetFilter intrinsic/assets/data/proto/v1/data_assets.proto

Used to filter responses from requests to list Data assets.

Field Type Description
1 proto_name optional string

Restrict results to Data assets of the specified fully qualified proto name (without leading dot and not a type URL). For example: "intrinsic_proto.data.v1.DataAsset".

message DataAssetList intrinsic/assets/data/proto/v1/data_asset.proto

Field Type Description
1 data_assets repeated intrinsic_proto.data.v1.DataAsset

message FieldPathElement (Nested in intrinsic_proto.data.v1.StreamReferencedDataRequest.ReferencedDataPath ) intrinsic/assets/data/proto/v1/data_assets.proto

A single element of the field path.

Field Type Description
1 field string

The name of the field to access.

oneof element
2 index int64

If the field is a list, the index of the element to access.

3 key string

If the field is a map, the key of the entry to access.

message GetDataAssetRequest intrinsic/assets/data/proto/v1/data_assets.proto

Field Type Description
1 id intrinsic_proto.assets.Id

The ID of the Data asset to retrieve.

message ListDataAssetMetadataRequest intrinsic/assets/data/proto/v1/data_assets.proto

Field Type Description
1 page_size int64

Maximum number of assets to return (fewer may be returned).

2 page_token string

A page token received from a previous ListDataAssetMetadata call. Provide this token to retrieve the next page of results.

3 strict_filter optional intrinsic_proto.data.v1.DataAssetFilter

Optional filter to apply to the query to retrieve a filtered list of assets.

message ListDataAssetMetadataResponse intrinsic/assets/data/proto/v1/data_assets.proto

Field Type Description
1 metadata repeated intrinsic_proto.assets.Metadata
2 next_page_token string

Pass this token to a subsequent list request to obtain the next page.

message ListDataAssetsRequest intrinsic/assets/data/proto/v1/data_assets.proto

Field Type Description
1 page_size int64

Maximum number of assets to return (fewer may be returned).

2 page_token string

A page token received from a previous ListDataAssets call. Provide this token to retrieve the next page of results.

3 strict_filter optional intrinsic_proto.data.v1.DataAssetFilter

Optional filter to apply to the query to retrieve a filtered list of assets.

message ListDataAssetsResponse intrinsic/assets/data/proto/v1/data_assets.proto

Field Type Description
1 data_assets repeated intrinsic_proto.data.v1.DataAsset
2 next_page_token string

Pass this token to a subsequent list request to obtain the next page.

message ReferencedData intrinsic/assets/data/proto/v1/referenced_data.proto

Data that may be stored either inline or elsewhere and only referenced here.

Field Type Description
4 digest string

An optional digest of the referenced data, prefixed with the hashing algorithm (e.g., "sha256:").

Can be used to ensure that the referenced data have not changed.

5 source_project optional string

If the ReferencedData references CAS data in an ambiguous context (e.g., releasing to the catalog a Data asset that references existing CAS data), then this field can be used to specify the target project for the reference.

The consumer of this reference must have access to the source project.

Not providing this value may be an error in contexts in which the target project is needed and not known otherwise.

oneof data
1 reference string

A reference to data stored elsewhere (e.g., as a file or in content-addressable storage [CAS]).

The value is a URI to the referenced data. Can be one of the following: - a CAS ID of the form "intcas://..."; - a file path of the form "file://..."; - a file path without protocol prefix, either absolute or relative.

If a relative file path is provided, then its base path must be unambiguous in the context in which this proto is used.

3 inlined bytes

The inlined data.

message ReferencedDataPath (Nested in intrinsic_proto.data.v1.StreamReferencedDataRequest ) intrinsic/assets/data/proto/v1/data_assets.proto

A path to a ReferencedData field within an installed Data asset proto.

Field Type Description
1 id intrinsic_proto.assets.Id

The ID of the installed Data asset that contains the referenced data.

2 field_path repeated intrinsic_proto.data.v1.StreamReferencedDataRequest.ReferencedDataPath.FieldPathElement

The path to the ReferencedData field within the installed Data asset proto.

For example, for the following Data asset proto:

message MyData {
  message ListOfData {
    repeated ReferencedData data_list = 1;
  }
  map<string,  ListOfData> data_map = 1;
}

The path to the 2nd data_list value within the data_map entry at key "foo" would be:

field_path { field: "data_map" key: "foo" }
field_path { field: "data_list" index: 1 }

If the Data asset proto is itself a ReferencedData value, then this path is empty.

message StreamReferencedDataRequest intrinsic/assets/data/proto/v1/data_assets.proto

Field Type Description
3 buffer_size optional int64

The maximum number of bytes to stream per response.

If omitted, the server will choose a sensible default value.

oneof reference
1 data intrinsic_proto.data.v1.ReferencedData

The ReferencedData whose data should be streamed.

File references are not valid.

2 path intrinsic_proto.data.v1.StreamReferencedDataRequest.ReferencedDataPath

The path to the ReferencedData field within an installed Data asset proto.

This option can be used to stream data from a Data asset without first retrieving the asset itself.

message StreamReferencedDataResponse intrinsic/assets/data/proto/v1/data_assets.proto

Field Type Description
1 chunk bytes

A chunk of data from the ReferencedData.

2 total_size int64

The total size of the referenced data.

3 offset int64

The offset of the chunk within the referenced data.