Show / Hide Table of Contents

Class FieldSource

A source that can be used to represent a field within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses.

Inheritance
object
FieldSource
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.Logging.v2.Data
Assembly: Google.Apis.Logging.v2.dll
Syntax
public class FieldSource : IDirectResponseSchema

Properties

AliasRef

The alias name for a field that has already been aliased within a different ProjectedField type elsewhere in the query model. The alias must be defined in the QueryBuilderConfig's field_sources list, otherwise the model is invalid.

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

ColumnType

The type of the selected field. This comes from the schema. Can be one of the BigQuery data types: - STRING

  • INT64 - FLOAT64 - BOOL - TIMESTAMP - DATE - RECORD - JSON
Declaration
[JsonProperty("columnType")]
public virtual string ColumnType { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

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

Field

The fully qualified, dot-delimited path to the selected atomic field (the leaf value). This path is used for primary selection and actions like drill-down or projection.The path components should match the exact field names or keys as they appear in the underlying data schema. For JSON fields, this means respecting the original casing (e.g., camelCase or snake_case as present in the JSON).To reference field names containing special characters (e.g., hyphens, spaces), enclose the individual path segment in backticks ().Examples: * json_payload.labels.message * json_payload.request_id * httpRequest.status * json_payload.\my-custom-field.value *jsonPayload.my key with spaces.data`

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

IsJson

Whether the field is a JSON field, or has a parent that is a JSON field. This value is used to determine JSON extractions in generated SQL queries. Note that this is_json flag may be true when the column_type is not JSON if the parent is a JSON field. Ex: - A json_payload.message field might have is_json=true, since the 'json_payload' parent is of type JSON, and columnType='STRING' if the 'message' field is of type STRING.

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

ParentPath

The dot-delimited path of the parent container that holds the target field.This path defines the structural hierarchy and is essential for correctly generating SQL when field keys contain special characters (e.g., dots or brackets).Example: json_payload.labels (This points to the 'labels' object). This is an empty string if the target field is at the root level.

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

ProjectedField

A projected field option for when a user wants to use a field with some additional transformations such as casting or extractions.

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

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX