Class: Google::Apis::BigqueryV2::BigtableColumn

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/bigquery_v2/classes.rb,
generated/google/apis/bigquery_v2/representations.rb,
generated/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BigtableColumn

Returns a new instance of BigtableColumn.


80
81
82
# File 'generated/google/apis/bigquery_v2/classes.rb', line 80

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#encodingString

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. Corresponds to the JSON property encoding

Returns:

  • (String)

36
37
38
# File 'generated/google/apis/bigquery_v2/classes.rb', line 36

def encoding
  @encoding
end

#field_nameString

[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. Corresponds to the JSON property fieldName

Returns:

  • (String)

43
44
45
# File 'generated/google/apis/bigquery_v2/classes.rb', line 43

def field_name
  @field_name
end

#only_read_latestBoolean Also known as: only_read_latest?

[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels. Corresponds to the JSON property onlyReadLatest

Returns:

  • (Boolean)

51
52
53
# File 'generated/google/apis/bigquery_v2/classes.rb', line 51

def only_read_latest
  @only_read_latest
end

#qualifier_encodedString

[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF- 8 string, it can be specified in the qualifier_string field. Otherwise, a base- 64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. Corresponds to the JSON property qualifierEncoded

Returns:

  • (String)

63
64
65
# File 'generated/google/apis/bigquery_v2/classes.rb', line 63

def qualifier_encoded
  @qualifier_encoded
end

#qualifier_stringString

Corresponds to the JSON property qualifierString

Returns:

  • (String)

68
69
70
# File 'generated/google/apis/bigquery_v2/classes.rb', line 68

def qualifier_string
  @qualifier_string
end

#typeString

[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. Corresponds to the JSON property type

Returns:

  • (String)

78
79
80
# File 'generated/google/apis/bigquery_v2/classes.rb', line 78

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


85
86
87
88
89
90
91
92
# File 'generated/google/apis/bigquery_v2/classes.rb', line 85

def update!(**args)
  @encoding = args[:encoding] if args.key?(:encoding)
  @field_name = args[:field_name] if args.key?(:field_name)
  @only_read_latest = args[:only_read_latest] if args.key?(:only_read_latest)
  @qualifier_encoded = args[:qualifier_encoded] if args.key?(:qualifier_encoded)
  @qualifier_string = args[:qualifier_string] if args.key?(:qualifier_string)
  @type = args[:type] if args.key?(:type)
end