Class QueryParameter (0.21.0)

public final class QueryParameter extends GeneratedMessage implements QueryParameterOrBuilder

A query parameter message represents a parameter that can be used to parameterize a SQL query.

Protobuf type google.cloud.geminidataanalytics.v1.QueryParameter

Static Fields

DATA_TYPE_FIELD_NUMBER

public static final int DATA_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryParameter getDefaultInstance()
Returns
Type Description
QueryParameter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static QueryParameter.Builder newBuilder()
Returns
Type Description
QueryParameter.Builder

newBuilder(QueryParameter prototype)

public static QueryParameter.Builder newBuilder(QueryParameter prototype)
Parameter
Name Description
prototype QueryParameter
Returns
Type Description
QueryParameter.Builder

parseDelimitedFrom(InputStream input)

public static QueryParameter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryParameter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameter
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QueryParameter parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QueryParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueryParameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueryParameter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QueryParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueryParameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueryParameter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueryParameter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameter
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QueryParameter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryParameter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameter
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QueryParameter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueryParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueryParameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameter
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QueryParameter> parser()
Returns
Type Description
Parser<QueryParameter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDataType()

public String getDataType()

Required. The data type of the parameter, e.g. "STRING", "INT64", "DATE", etc. For valid values, see the BigQuery documentation. This will be used to populate google.cloud.bigquery.v2.QueryParameterType.type.

string data_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The dataType.

getDataTypeBytes()

public ByteString getDataTypeBytes()

Required. The data type of the parameter, e.g. "STRING", "INT64", "DATE", etc. For valid values, see the BigQuery documentation. This will be used to populate google.cloud.bigquery.v2.QueryParameterType.type.

string data_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for dataType.

getDefaultInstanceForType()

public QueryParameter getDefaultInstanceForType()
Returns
Type Description
QueryParameter

getDescription()

public String getDescription()

Optional. The description of the parameter that can be used by LLM to extract the parameter value from the user question.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the parameter that can be used by LLM to extract the parameter value from the user question.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getName()

public String getName()

Required. The name of the parameter reference in the SQL query.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the parameter reference in the SQL query.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<QueryParameter> getParserForType()
Returns
Type Description
Parser<QueryParameter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public QueryParameter.Builder newBuilderForType()
Returns
Type Description
QueryParameter.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected QueryParameter.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueryParameter.Builder
Overrides

toBuilder()

public QueryParameter.Builder toBuilder()
Returns
Type Description
QueryParameter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException