Class: Aws::Neptunedata::Types::PropertygraphSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-neptunedata/types.rb

Overview

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)].

[1]: docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#edge_labels ⇒ Array<String>

A list of the distinct edge labels in the graph.

Returns:

  • (Array<String>) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#edge_properties ⇒ Array<Hash<String,Integer>>

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

Returns:

  • (Array<Hash<String,Integer>>) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#edge_structures ⇒ Array<Types::EdgeStructure>

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

Returns:



2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#node_labels ⇒ Array<String>

A list of the distinct node labels in the graph.

Returns:

  • (Array<String>) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#node_properties ⇒ Array<Hash<String,Integer>>

The number of distinct node properties in the graph.

Returns:

  • (Array<Hash<String,Integer>>) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#node_structures ⇒ Array<Types::NodeStructure>

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

Returns:



2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#num_edge_labels ⇒ Integer

The number of distinct edge labels in the graph.

Returns:

  • (Integer) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#num_edge_properties ⇒ Integer

The number of distinct edge properties in the graph.

Returns:

  • (Integer) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#num_edges ⇒ Integer

The number of edges in the graph.

Returns:

  • (Integer) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#num_node_labels ⇒ Integer

The number of distinct node labels in the graph.

Returns:

  • (Integer) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#num_node_properties ⇒ Integer

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

Returns:

  • (Integer) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#num_nodes ⇒ Integer

The number of nodes in the graph.

Returns:

  • (Integer) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#total_edge_property_values ⇒ Integer

The total number of usages of all edge properties.

Returns:

  • (Integer) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end

#total_node_property_values ⇒ Integer

The total number of usages of all node properties.

Returns:

  • (Integer) 


2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/aws-sdk-neptunedata/types.rb', line 2641

class PropertygraphSummary < Struct.new(
  :num_nodes,
  :num_edges,
  :num_node_labels,
  :num_edge_labels,
  :node_labels,
  :edge_labels,
  :num_node_properties,
  :num_edge_properties,
  :node_properties,
  :edge_properties,
  :total_node_property_values,
  :total_edge_property_values,
  :node_structures,
  :edge_structures)
  SENSITIVE = []
  include Aws::Structure
end