final case class PlanNode(index: Int = 0, kind: Kind = ..., displayName: String = "", childLinks: Seq[ChildLink] = _root_.scala.Seq.empty, shortRepresentation: Option[ShortRepresentation] = _root_.scala.None, metadata: Option[Struct] = _root_.scala.None, executionStats: Option[Struct] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PlanNode] with Product with Serializable

Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].

index

The PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes].

kind

Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

displayName

The display name for the node.

childLinks

List of child node indexes and their relationship to this parent.

shortRepresentation

Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.

metadata

Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }

executionStats

The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[PlanNode], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlanNode
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PlanNode(index: Int = 0, kind: Kind = ..., displayName: String = "", childLinks: Seq[ChildLink] = _root_.scala.Seq.empty, shortRepresentation: Option[ShortRepresentation] = _root_.scala.None, metadata: Option[Struct] = _root_.scala.None, executionStats: Option[Struct] = _root_.scala.None, unknownFields: UnknownFieldSet = ...)

    index

    The PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes].

    kind

    Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

    displayName

    The display name for the node.

    childLinks

    List of child node indexes and their relationship to this parent.

    shortRepresentation

    Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.

    metadata

    Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }

    executionStats

    The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllChildLinks(__vs: Iterable[ChildLink]): PlanNode
  5. def addChildLinks(__vs: ChildLink*): PlanNode
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val childLinks: Seq[ChildLink]
  8. def clearChildLinks: PlanNode
  9. def clearExecutionStats: PlanNode
  10. def clearMetadata: PlanNode
  11. def clearShortRepresentation: PlanNode
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  13. def companion: PlanNode.type
    Definition Classes
    PlanNode → GeneratedMessage
  14. def discardUnknownFields: PlanNode
  15. val displayName: String
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. val executionStats: Option[Struct]
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getExecutionStats: Struct
  21. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PlanNode → GeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PlanNode → GeneratedMessage
  23. def getMetadata: Struct
  24. def getShortRepresentation: ShortRepresentation
  25. val index: Int
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. val kind: Kind
  28. val metadata: Option[Struct]
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def serializedSize: Int
    Definition Classes
    PlanNode → GeneratedMessage
  33. val shortRepresentation: Option[ShortRepresentation]
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  36. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  37. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  38. def toProtoString: String
    Definition Classes
    PlanNode → GeneratedMessage
  39. val unknownFields: UnknownFieldSet
  40. def update(ms: (Lens[PlanNode, PlanNode]) ⇒ scalapb.lenses.Mutation[PlanNode]*): PlanNode
    Definition Classes
    Updatable
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  44. def withChildLinks(__v: Seq[ChildLink]): PlanNode
  45. def withDisplayName(__v: String): PlanNode
  46. def withExecutionStats(__v: Struct): PlanNode
  47. def withIndex(__v: Int): PlanNode
  48. def withKind(__v: Kind): PlanNode
  49. def withMetadata(__v: Struct): PlanNode
  50. def withShortRepresentation(__v: ShortRepresentation): PlanNode
  51. def withUnknownFields(__v: UnknownFieldSet): PlanNode
  52. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  53. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PlanNode → GeneratedMessage
  54. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[PlanNode]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped