Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::Relation.
Defines the relationship between the entity (a) and another entity (b).
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#direction
def direction() -> ::Google::Backstory::Relation::Directionality
Returns
- (::Google::Backstory::Relation::Directionality) — Directionality of relationship between primary entity (a) and the related entity (b).
#direction=
def direction=(value) -> ::Google::Backstory::Relation::Directionality
Parameter
- value (::Google::Backstory::Relation::Directionality) — Directionality of relationship between primary entity (a) and the related entity (b).
Returns
- (::Google::Backstory::Relation::Directionality) — Directionality of relationship between primary entity (a) and the related entity (b).
#entity
def entity() -> ::Google::Backstory::Noun
Returns
- (::Google::Backstory::Noun) — Entity (b) that the primary entity (a) is related to.
#entity=
def entity=(value) -> ::Google::Backstory::Noun
Parameter
- value (::Google::Backstory::Noun) — Entity (b) that the primary entity (a) is related to.
Returns
- (::Google::Backstory::Noun) — Entity (b) that the primary entity (a) is related to.
#entity_label
def entity_label() -> ::Google::Backstory::Relation::EntityLabel
Returns
- (::Google::Backstory::Relation::EntityLabel) — Label to identify the Noun of the relation.
#entity_label=
def entity_label=(value) -> ::Google::Backstory::Relation::EntityLabel
Parameter
- value (::Google::Backstory::Relation::EntityLabel) — Label to identify the Noun of the relation.
Returns
- (::Google::Backstory::Relation::EntityLabel) — Label to identify the Noun of the relation.
#entity_type
def entity_type() -> ::Google::Backstory::EntityMetadata::EntityType
Returns
- (::Google::Backstory::EntityMetadata::EntityType) — Type of the related entity (b) in this relationship.
#entity_type=
def entity_type=(value) -> ::Google::Backstory::EntityMetadata::EntityType
Parameter
- value (::Google::Backstory::EntityMetadata::EntityType) — Type of the related entity (b) in this relationship.
Returns
- (::Google::Backstory::EntityMetadata::EntityType) — Type of the related entity (b) in this relationship.
#relationship
def relationship() -> ::Google::Backstory::Relation::Relationship
Returns
- (::Google::Backstory::Relation::Relationship) — Type of relationship.
#relationship=
def relationship=(value) -> ::Google::Backstory::Relation::Relationship
Parameter
- value (::Google::Backstory::Relation::Relationship) — Type of relationship.
Returns
- (::Google::Backstory::Relation::Relationship) — Type of relationship.
#uid
def uid() -> ::String
Returns
- (::String) — UID of the relationship.
#uid=
def uid=(value) -> ::String
Parameter
- value (::String) — UID of the relationship.
Returns
- (::String) — UID of the relationship.