Class: Google::Cloud::DataCatalog::V1::TagTemplateField

Inherits:

Object

• Object
• Google::Cloud::DataCatalog::V1::TagTemplateField

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/datacatalog/v1/tags.rb

Overview

The template for an individual field within a tag template.

Instance Attribute Summary

• #description ⇒ ::String

  The description for this field.

• #display_name ⇒ ::String

  The display name for this field.

• #is_required ⇒ ::Boolean

  If true, this field is required.

• #name ⇒ ::String readonly

  Output only.

• #order ⇒ ::Integer

  The order of this field with respect to other fields in this tag template.

• #type ⇒ ::Google::Cloud::DataCatalog::V1::FieldType

  Required.

Instance Attribute Details

#description ⇒ ::String

Returns The description for this field. Defaults to an empty string.

Returns:

• (::String) —

  The description for this field. Defaults to an empty string.

# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 224

class TagTemplateField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns The display name for this field. Defaults to an empty string.

The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.

Returns:

• (::String) —

  The display name for this field. Defaults to an empty string.

  The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.

# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 224

class TagTemplateField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#is_required ⇒ ::Boolean

Returns If true, this field is required. Defaults to false.

Returns:

• (::Boolean) —

  If true, this field is required. Defaults to false.

# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 224

class TagTemplateField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns 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: The tag template field itself might not be stored in the location specified in its name.

The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters.

Returns:

• (::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: The tag template field itself might not be stored in the location specified in its name.

  The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters.

# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 224

class TagTemplateField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order ⇒ ::Integer

Returns The order of this field with respect to other fields in this tag template.

For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order and field orders within a tag don't have to be sequential.

Returns:

• (::Integer) —

  The order of this field with respect to other fields in this tag template.

  For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order and field orders within a tag don't have to be sequential.

# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 224

class TagTemplateField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::Google::Cloud::DataCatalog::V1::FieldType

Returns Required. The type of value this tag field can contain.

Returns:

• (::Google::Cloud::DataCatalog::V1::FieldType) —

  Required. The type of value this tag field can contain.

# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 224

class TagTemplateField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end