Show / Hide Table of Contents

Class QueryResponse

Inheritance
object
QueryResponse
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Bigquery.v2.Data
Assembly: Google.Apis.Bigquery.v2.dll
Syntax
public class QueryResponse : IDirectResponseSchema

Properties

CacheHit

Whether the query result was fetched from the query cache.

Declaration
[JsonProperty("cacheHit")]
public virtual bool? CacheHit { get; set; }
Property Value
Type Description
bool?

DmlStats

Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.

Declaration
[JsonProperty("dmlStats")]
public virtual DmlStatistics DmlStats { get; set; }
Property Value
Type Description
DmlStatistics

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Errors

Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. For more information about error messages, see Error messages.

Declaration
[JsonProperty("errors")]
public virtual IList<ErrorProto> Errors { get; set; }
Property Value
Type Description
IList<ErrorProto>

JobComplete

Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.

Declaration
[JsonProperty("jobComplete")]
public virtual bool? JobComplete { get; set; }
Property Value
Type Description
bool?

JobCreationReason

Optional. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. When job_reference is present, this field should be interpreted as follows: If set, it will provide the reason of why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.

Declaration
[JsonProperty("jobCreationReason")]
public virtual JobCreationReason JobCreationReason { get; set; }
Property Value
Type Description
JobCreationReason

JobReference

Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).

Declaration
[JsonProperty("jobReference")]
public virtual JobReference JobReference { get; set; }
Property Value
Type Description
JobReference

Kind

The resource type.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

NumDmlAffectedRows

Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

Declaration
[JsonProperty("numDmlAffectedRows")]
public virtual long? NumDmlAffectedRows { get; set; }
Property Value
Type Description
long?

PageToken

A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the jobs.getQueryResults method. For more information, see Paging through table data.

Declaration
[JsonProperty("pageToken")]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

QueryId

Query ID for the completed query. This ID will be auto-generated. This field is not yet available and it is currently not guaranteed to be populated.

Declaration
[JsonProperty("queryId")]
public virtual string QueryId { get; set; }
Property Value
Type Description
string

Rows

An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.

Declaration
[JsonProperty("rows")]
public virtual IList<TableRow> Rows { get; set; }
Property Value
Type Description
IList<TableRow>

Schema

The schema of the results. Present only when the query completes successfully.

Declaration
[JsonProperty("schema")]
public virtual TableSchema Schema { get; set; }
Property Value
Type Description
TableSchema

SessionInfo

Output only. Information of the session if this job is part of one.

Declaration
[JsonProperty("sessionInfo")]
public virtual SessionInfo SessionInfo { get; set; }
Property Value
Type Description
SessionInfo

TotalBytesProcessed

The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.

Declaration
[JsonProperty("totalBytesProcessed")]
public virtual long? TotalBytesProcessed { get; set; }
Property Value
Type Description
long?

TotalRows

The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.

Declaration
[JsonProperty("totalRows")]
public virtual ulong? TotalRows { get; set; }
Property Value
Type Description
ulong?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX