Class: Google::Apis::BigtableadminV2::Type

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

Overview

Type represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each Type includes an Encoding which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that Encode(X) <= Encode(Y) if and only if X <= Y. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if X != Y then Encode(X) != Encode(Y). However, the converse is not guaranteed. For example, both 'foo': '1', 'bar': '2' and 'bar': '2', 'foo': '1' are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because INT64(1) > INT64(-1) , but STRING("-00001") > STRING("00001").

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Type

Returns a new instance of Type.



4465
4466
4467
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4465

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

Instance Attribute Details

#aggregate_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeAggregate

A value that combines incremental updates into a summarized value. Data is never directly written or read using type Aggregate. Writes provide either the input_type or state_type, and reads always return the state_type . Corresponds to the JSON property aggregateType

Returns:



4389
4390
4391
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4389

def aggregate_type
  @aggregate_type
end

#array_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeArray

An ordered list of elements of a given type. Values of type Array are stored in Value.array_value. Corresponds to the JSON property arrayType

Returns:



4395
4396
4397
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4395

def array_type
  @array_type
end

#bool_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeBool

bool Values of type Bool are stored in Value.bool_value. Corresponds to the JSON property boolType

Returns:



4400
4401
4402
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4400

def bool_type
  @bool_type
end

#bytes_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeBytes

Bytes Values of type Bytes are stored in Value.bytes_value. Corresponds to the JSON property bytesType

Returns:



4405
4406
4407
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4405

def bytes_type
  @bytes_type
end

#date_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeDate

Date Values of type Date are stored in Value.date_value. Corresponds to the JSON property dateType

Returns:



4410
4411
4412
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4410

def date_type
  @date_type
end

#enum_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeEnum

A protobuf enum type. Values of type Enum are stored in Value.int_value. Corresponds to the JSON property enumType

Returns:



4415
4416
4417
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4415

def enum_type
  @enum_type
end

#float32_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeFloat32

Float32 Values of type Float32 are stored in Value.float_value. Corresponds to the JSON property float32Type

Returns:



4420
4421
4422
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4420

def float32_type
  @float32_type
end

#float64_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeFloat64

Float64 Values of type Float64 are stored in Value.float_value. Corresponds to the JSON property float64Type

Returns:



4425
4426
4427
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4425

def float64_type
  @float64_type
end

#int64_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeInt64

Int64 Values of type Int64 are stored in Value.int_value. Corresponds to the JSON property int64Type

Returns:



4430
4431
4432
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4430

def int64_type
  @int64_type
end

#map_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeMap

A mapping of keys to values of a given type. Values of type Map are stored in a Value.array_value where each entry is another Value.array_value with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the last value takes precedence. Corresponds to the JSON property mapType

Returns:



4440
4441
4442
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4440

def map_type
  @map_type
end

#proto_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeProto

A protobuf message type. Values of type Proto are stored in Value. bytes_value. Corresponds to the JSON property protoType

Returns:



4446
4447
4448
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4446

def proto_type
  @proto_type
end

#string_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeString

String Values of type String are stored in Value.string_value. Corresponds to the JSON property stringType

Returns:



4451
4452
4453
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4451

def string_type
  @string_type
end

#struct_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeStruct

A structured data value, consisting of fields which map to dynamically typed values. Values of type Struct are stored in Value.array_value where entries are in the same order and number as field_types. Corresponds to the JSON property structType

Returns:



4458
4459
4460
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4458

def struct_type
  @struct_type
end

#timestamp_type ⇒ Google::Apis::BigtableadminV2::GoogleBigtableAdminV2TypeTimestamp

Timestamp Values of type Timestamp are stored in Value.timestamp_value. Corresponds to the JSON property timestampType

Returns:



4463
4464
4465
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4463

def timestamp_type
  @timestamp_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 4470

def update!(**args)
  @aggregate_type = args[:aggregate_type] if args.key?(:aggregate_type)
  @array_type = args[:array_type] if args.key?(:array_type)
  @bool_type = args[:bool_type] if args.key?(:bool_type)
  @bytes_type = args[:bytes_type] if args.key?(:bytes_type)
  @date_type = args[:date_type] if args.key?(:date_type)
  @enum_type = args[:enum_type] if args.key?(:enum_type)
  @float32_type = args[:float32_type] if args.key?(:float32_type)
  @float64_type = args[:float64_type] if args.key?(:float64_type)
  @int64_type = args[:int64_type] if args.key?(:int64_type)
  @map_type = args[:map_type] if args.key?(:map_type)
  @proto_type = args[:proto_type] if args.key?(:proto_type)
  @string_type = args[:string_type] if args.key?(:string_type)
  @struct_type = args[:struct_type] if args.key?(:struct_type)
  @timestamp_type = args[:timestamp_type] if args.key?(:timestamp_type)
end