Class: Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/catalog.rb

Overview

MetadataTemplate definition for AspectType

Defined Under Namespace

Classes: Annotations, Constraints, EnumValue

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations

Returns Optional. Specifies annotations on this field.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#array_items ⇒ ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate

Returns Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

Returns:

  • (::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate) —

    Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#constraints ⇒ ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints

Returns Optional. Specifies the constraints on this field.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enum_values ⇒ ::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>

Returns Optional. The list of values for an enum type. Needs to be defined if the type is enum.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#index ⇒ ::Integer

Returns Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.

Returns:

  • (::Integer) —

    Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#map_items ⇒ ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate

Returns Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

Returns:

  • (::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate) —

    Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. The name of the field.

Returns:

  • (::String) —

    Required. The name of the field.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#record_fields ⇒ ::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>

Returns Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#type ⇒ ::String

Returns Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record).

Returns:

  • (::String) —

    Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record).



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#type_id ⇒ ::String

Returns Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.

Returns:

  • (::String) —

    Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#type_ref ⇒ ::String

Returns Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.

Returns:

  • (::String) —

    Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 138

class MetadataTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of Enumvalue (to be used by enum fields)
  # @!attribute [rw] index
  #   @return [::Integer]
  #     Required. Index for the enum. Cannot be modified.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Name of the enumvalue. This is the actual value that the
  #     aspect will contain.
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Optional deprecation message to be set if an enum value needs
  #     to be deprecated.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the constraints of a field
  # @!attribute [rw] required
  #   @return [::Boolean]
  #     Optional. Marks this as an optional/required field.
  class Constraints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the annotations of a field
  # @!attribute [rw] deprecated
  #   @return [::String]
  #     Optional. Marks a field as deprecated, a deprecation message can be
  #     included.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     Optional. Specify a displayname for a field.
  # @!attribute [rw] description
  #   @return [::String]
  #     Optional. Specify a description for a field
  # @!attribute [rw] display_order
  #   @return [::Integer]
  #     Optional. Specify a display order for a field. Display order can be
  #     used to reorder where a field is rendered
  # @!attribute [rw] string_type
  #   @return [::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.
  # @!attribute [rw] string_values
  #   @return [::Array<::String>]
  #     Optional. Suggested hints for string fields. These can be used to
  #     suggest values to users, through an UI for example.
  class Annotations
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end