• Getting started on Cube and Floe development
  • OpenEye Orion Platform Packages Reference
    • Orion Platform API
    • Floe API
    • DataRecord API
    • DRConvert API
    • Orion Client API
      • Quick Start
      • Orion Client Examples
      • Orion Client Session
      • Orion Client Utilities
      • Orion Client Helpers
      • Orion Client Types
      • Orion Client Links
      • Orion CLI
      • Release Notes
    • Artemis API
  • OpenEye Orion Cubes and Floes Packages
  • Legal Notices
Orion Programming Guide
  • Docs »
  • Orion Packages API Reference »
  • Orion Client API »
  • Orion Client Links

Orion Client Links¶

Orion Type Link¶

class orionclient.links.OrionLink(resource)¶
get_orion_resource()¶

Retrieves the Orion Resource that indicates the base Orion resource that the linked resource is stored in.

Record Type Link¶

class orionclient.links.RecordLink(resource, record_id, field_name=None)¶
get_field(include_meta=True)¶

Retrieves the OEField associated with the link

Returns:OEField
Raises:OrionLinkError – If link does not contain a field name
get_orion_resource()¶

Retrieves the Orion Resource that indicates the base Orion resource that the linked resource is stored in.

get_record()¶

Retrieves the record that the link is associated with

Returns:Record
Return type:OEMolRecord
Raises:OrionLinkError – If unable to find the specified record

Shard Type Link¶

class orionclient.links.ShardLink(resource, shard_id)¶
get_orion_resource()¶

Retrieves the Orion Resource that indicates the base Orion resource that the linked resource is stored in.

get_shard()¶

Retrieve the shard associated with the link.

Returns:Shard
Raises:OrionLinkError – Unable to find specified shard
Next Previous

© Copyright 2020, OpenEye Scientific Software Inc. Last updated on Sep 06, 2020.