neptunedata/aws.sdk.kotlin.services.neptunedata.model/PropertygraphSummary

PropertygraphSummary

The graph summary API returns a read-only list of node and edge labels and property keys, along with counts of nodes, edges, and properties. See Graph summary response for a property graph (PG).

Types

Builder

class Builder

Companion

object Companion

Properties

edgeLabels

val edgeLabels: List<String>?

A list of the distinct edge labels in the graph.

edgeProperties

val edgeProperties: List<Map<String, Long>>?

A list of the distinct edge properties in the graph, along with the count of edges where each property is used.

edgeStructures

val edgeStructures: List<EdgeStructure>?

This field is only present when the requested mode is DETAILED. It contains a list of edge structures.

nodeLabels

val nodeLabels: List<String>?

A list of the distinct node labels in the graph.

nodeProperties

val nodeProperties: List<Map<String, Long>>?

The number of distinct node properties in the graph.

nodeStructures

val nodeStructures: List<NodeStructure>?

This field is only present when the requested mode is DETAILED. It contains a list of node structures.

numEdgeLabels

val numEdgeLabels: Long?

The number of distinct edge labels in the graph.

numEdgeProperties

val numEdgeProperties: Long?

The number of distinct edge properties in the graph.

numEdges

val numEdges: Long?

The number of edges in the graph.

numNodeLabels

val numNodeLabels: Long?

The number of distinct node labels in the graph.

numNodeProperties

val numNodeProperties: Long?

A list of the distinct node properties in the graph, along with the count of nodes where each property is used.

numNodes

val numNodes: Long?

The number of nodes in the graph.

totalEdgePropertyValues

val totalEdgePropertyValues: Long?

The total number of usages of all edge properties.

totalNodePropertyValues

val totalNodePropertyValues: Long?

The total number of usages of all node properties.

Functions

copy

inline fun copy(block: PropertygraphSummary.Builder.() -> Unit = {}): PropertygraphSummary

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String