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

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

Overview

Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.

Defined Under Namespace

Classes: Authorization, LabelsEntry, MetadataTemplate

Instance Attribute Summary collapse

Instance Attribute Details

#authorization ⇒ ::Google::Cloud::Dataplex::V1::AspectType::Authorization

Returns Immutable. Authorization defined for this type.

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the AspectType was created.

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. Description of the AspectType.

Returns:

  • (::String) —

    Optional. Description of the AspectType.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Optional. User friendly display name.

Returns:

  • (::String) —

    Optional. User friendly display name.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

Returns This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns:

  • (::String) —

    This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User-defined labels for the AspectType.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined labels for the AspectType.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Required. MetadataTemplate of the aspect.

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.

Returns:

  • (::String) —

    Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#transfer_status ⇒ ::Google::Cloud::Dataplex::V1::TransferStatus (readonly)

Returns Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.

Returns:

  • (::String) —

    Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the AspectType was last updated.

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 65

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

  # Autorization for an Aspect Type.
  # @!attribute [rw] alternate_use_permission
  #   @return [::String]
  #     Immutable. The IAM permission grantable on the Entry Group to allow
  #     access to instantiate Aspects of Dataplex owned Aspect Types, only
  #     settable for Dataplex owned Types.
  class Authorization
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # MetadataTemplate definition for AspectType
  # @!attribute [rw] index
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the field.
  # @!attribute [rw] type
  #   @return [::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).
  # @!attribute [rw] record_fields
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>]
  #     Optional. Field definition, needs to be specified if the type is record.
  #     Defines the nested fields.
  # @!attribute [rw] enum_values
  #   @return [::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>]
  #     Optional. The list of values for an enum type. Needs to be defined if the
  #     type is enum.
  # @!attribute [rw] map_items
  #   @return [::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.
  # @!attribute [rw] array_items
  #   @return [::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.
  # @!attribute [rw] type_id
  #   @return [::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.
  # @!attribute [rw] type_ref
  #   @return [::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.
  # @!attribute [rw] constraints
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints]
  #     Optional. Specifies the constraints on this field.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations]
  #     Optional. Specifies annotations on this field.
  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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end