Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations

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

Definition of the annotations of a field

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations

Returns a new instance of GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations.



652
653
654
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 652

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

Instance Attribute Details

#deprecated ⇒ String

Optional. Marks a field as deprecated, a deprecation message can be included. Corresponds to the JSON property deprecated

Returns:

  • (String) 


620
621
622
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 620

def deprecated
  @deprecated
end

#description ⇒ String

Optional. Specify a description for a field Corresponds to the JSON property description

Returns:

  • (String) 


625
626
627
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 625

def description
  @description
end

#display_name ⇒ String

Optional. Specify a displayname for a field. Corresponds to the JSON property displayName

Returns:

  • (String) 


630
631
632
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 630

def display_name
  @display_name
end

#display_order ⇒ Fixnum

Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered Corresponds to the JSON property displayOrder

Returns:

  • (Fixnum) 


636
637
638
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 636

def display_order
  @display_order
end

#string_type ⇒ String

Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference. Corresponds to the JSON property stringType

Returns:

  • (String) 


644
645
646
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 644

def string_type
  @string_type
end

#string_values ⇒ Array<String>

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example. Corresponds to the JSON property stringValues

Returns:

  • (Array<String>) 


650
651
652
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 650

def string_values
  @string_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



657
658
659
660
661
662
663
664
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 657

def update!(**args)
  @deprecated = args[:deprecated] if args.key?(:deprecated)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @display_order = args[:display_order] if args.key?(:display_order)
  @string_type = args[:string_type] if args.key?(:string_type)
  @string_values = args[:string_values] if args.key?(:string_values)
end