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.



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

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

Instance Attribute Details

#deprecated ⇒ String

Optional. Marks a field as deprecated. You can include a deprecation message. Corresponds to the JSON property deprecated

Returns:

  • (String) 


617
618
619
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 617

def deprecated
  @deprecated
end

#description ⇒ String

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

Returns:

  • (String) 


622
623
624
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 622

def description
  @description
end

#display_name ⇒ String

Optional. Display name for a field. Corresponds to the JSON property displayName

Returns:

  • (String) 


627
628
629
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 627

def display_name
  @display_name
end

#display_order ⇒ Fixnum

Optional. Display order for a field. You can use this to reorder where a field is rendered. Corresponds to the JSON property displayOrder

Returns:

  • (Fixnum) 


633
634
635
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 633

def display_order
  @display_order
end

#string_type ⇒ String

Optional. You can use String Type annotations 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) 


641
642
643
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 641

def string_type
  @string_type
end

#string_values ⇒ Array<String>

Optional. Suggested hints for string fields. You can use them to suggest values to users through console. Corresponds to the JSON property stringValues

Returns:

  • (Array<String>) 


647
648
649
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 647

def string_values
  @string_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



654
655
656
657
658
659
660
661
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 654

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