com.google.spanner.v1

Enum ExecuteSqlRequest.QueryMode

java.lang.Object

java.lang.Enum<ExecuteSqlRequest.QueryMode>

com.google.spanner.v1.ExecuteSqlRequest.QueryMode

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<ExecuteSqlRequest.QueryMode>

Enclosing class:

ExecuteSqlRequest

public static enum ExecuteSqlRequest.QueryMode
extends java.lang.Enum<ExecuteSqlRequest.QueryMode>
implements ProtocolMessageEnum

 Mode in which the query must be processed.
 

Protobuf enum google.spanner.v1.ExecuteSqlRequest.QueryMode

Enum Constant Summary

Enum Constants

Enum Constant and Description
NORMAL The default mode where only the query result, without any information about the query plan is returned.
PLAN This mode returns only the query plan, without any result rows or execution statistics information.
PROFILE This mode returns both the query plan and the execution statistics along with the result rows.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	NORMAL_VALUE The default mode where only the query result, without any information about the query plan is returned.
static int	PLAN_VALUE This mode returns only the query plan, without any result rows or execution statistics information.
static int	PROFILE_VALUE This mode returns both the query plan and the execution statistics along with the result rows.

Method Summary

Modifier and Type	Method and Description
static ExecuteSqlRequest.QueryMode	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
Descriptors.EnumValueDescriptor	getValueDescriptor()
static Internal.EnumLiteMap<ExecuteSqlRequest.QueryMode>	internalGetValueMap()
static ExecuteSqlRequest.QueryMode	valueOf(Descriptors.EnumValueDescriptor desc)
static ExecuteSqlRequest.QueryMode	valueOf(int value) Deprecated. Use forNumber(int) instead.
static ExecuteSqlRequest.QueryMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ExecuteSqlRequest.QueryMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final ExecuteSqlRequest.QueryMode NORMAL

 The default mode where only the query result, without any information
 about the query plan is returned.
 

NORMAL = 0;

PLAN

public static final ExecuteSqlRequest.QueryMode PLAN

 This mode returns only the query plan, without any result rows or
 execution statistics information.
 

PLAN = 1;

PROFILE

public static final ExecuteSqlRequest.QueryMode PROFILE

 This mode returns both the query plan and the execution statistics along
 with the result rows.
 

PROFILE = 2;

UNRECOGNIZED

public static final ExecuteSqlRequest.QueryMode UNRECOGNIZED

Field Detail

NORMAL_VALUE

public static final int NORMAL_VALUE

 The default mode where only the query result, without any information
 about the query plan is returned.
 

NORMAL = 0;

See Also:

Constant Field Values

PLAN_VALUE

public static final int PLAN_VALUE

 This mode returns only the query plan, without any result rows or
 execution statistics information.
 

PLAN = 1;

See Also:

Constant Field Values

PROFILE_VALUE

public static final int PROFILE_VALUE

 This mode returns both the query plan and the execution statistics along
 with the result rows.
 

PROFILE = 2;

See Also:

Constant Field Values

Method Detail

values

public static ExecuteSqlRequest.QueryMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExecuteSqlRequest.QueryMode c : ExecuteSqlRequest.QueryMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExecuteSqlRequest.QueryMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static ExecuteSqlRequest.QueryMode valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static ExecuteSqlRequest.QueryMode forNumber(int value)

internalGetValueMap

public static Internal.EnumLiteMap<ExecuteSqlRequest.QueryMode> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static ExecuteSqlRequest.QueryMode valueOf(Descriptors.EnumValueDescriptor desc)