Show / Hide Table of Contents

Class TableFieldSchema

A field in TableSchema

Inheritance
object
TableFieldSchema
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 TableFieldSchema : IDirectResponseSchema

Properties

Categories

Deprecated.

Declaration
[JsonProperty("categories")]
public virtual TableFieldSchema.CategoriesData Categories { get; set; }
Property Value
Type Description
TableFieldSchema.CategoriesData

Collation

Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.

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

DefaultValueExpression

Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.

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

Description

Optional. The field description. The maximum length is 1,024 characters.

Declaration
[JsonProperty("description")]
public virtual string Description { 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

Fields

Optional. Describes the nested schema fields if the type property is set to RECORD.

Declaration
[JsonProperty("fields")]
public virtual IList<TableFieldSchema> Fields { get; set; }
Property Value
Type Description
IList<TableFieldSchema>

ForeignTypeDefinition

Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required.

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

MaxLength

Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".

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

Mode

Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

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

Name

Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.

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

PolicyTags

Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.

Declaration
[JsonProperty("policyTags")]
public virtual TableFieldSchema.PolicyTagsData PolicyTags { get; set; }
Property Value
Type Description
TableFieldSchema.PolicyTagsData

Precision

Optional. Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: * Precision (P) and scale (S) are specified: [-10P-S

  • 10-S, 10P-S - 10-S] * Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: * If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. * If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): * If type = "NUMERIC": 1 ≤ precision ≤ 29. * If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
Declaration
[JsonProperty("precision")]
public virtual long? Precision { get; set; }
Property Value
Type Description
long?

RangeElementType

Represents the type of a field element.

Declaration
[JsonProperty("rangeElementType")]
public virtual TableFieldSchema.RangeElementTypeData RangeElementType { get; set; }
Property Value
Type Description
TableFieldSchema.RangeElementTypeData

RoundingMode

Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.

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

Scale

Optional. See documentation for precision.

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

Type

Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON

  • RECORD (or STRUCT) * RANGE (Preview) Use of RECORD/STRUCT indicates that the field contains a nested schema.
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX