PropertygraphSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.neptunedata.model.PropertygraphSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PropertygraphSummary.Builder,PropertygraphSummary>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class PropertygraphSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PropertygraphSummary.Builder,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).

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PropertygraphSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PropertygraphSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PropertygraphSummary.Builder`	`builder()`
`List<String>`	`edgeLabels()` A list of the distinct edge labels in the graph.
`List<Map<String,Long>>`	`edgeProperties()` A list of the distinct edge properties in the graph, along with the count of edges where each property is used.
`List<EdgeStructure>`	`edgeStructures()` This field is only present when the requested mode is `DETAILED`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEdgeLabels()` For responses, this returns true if the service returned a value for the EdgeLabels property.
`boolean`	`hasEdgeProperties()` For responses, this returns true if the service returned a value for the EdgeProperties property.
`boolean`	`hasEdgeStructures()` For responses, this returns true if the service returned a value for the EdgeStructures property.
`int`	`hashCode()`
`boolean`	`hasNodeLabels()` For responses, this returns true if the service returned a value for the NodeLabels property.
`boolean`	`hasNodeProperties()` For responses, this returns true if the service returned a value for the NodeProperties property.
`boolean`	`hasNodeStructures()` For responses, this returns true if the service returned a value for the NodeStructures property.
`List<String>`	`nodeLabels()` A list of the distinct node labels in the graph.
`List<Map<String,Long>>`	`nodeProperties()` The number of distinct node properties in the graph.
`List<NodeStructure>`	`nodeStructures()` This field is only present when the requested mode is `DETAILED`.
`Long`	`numEdgeLabels()` The number of distinct edge labels in the graph.
`Long`	`numEdgeProperties()` The number of distinct edge properties in the graph.
`Long`	`numEdges()` The number of edges in the graph.
`Long`	`numNodeLabels()` The number of distinct node labels in the graph.
`Long`	`numNodeProperties()` A list of the distinct node properties in the graph, along with the count of nodes where each property is used.
`Long`	`numNodes()` The number of nodes in the graph.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PropertygraphSummary.Builder>`	`serializableBuilderClass()`
`PropertygraphSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Long`	`totalEdgePropertyValues()` The total number of usages of all edge properties.
`Long`	`totalNodePropertyValues()` The total number of usages of all node properties.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - numNodes
```
public final Long numNodes()
```
    The number of nodes in the graph.
    
    Returns:
    
    The number of nodes in the graph.
  - numEdges
```
public final Long numEdges()
```
    The number of edges in the graph.
    
    Returns:
    
    The number of edges in the graph.
  - numNodeLabels
```
public final Long numNodeLabels()
```
    The number of distinct node labels in the graph.
    
    Returns:
    
    The number of distinct node labels in the graph.
  - numEdgeLabels
```
public final Long numEdgeLabels()
```
    The number of distinct edge labels in the graph.
    
    Returns:
    
    The number of distinct edge labels in the graph.
  - hasNodeLabels
```
public final boolean hasNodeLabels()
```
    For responses, this returns true if the service returned a value for the NodeLabels property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - nodeLabels
```
public final List<String> nodeLabels()
```
    A list of the distinct node labels in the graph.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNodeLabels() method.
    
    Returns:
    
    A list of the distinct node labels in the graph.
  - hasEdgeLabels
```
public final boolean hasEdgeLabels()
```
    For responses, this returns true if the service returned a value for the EdgeLabels property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - edgeLabels
```
public final List<String> edgeLabels()
```
    A list of the distinct edge labels in the graph.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEdgeLabels() method.
    
    Returns:
    
    A list of the distinct edge labels in the graph.
  - numNodeProperties
```
public final Long numNodeProperties()
```
    A list of the distinct node properties in the graph, along with the count of nodes where each property is used.
    
    Returns:
    
    A list of the distinct node properties in the graph, along with the count of nodes where each property is used.
  - numEdgeProperties
```
public final Long numEdgeProperties()
```
    The number of distinct edge properties in the graph.
    
    Returns:
    
    The number of distinct edge properties in the graph.
  - hasNodeProperties
```
public final boolean hasNodeProperties()
```
    For responses, this returns true if the service returned a value for the NodeProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - nodeProperties
```
public final List<Map<String,Long>> nodeProperties()
```
    The number of distinct node properties in the graph.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNodeProperties() method.
    
    Returns:
    
    The number of distinct node properties in the graph.
  - hasEdgeProperties
```
public final boolean hasEdgeProperties()
```
    For responses, this returns true if the service returned a value for the EdgeProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - edgeProperties
```
public final List<Map<String,Long>> edgeProperties()
```
    A list of the distinct edge properties in the graph, along with the count of edges where each property is used.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEdgeProperties() method.
    
    Returns:
    
    A list of the distinct edge properties in the graph, along with the count of edges where each property is used.
  - totalNodePropertyValues
```
public final Long totalNodePropertyValues()
```
    The total number of usages of all node properties.
    
    Returns:
    
    The total number of usages of all node properties.
  - totalEdgePropertyValues
```
public final Long totalEdgePropertyValues()
```
    The total number of usages of all edge properties.
    
    Returns:
    
    The total number of usages of all edge properties.
  - hasNodeStructures
```
public final boolean hasNodeStructures()
```
    For responses, this returns true if the service returned a value for the NodeStructures property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - nodeStructures
```
public final List<NodeStructure> nodeStructures()
```
    This field is only present when the requested mode is DETAILED. It contains a list of node structures.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNodeStructures() method.
    
    Returns:
    
    This field is only present when the requested mode is DETAILED. It contains a list of node structures.
  - hasEdgeStructures
```
public final boolean hasEdgeStructures()
```
    For responses, this returns true if the service returned a value for the EdgeStructures property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - edgeStructures
```
public final List<EdgeStructure> edgeStructures()
```
    This field is only present when the requested mode is DETAILED. It contains a list of edge structures.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEdgeStructures() method.
    
    Returns:
    
    This field is only present when the requested mode is DETAILED. It contains a list of edge structures.
  - toBuilder
```
public PropertygraphSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PropertygraphSummary.Builder,PropertygraphSummary>
  - builder
```
public static PropertygraphSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PropertygraphSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PropertygraphSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

numNodes

numEdges

numNodeLabels

numEdgeLabels

hasNodeLabels

nodeLabels

hasEdgeLabels

edgeLabels

numNodeProperties

numEdgeProperties

hasNodeProperties

nodeProperties

hasEdgeProperties

edgeProperties

totalNodePropertyValues

totalEdgePropertyValues

hasNodeStructures

nodeStructures

hasEdgeStructures

edgeStructures

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields