Skip to main content
pub struct GetGraphEntitiesRequestOptions 
    pub entity_type: String,
    pub server_id: String,
    pub concise_edge_connectivity: String,
    pub include_weights: String,

Optional parameters for the /get/graph/entities endpoint.

Default::default() is the empty set: only options set explicitly are sent, and anything left empty falls back to the server’s own default.

Fields

entity_type: String

The type of entity to retrieve. Server default: edge.

server_id: String

Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. Server default: 0.

concise_edge_connectivity: String

When true, edges are emitted in a compact connectivity form regardless of the graph’s identifier type: entities_int contains stride-4 records [edge_id, node1_index, node2_index, edge_label_index] where node1_index/node2_index are 0-based positions into the node array (obtained from a node-entity call on the same graph). When requesting nodes with this option, the response includes tombstoned (deleted) slots in order to keep position indices stable so edge indices resolve correctly; deleted slots carry id=0 for integer graphs or an empty identifier for string/WKT graphs. For paginated node calls, subtract offset from an edge endpoint index to locate it within the returned page. Server default: false.

include_weights: String

When true and options entity_type is ‘edge’, the response entities_weight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entities_int or entities_string). Empty when the graph has no weights component or when requesting nodes. Server default: false.

Implementations

Converts the set (non-empty) options into the wire-format string map.

Trait Implementations

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source

fn fmt(&self, f: &mut Formatter<’_>) -> Result

Formats the value using the given formatter. Read more