Class ExplainStats (3.35.1)

Version latest

• 3.35.1 (latest)
• 3.33.4
• 3.32.2
• 3.31.9
• 3.30.11
• 3.28.0
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public final class ExplainStats

A wrapper object to access explain stats if explain or analyze was enabled for the Pipeline query execution.

Inheritance

java.lang.Object > ExplainStats

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

getRawData()

public Any getRawData()

Returns the explain stats in an encoded proto format, as returned from the Firestore backend. The caller is responsible for unpacking this proto message.

Returns
Type	Description
Any

getText()

public String getText()

When explain stats were requested with outputFormat = 'text', this returns the explain stats string verbatim as returned from the Firestore backend.

If explain stats were requested with outputFormat = 'json', this returns the explain stats as stringified JSON, which was returned from the Firestore backend.

Returns
Type	Description
String