Google Bigtable v2 API - Class PrepareQueryRequest (3.16.0)

public sealed class PrepareQueryRequest : IMessage<PrepareQueryRequest>, IEquatable<PrepareQueryRequest>, IDeepCloneable<PrepareQueryRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Bigtable v2 API class PrepareQueryRequest.

Request message for Bigtable.PrepareQuery

Inheritance

object > PrepareQueryRequest

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

PrepareQueryRequest()

public PrepareQueryRequest()

PrepareQueryRequest(PrepareQueryRequest)

public PrepareQueryRequest(PrepareQueryRequest other)
Parameter
Name Description
other PrepareQueryRequest

Properties

AppProfileId

public string AppProfileId { get; set; }

Optional. This value specifies routing for preparing the query. Note that this app_profile_id is only used for preparing the query. The actual query execution will use the app profile specified in the ExecuteQueryRequest. If not specified, the default application profile will be used.

Property Value
Type Description
string

DataFormatCase

public PrepareQueryRequest.DataFormatOneofCase DataFormatCase { get; }
Property Value
Type Description
PrepareQueryRequestDataFormatOneofCase

InstanceName

public string InstanceName { get; set; }

Required. The unique name of the instance against which the query should be executed. Values are of the form projects/<project>/instances/<instance>

Property Value
Type Description
string

InstanceNameAsInstanceName

public InstanceName InstanceNameAsInstanceName { get; set; }

InstanceName-typed view over the InstanceName resource name property.

Property Value
Type Description
InstanceName

ParamTypes

public MapField<string, Type> ParamTypes { get; }

Required. param_types is a map of parameter identifier strings to their Types.

In query string, a parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName) in the query string.

For example, if param_types["firstName"] = Bytes then @firstName will be a query parameter of type Bytes. The specific Value to be used for the query execution must be sent in ExecuteQueryRequest in the params map.

Property Value
Type Description
MapFieldstringType

ProtoFormat

public ProtoFormat ProtoFormat { get; set; }

Protocol buffer format as described by ProtoSchema and ProtoRows messages.

Property Value
Type Description
ProtoFormat

Query

public string Query { get; set; }

Required. The query string.

Property Value
Type Description
string