Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagTemplateField

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

Overview

The template for an individual field within a tag template.

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) ⇒ GoogleCloudDatacatalogV1beta1TagTemplateField

Returns a new instance of GoogleCloudDatacatalogV1beta1TagTemplateField.



1503
1504
1505
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1503

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

Instance Attribute Details

#display_name ⇒ String

The display name for this field. Defaults to an empty string. Corresponds to the JSON property displayName

Returns:

  • (String) 


1480
1481
1482
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1480

def display_name
  @display_name
end

#is_required ⇒ Boolean Also known as: is_required?

Whether this is a required field. Defaults to false. Corresponds to the JSON property isRequired

Returns:

  • (Boolean) 


1485
1486
1487
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1485

def is_required
  @is_required
end

#name ⇒ String

Output only. The resource name of the tag template field in URL format. Example:

  • projects/project_id/locations/location/tagTemplates/tag_template/ fields/field Note that this TagTemplateField may not actually be stored in the location in this name. Corresponds to the JSON property name

Returns:

  • (String) 


1496
1497
1498
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1496

def name
  @name
end

#type ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1FieldType

Required. The type of value this tag field can contain. Corresponds to the JSON property type

Returns:



1501
1502
1503
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1501

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1508
1509
1510
1511
1512
1513
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1508

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @is_required = args[:is_required] if args.key?(:is_required)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
end