Dataplex V1 API - Class Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate (v1.2.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate.

MetadataTemplate definition for an AspectType.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations

Returns

(::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations) — Optional. Specifies annotations on this field.

#annotations=

def annotations=(value) -> ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations

Parameter

value (::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations) — Optional. Specifies annotations on this field.

Returns

(::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations) — Optional. Specifies annotations on this field.

#array_items

def array_items() -> ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate

Returns

(::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate) — Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

#array_items=

def array_items=(value) -> ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate

Parameter

value (::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate) — Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

Returns

(::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate) — Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

#constraints

def constraints() -> ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints

Returns

(::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints) — Optional. Specifies the constraints on this field.

#constraints=

def constraints=(value) -> ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints

Parameter

value (::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints) — Optional. Specifies the constraints on this field.

Returns

(::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Constraints) — Optional. Specifies the constraints on this field.

#enum_values

def enum_values() -> ::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>

Returns

(::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>) — Optional. The list of values for an enum type. You must define it if the type is enum.

#enum_values=

def enum_values=(value) -> ::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>

Parameter

value (::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>) — Optional. The list of values for an enum type. You must define it if the type is enum.

Returns

(::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::EnumValue>) — Optional. The list of values for an enum type. You must define it if the type is enum.

#index

def index() -> ::Integer

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.

#index=

def index=(value) -> ::Integer

Parameter

value (::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.

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.

#map_items

def map_items() -> ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate

Returns

(::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate) — Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

#map_items=

def map_items=(value) -> ::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate

Parameter

value (::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate) — Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

Returns

(::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate) — Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

#name

def name() -> ::String

Returns

(::String) — Required. The name of the field.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Required. The name of the field.

Returns

(::String) — Required. The name of the field.

#record_fields

def record_fields() -> ::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>

Returns

(::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>) — Optional. Field definition. You must specify it if the type is record. It defines the nested fields.

#record_fields=

def record_fields=(value) -> ::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>

Parameter

value (::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>) — Optional. Field definition. You must specify it if the type is record. It defines the nested fields.

Returns

(::Array<::Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate>) — Optional. Field definition. You must specify it if the type is record. It defines the nested fields.

#type

def type() -> ::String

Returns

(::String) —
Required. The datatype of this field. The following values are supported:

Primitive types:
- string
- integer
- boolean
- double
- 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

#type=

def type=(value) -> ::String

Parameter

value (::String) —
Required. The datatype of this field. The following values are supported:

Primitive types:
- string
- integer
- boolean
- double
- 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. 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

#type_id

def type_id() -> ::String

Returns

(::String) — Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.

#type_id=

def type_id=(value) -> ::String

Parameter

value (::String) — Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.

Returns

(::String) — Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.

#type_ref

def type_ref() -> ::String

Returns

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

#type_ref=

def type_ref=(value) -> ::String

Parameter

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

Returns

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