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

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1TagTemplateField

Returns a new instance of GoogleCloudDatacatalogV1beta1TagTemplateField.



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

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

Instance Attribute Details

#description ⇒ String

The description for this field. Defaults to an empty string. Corresponds to the JSON property description

Returns:

  • (String) 


1466
1467
1468
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1466

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


1471
1472
1473
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1471

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) 


1476
1477
1478
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1476

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) 


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

def name
  @name
end

#order ⇒ Fixnum

The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential. Corresponds to the JSON property order

Returns:

  • (Fixnum) 


1493
1494
1495
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1493

def order
  @order
end

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

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

Returns:



1498
1499
1500
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1498

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @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)
  @order = args[:order] if args.key?(:order)
  @type = args[:type] if args.key?(:type)
end