gcp_dataplex_aspect_type

ancestors

Type: UNORDERED_LIST_STRING

authorization

Type: STRUCT
Provider name: authorization
Description: Immutable. Defines the Authorization for this type.

  • alternate_use_permission
    Type: STRING
    Provider name: alternateUsePermission
    Description: Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex Universal Catalog owned AspectTypes, only settable for Dataplex Universal Catalog owned Types.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time when the AspectType was created.

description

Type: STRING
Provider name: description
Description: Optional. Description of the AspectType.

etag

Type: STRING
Provider name: etag
Description: The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding.

gcp_display_name

Type: STRING
Provider name: displayName
Description: Optional. User friendly display name.

labels

Type: UNORDERED_LIST_STRING

metadata_template

Type: STRUCT
Provider name: metadataTemplate
Description: Required. MetadataTemplate of the aspect.

  • annotations
    Type: STRUCT
    Provider name: annotations
    Description: Optional. Specifies annotations on this field.
    • deprecated
      Type: STRING
      Provider name: deprecated
      Description: Optional. Marks a field as deprecated. You can include a deprecation message.
    • description
      Type: STRING
      Provider name: description
      Description: Optional. Description for a field.
    • display_order
      Type: INT32
      Provider name: displayOrder
      Description: Optional. Display order for a field. You can use this to reorder where a field is rendered.
    • gcp_display_name
      Type: STRING
      Provider name: displayName
      Description: Optional. Display name for a field.
    • string_type
      Type: STRING
      Provider name: stringType
      Description: Optional. You can use String Type annotations 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.
    • string_values
      Type: UNORDERED_LIST_STRING
      Provider name: stringValues
      Description: Optional. Suggested hints for string fields. You can use them to suggest values to users through console.
  • constraints
    Type: STRUCT
    Provider name: constraints
    Description: Optional. Specifies the constraints on this field.
    • required
      Type: BOOLEAN
      Provider name: required
      Description: Optional. Marks this field as optional or required.
  • enum_values
    Type: UNORDERED_LIST_STRUCT
    Provider name: enumValues
    Description: Optional. The list of values for an enum type. You must define it if the type is enum.
    • deprecated
      Type: STRING
      Provider name: deprecated
      Description: Optional. You can set this message if you need to deprecate an enum value.
    • index
      Type: INT32
      Provider name: index
      Description: Required. Index for the enum value. It can’t be modified.
    • name
      Type: STRING
      Provider name: name
      Description: Required. Name of the enumvalue. This is the actual value that the aspect can contain.
  • index
    Type: INT32
    Provider name: index
    Description: 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.
  • name
    Type: STRING
    Provider name: name
    Description: Required. The name of the field.
  • type
    Type: STRING
    Provider name: type
    Description: Required. The datatype of this field. The following values are supported:Primitive types: string int bool 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
    Type: STRING
    Provider name: typeId
    Description: 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
    Type: STRING
    Provider name: typeRef
    Description: 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.

name

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

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

region_id

Type: STRING

resource_name

Type: STRING

tags

Type: UNORDERED_LIST_STRING

transfer_status

Type: STRING
Provider name: transferStatus
Description: Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
Possible values:

  • TRANSFER_STATUS_UNSPECIFIED - The default value. It is set for resources that were not subject for migration from Data Catalog service.
  • TRANSFER_STATUS_MIGRATED - Indicates that a resource was migrated from Data Catalog service but it hasn’t been transferred yet. In particular the resource cannot be updated from Dataplex API.
  • TRANSFER_STATUS_TRANSFERRED - Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API.

uid

Type: STRING
Provider name: uid
Description: Output only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time when the AspectType was last updated.

zone_id

Type: STRING