Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dataplex
  5. dataplex/v1
  6. getEntity

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dataplex/v1.getEntity

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Get a metadata entity.

    Using getEntity

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEntity(args: GetEntityArgs, opts?: InvokeOptions): Promise<GetEntityResult>
function getEntityOutput(args: GetEntityOutputArgs, opts?: InvokeOptions): Output<GetEntityResult>
    def get_entity(entity_id: Optional[str] = None,
               lake_id: Optional[str] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               view: Optional[str] = None,
               zone: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetEntityResult
def get_entity_output(entity_id: Optional[pulumi.Input[str]] = None,
               lake_id: Optional[pulumi.Input[str]] = None,
               location: Optional[pulumi.Input[str]] = None,
               project: Optional[pulumi.Input[str]] = None,
               view: Optional[pulumi.Input[str]] = None,
               zone: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetEntityResult]
    func LookupEntity(ctx *Context, args *LookupEntityArgs, opts ...InvokeOption) (*LookupEntityResult, error)
func LookupEntityOutput(ctx *Context, args *LookupEntityOutputArgs, opts ...InvokeOption) LookupEntityResultOutput

    > Note: This function is named LookupEntity in the Go SDK.

    public static class GetEntity 
{
    public static Task<GetEntityResult> InvokeAsync(GetEntityArgs args, InvokeOptions? opts = null)
    public static Output<GetEntityResult> Invoke(GetEntityInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEntityResult> getEntity(GetEntityArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:dataplex/v1:getEntity
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EntityId string
    LakeId string
    Location string
    Zone string
    Project string
    View string
    EntityId string
    LakeId string
    Location string
    Zone string
    Project string
    View string
    entityId String
    lakeId String
    location String
    zone String
    project String
    view String
    entityId string
    lakeId string
    location string
    zone string
    project string
    view string
    entityId String
    lakeId String
    location String
    zone String
    project String
    view String

    getEntity Result

    The following output properties are available:

    Access Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1StorageAccessResponse
    Identifies the access mechanism to the entity. Not user settable.
    Asset string
    Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
    CatalogEntry string
    The name of the associated Data Catalog entry.
    Compatibility Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1EntityCompatibilityStatusResponse
    Metadata stores that the entity is compatible with.
    CreateTime string
    The time when the entity was created.
    DataPath string
    Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
    DataPathPattern string
    Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
    Description string
    Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
    DisplayName string
    Optional. Display name must be shorter than or equal to 256 characters.
    Etag string
    Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
    Format Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1StorageFormatResponse
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    Name string
    The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
    Schema Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1SchemaResponse
    The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    System string
    Immutable. Identifies the storage system of the entity data.
    Type string
    Immutable. The type of entity.
    Uid string
    System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
    UpdateTime string
    The time when the entity was last updated.
    Access GoogleCloudDataplexV1StorageAccessResponse
    Identifies the access mechanism to the entity. Not user settable.
    Asset string
    Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
    CatalogEntry string
    The name of the associated Data Catalog entry.
    Compatibility GoogleCloudDataplexV1EntityCompatibilityStatusResponse
    Metadata stores that the entity is compatible with.
    CreateTime string
    The time when the entity was created.
    DataPath string
    Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
    DataPathPattern string
    Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
    Description string
    Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
    DisplayName string
    Optional. Display name must be shorter than or equal to 256 characters.
    Etag string
    Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
    Format GoogleCloudDataplexV1StorageFormatResponse
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    Name string
    The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
    Schema GoogleCloudDataplexV1SchemaResponse
    The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    System string
    Immutable. Identifies the storage system of the entity data.
    Type string
    Immutable. The type of entity.
    Uid string
    System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
    UpdateTime string
    The time when the entity was last updated.
    access GoogleCloudDataplexV1StorageAccessResponse
    Identifies the access mechanism to the entity. Not user settable.
    asset String
    Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
    catalogEntry String
    The name of the associated Data Catalog entry.
    compatibility GoogleCloudDataplexV1EntityCompatibilityStatusResponse
    Metadata stores that the entity is compatible with.
    createTime String
    The time when the entity was created.
    dataPath String
    Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
    dataPathPattern String
    Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
    description String
    Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
    displayName String
    Optional. Display name must be shorter than or equal to 256 characters.
    etag String
    Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
    format GoogleCloudDataplexV1StorageFormatResponse
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    name String
    The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
    schema GoogleCloudDataplexV1SchemaResponse
    The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    system String
    Immutable. Identifies the storage system of the entity data.
    type String
    Immutable. The type of entity.
    uid String
    System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
    updateTime String
    The time when the entity was last updated.
    access GoogleCloudDataplexV1StorageAccessResponse
    Identifies the access mechanism to the entity. Not user settable.
    asset string
    Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
    catalogEntry string
    The name of the associated Data Catalog entry.
    compatibility GoogleCloudDataplexV1EntityCompatibilityStatusResponse
    Metadata stores that the entity is compatible with.
    createTime string
    The time when the entity was created.
    dataPath string
    Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
    dataPathPattern string
    Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
    description string
    Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
    displayName string
    Optional. Display name must be shorter than or equal to 256 characters.
    etag string
    Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
    format GoogleCloudDataplexV1StorageFormatResponse
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    name string
    The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
    schema GoogleCloudDataplexV1SchemaResponse
    The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    system string
    Immutable. Identifies the storage system of the entity data.
    type string
    Immutable. The type of entity.
    uid string
    System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
    updateTime string
    The time when the entity was last updated.
    access GoogleCloudDataplexV1StorageAccessResponse
    Identifies the access mechanism to the entity. Not user settable.
    asset str
    Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
    catalog_entry str
    The name of the associated Data Catalog entry.
    compatibility GoogleCloudDataplexV1EntityCompatibilityStatusResponse
    Metadata stores that the entity is compatible with.
    create_time str
    The time when the entity was created.
    data_path str
    Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
    data_path_pattern str
    Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
    description str
    Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
    display_name str
    Optional. Display name must be shorter than or equal to 256 characters.
    etag str
    Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
    format GoogleCloudDataplexV1StorageFormatResponse
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    name str
    The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
    schema GoogleCloudDataplexV1SchemaResponse
    The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    system str
    Immutable. Identifies the storage system of the entity data.
    type str
    Immutable. The type of entity.
    uid str
    System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
    update_time str
    The time when the entity was last updated.
    access Property Map
    Identifies the access mechanism to the entity. Not user settable.
    asset String
    Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
    catalogEntry String
    The name of the associated Data Catalog entry.
    compatibility Property Map
    Metadata stores that the entity is compatible with.
    createTime String
    The time when the entity was created.
    dataPath String
    Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
    dataPathPattern String
    Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
    description String
    Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
    displayName String
    Optional. Display name must be shorter than or equal to 256 characters.
    etag String
    Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
    format Property Map
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    name String
    The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
    schema Property Map
    The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
    system String
    Immutable. Identifies the storage system of the entity data.
    type String
    Immutable. The type of entity.
    uid String
    System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
    updateTime String
    The time when the entity was last updated.

    Supporting Types

    GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse

    Compatible bool
    Whether the entity is compatible and can be represented in the metadata store.
    Reason string
    Provides additional detail if the entity is incompatible with the metadata store.
    Compatible bool
    Whether the entity is compatible and can be represented in the metadata store.
    Reason string
    Provides additional detail if the entity is incompatible with the metadata store.
    compatible Boolean
    Whether the entity is compatible and can be represented in the metadata store.
    reason String
    Provides additional detail if the entity is incompatible with the metadata store.
    compatible boolean
    Whether the entity is compatible and can be represented in the metadata store.
    reason string
    Provides additional detail if the entity is incompatible with the metadata store.
    compatible bool
    Whether the entity is compatible and can be represented in the metadata store.
    reason str
    Provides additional detail if the entity is incompatible with the metadata store.
    compatible Boolean
    Whether the entity is compatible and can be represented in the metadata store.
    reason String
    Provides additional detail if the entity is incompatible with the metadata store.

    GoogleCloudDataplexV1EntityCompatibilityStatusResponse

    Bigquery GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with BigQuery.
    HiveMetastore GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with Hive Metastore.
    bigquery GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with BigQuery.
    hiveMetastore GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with Hive Metastore.
    bigquery GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with BigQuery.
    hiveMetastore GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with Hive Metastore.
    bigquery GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with BigQuery.
    hive_metastore GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with Hive Metastore.
    bigquery Property Map
    Whether this entity is compatible with BigQuery.
    hiveMetastore Property Map
    Whether this entity is compatible with Hive Metastore.

    GoogleCloudDataplexV1SchemaPartitionFieldResponse

    Name string
    Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
    Type string
    Immutable. The type of field.
    Name string
    Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
    Type string
    Immutable. The type of field.
    name String
    Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
    type String
    Immutable. The type of field.
    name string
    Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
    type string
    Immutable. The type of field.
    name str
    Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
    type str
    Immutable. The type of field.
    name String
    Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
    type String
    Immutable. The type of field.

    GoogleCloudDataplexV1SchemaResponse

    Fields List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaSchemaFieldResponse>
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    PartitionFields List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaPartitionFieldResponse>
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    PartitionStyle string
    Optional. The structure of paths containing partition data within the entity.
    UserManaged bool
    Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
    Fields []GoogleCloudDataplexV1SchemaSchemaFieldResponse
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    PartitionFields []GoogleCloudDataplexV1SchemaPartitionFieldResponse
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    PartitionStyle string
    Optional. The structure of paths containing partition data within the entity.
    UserManaged bool
    Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
    fields List<GoogleCloudDataplexV1SchemaSchemaFieldResponse>
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partitionFields List<GoogleCloudDataplexV1SchemaPartitionFieldResponse>
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    partitionStyle String
    Optional. The structure of paths containing partition data within the entity.
    userManaged Boolean
    Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
    fields GoogleCloudDataplexV1SchemaSchemaFieldResponse[]
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partitionFields GoogleCloudDataplexV1SchemaPartitionFieldResponse[]
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    partitionStyle string
    Optional. The structure of paths containing partition data within the entity.
    userManaged boolean
    Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
    fields Sequence[GoogleCloudDataplexV1SchemaSchemaFieldResponse]
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partition_fields Sequence[GoogleCloudDataplexV1SchemaPartitionFieldResponse]
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    partition_style str
    Optional. The structure of paths containing partition data within the entity.
    user_managed bool
    Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.
    fields List<Property Map>
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partitionFields List<Property Map>
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    partitionStyle String
    Optional. The structure of paths containing partition data within the entity.
    userManaged Boolean
    Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.

    GoogleCloudDataplexV1SchemaSchemaFieldResponse

    Description string
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    Fields List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaSchemaFieldResponse>
    Optional. Any nested field for complex types.
    Mode string
    Additional field semantics.
    Name string
    The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
    Type string
    The type of field.
    Description string
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    Fields []GoogleCloudDataplexV1SchemaSchemaFieldResponse
    Optional. Any nested field for complex types.
    Mode string
    Additional field semantics.
    Name string
    The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
    Type string
    The type of field.
    description String
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    fields List<GoogleCloudDataplexV1SchemaSchemaFieldResponse>
    Optional. Any nested field for complex types.
    mode String
    Additional field semantics.
    name String
    The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
    type String
    The type of field.
    description string
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    fields GoogleCloudDataplexV1SchemaSchemaFieldResponse[]
    Optional. Any nested field for complex types.
    mode string
    Additional field semantics.
    name string
    The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
    type string
    The type of field.
    description str
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    fields Sequence[GoogleCloudDataplexV1SchemaSchemaFieldResponse]
    Optional. Any nested field for complex types.
    mode str
    Additional field semantics.
    name str
    The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
    type str
    The type of field.
    description String
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    fields List<Property Map>
    Optional. Any nested field for complex types.
    mode String
    Additional field semantics.
    name String
    The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
    type String
    The type of field.

    GoogleCloudDataplexV1StorageAccessResponse

    Read string
    Describes the read access mechanism of the data. Not user settable.
    Read string
    Describes the read access mechanism of the data. Not user settable.
    read String
    Describes the read access mechanism of the data. Not user settable.
    read string
    Describes the read access mechanism of the data. Not user settable.
    read str
    Describes the read access mechanism of the data. Not user settable.
    read String
    Describes the read access mechanism of the data. Not user settable.

    GoogleCloudDataplexV1StorageFormatCsvOptionsResponse

    Delimiter string
    Optional. The delimiter used to separate values. Defaults to ','.
    Encoding string
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
    HeaderRows int
    Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
    Quote string
    Optional. The character used to quote column values. Accepts '"' (double quotation mark) or ''' (single quotation mark). Defaults to '"' (double quotation mark) if unspecified.
    Delimiter string
    Optional. The delimiter used to separate values. Defaults to ','.
    Encoding string
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
    HeaderRows int
    Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
    Quote string
    Optional. The character used to quote column values. Accepts '"' (double quotation mark) or ''' (single quotation mark). Defaults to '"' (double quotation mark) if unspecified.
    delimiter String
    Optional. The delimiter used to separate values. Defaults to ','.
    encoding String
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
    headerRows Integer
    Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
    quote String
    Optional. The character used to quote column values. Accepts '"' (double quotation mark) or ''' (single quotation mark). Defaults to '"' (double quotation mark) if unspecified.
    delimiter string
    Optional. The delimiter used to separate values. Defaults to ','.
    encoding string
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
    headerRows number
    Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
    quote string
    Optional. The character used to quote column values. Accepts '"' (double quotation mark) or ''' (single quotation mark). Defaults to '"' (double quotation mark) if unspecified.
    delimiter str
    Optional. The delimiter used to separate values. Defaults to ','.
    encoding str
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
    header_rows int
    Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
    quote str
    Optional. The character used to quote column values. Accepts '"' (double quotation mark) or ''' (single quotation mark). Defaults to '"' (double quotation mark) if unspecified.
    delimiter String
    Optional. The delimiter used to separate values. Defaults to ','.
    encoding String
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
    headerRows Number
    Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
    quote String
    Optional. The character used to quote column values. Accepts '"' (double quotation mark) or ''' (single quotation mark). Defaults to '"' (double quotation mark) if unspecified.

    GoogleCloudDataplexV1StorageFormatIcebergOptionsResponse

    MetadataLocation string
    Optional. The location of where the iceberg metadata is present, must be within the table path
    MetadataLocation string
    Optional. The location of where the iceberg metadata is present, must be within the table path
    metadataLocation String
    Optional. The location of where the iceberg metadata is present, must be within the table path
    metadataLocation string
    Optional. The location of where the iceberg metadata is present, must be within the table path
    metadata_location str
    Optional. The location of where the iceberg metadata is present, must be within the table path
    metadataLocation String
    Optional. The location of where the iceberg metadata is present, must be within the table path

    GoogleCloudDataplexV1StorageFormatJsonOptionsResponse

    Encoding string
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified.
    Encoding string
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified.
    encoding String
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified.
    encoding string
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified.
    encoding str
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified.
    encoding String
    Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified.

    GoogleCloudDataplexV1StorageFormatResponse

    CompressionFormat string
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    Csv Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatCsvOptionsResponse
    Optional. Additional information about CSV formatted data.
    Format string
    The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    Iceberg Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatIcebergOptionsResponse
    Optional. Additional information about iceberg tables.
    Json Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatJsonOptionsResponse
    Optional. Additional information about CSV formatted data.
    MimeType string
    The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
    CompressionFormat string
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    Csv GoogleCloudDataplexV1StorageFormatCsvOptionsResponse
    Optional. Additional information about CSV formatted data.
    Format string
    The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    Iceberg GoogleCloudDataplexV1StorageFormatIcebergOptionsResponse
    Optional. Additional information about iceberg tables.
    Json GoogleCloudDataplexV1StorageFormatJsonOptionsResponse
    Optional. Additional information about CSV formatted data.
    MimeType string
    The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
    compressionFormat String
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv GoogleCloudDataplexV1StorageFormatCsvOptionsResponse
    Optional. Additional information about CSV formatted data.
    format String
    The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    iceberg GoogleCloudDataplexV1StorageFormatIcebergOptionsResponse
    Optional. Additional information about iceberg tables.
    json GoogleCloudDataplexV1StorageFormatJsonOptionsResponse
    Optional. Additional information about CSV formatted data.
    mimeType String
    The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
    compressionFormat string
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv GoogleCloudDataplexV1StorageFormatCsvOptionsResponse
    Optional. Additional information about CSV formatted data.
    format string
    The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    iceberg GoogleCloudDataplexV1StorageFormatIcebergOptionsResponse
    Optional. Additional information about iceberg tables.
    json GoogleCloudDataplexV1StorageFormatJsonOptionsResponse
    Optional. Additional information about CSV formatted data.
    mimeType string
    The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
    compression_format str
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv GoogleCloudDataplexV1StorageFormatCsvOptionsResponse
    Optional. Additional information about CSV formatted data.
    format str
    The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    iceberg GoogleCloudDataplexV1StorageFormatIcebergOptionsResponse
    Optional. Additional information about iceberg tables.
    json GoogleCloudDataplexV1StorageFormatJsonOptionsResponse
    Optional. Additional information about CSV formatted data.
    mime_type str
    The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
    compressionFormat String
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv Property Map
    Optional. Additional information about CSV formatted data.
    format String
    The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    iceberg Property Map
    Optional. Additional information about iceberg tables.
    json Property Map
    Optional. Additional information about CSV formatted data.
    mimeType String
    The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native