Class ExplainOptions (2.22.0)

public class ExplainOptions

Model class for com.google.datastore.v1.ExplainOptions. Contains the explain options for the query. Analyze is set to 'false' by default.

Inheritance

Object > ExplainOptions

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)

Static Methods

newBuilder()

public static ExplainOptions.Builder newBuilder()

Returns
Type	Description
`ExplainOptions.Builder`

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
`o`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()

shouldAnalyze()

public boolean shouldAnalyze()

Returns whether analyze is set to true or false. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.

Returns
Type	Description
`boolean`

toPb()

public ExplainOptions toPb()

Returns
Type	Description
`ExplainOptions`