Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate

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

Overview

MetadataTemplate definition for AspectType

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1AspectTypeMetadataTemplate

Returns a new instance of GoogleCloudDataplexV1AspectTypeMetadataTemplate.



593
594
595
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 593

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

Instance Attribute Details

#annotations ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations

Definition of the annotations of a field Corresponds to the JSON property annotations

Returns:



526
527
528
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 526

def annotations
  @annotations
end

#array_items ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate

MetadataTemplate definition for AspectType Corresponds to the JSON property arrayItems

Returns:



531
532
533
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 531

def array_items
  @array_items
end

#constraints ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints

Definition of the constraints of a field Corresponds to the JSON property constraints

Returns:



536
537
538
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 536

def constraints
  @constraints
end

#enum_values ⇒ Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue>

Optional. The list of values for an enum type. Needs to be defined if the type is enum. Corresponds to the JSON property enumValues

Returns:



542
543
544
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 542

def enum_values
  @enum_values
end

#index ⇒ Fixnum

Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions. Corresponds to the JSON property index

Returns:

  • (Fixnum) 


552
553
554
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 552

def index
  @index
end

#map_items ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate

MetadataTemplate definition for AspectType Corresponds to the JSON property mapItems

Returns:



557
558
559
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 557

def map_items
  @map_items
end

#name ⇒ String

Required. The name of the field. Corresponds to the JSON property name

Returns:

  • (String) 


562
563
564
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 562

def name
  @name
end

#record_fields ⇒ Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate>

Optional. Field definition, needs to be specified if the type is record. Defines the nested fields. Corresponds to the JSON property recordFields

Returns:



568
569
570
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 568

def record_fields
  @record_fields
end

#type ⇒ String

Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014- 10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record). Corresponds to the JSON property type

Returns:

  • (String) 


576
577
578
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 576

def type
  @type
end

#type_id ⇒ String

Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record. Corresponds to the JSON property typeId

Returns:

  • (String) 


583
584
585
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 583

def type_id
  @type_id
end

#type_ref ⇒ String

Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields. Corresponds to the JSON property typeRef

Returns:

  • (String) 


591
592
593
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 591

def type_ref
  @type_ref
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 598

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @array_items = args[:array_items] if args.key?(:array_items)
  @constraints = args[:constraints] if args.key?(:constraints)
  @enum_values = args[:enum_values] if args.key?(:enum_values)
  @index = args[:index] if args.key?(:index)
  @map_items = args[:map_items] if args.key?(:map_items)
  @name = args[:name] if args.key?(:name)
  @record_fields = args[:record_fields] if args.key?(:record_fields)
  @type = args[:type] if args.key?(:type)
  @type_id = args[:type_id] if args.key?(:type_id)
  @type_ref = args[:type_ref] if args.key?(:type_ref)
end