Interface Relationship

interface Relationship {
    confidence?: number;
    createdTime: Date;
    dataSetId?: number;
    endTime?: Timestamp;
    externalId: string;
    labels?: ExternalId[];
    lastUpdatedTime: Date;
    sourceExternalId: string;
    sourceType: RelationshipResourceType;
    startTime?: Timestamp;
    targetExternalId: string;
    targetType: RelationshipResourceType;
}

Hierarchy (view full)

Properties

confidence? createdTime dataSetId? endTime? externalId labels? lastUpdatedTime sourceExternalId sourceType startTime? targetExternalId targetType

Properties

Optionalconfidence

confidence?: number

Confidence value of the existence of this relationship. Generated relationships should provide a realistic score on the likelihood of the existence of the relationship. Relationships without a confidence value can be interpreted at the discretion of each project.

createdTime

createdTime: Date

OptionaldataSetId

dataSetId?: number

The id of the dataset this relationship belongs to

OptionalendTime

endTime?: Timestamp

Time when the relationship became inactive. If there is no endTime, relationship is active from startTime until the present or any point in the future. If endTime and startTime are set, then endTime must be strictly greater than startTime

externalId

externalId: string

External id of the relationship, must be unique within the project

Optionallabels

labels?: ExternalId[]

A list of the labels associated with this resource item

lastUpdatedTime

lastUpdatedTime: Date

sourceExternalId

sourceExternalId: string

External id of the CDF resource that constitutes the relationship source

sourceType

sourceType: RelationshipResourceType

Enum: "asset" "timeSeries" "file" "event" "sequence". The CDF resource type of the relationship source. Must be one of the specified values.

OptionalstartTime

startTime?: Timestamp

Time when the relationship became active. If there is no startTime, relationship is active from the beginning of time until endTime.

targetExternalId

targetExternalId: string

External id of the CDF resource that constitutes the relationship target.

targetType

targetType: RelationshipResourceType

Enum: "asset" "timeSeries" "file" "event" "sequence". The CDF resource type of the relationship target. Must be one of the specified values.

Settings

Member Visibility

On This Page

Properties