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

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi

    Create a metadata entity. Auto-naming is currently not supported for this resource.

    Create Entity Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Entity(name: string, args: EntityArgs, opts?: CustomResourceOptions);
    @overload
    def Entity(resource_name: str,
               args: EntityArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Entity(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               lake_id: Optional[str] = None,
               data_path: Optional[str] = None,
               type: Optional[EntityType] = None,
               asset: Optional[str] = None,
               system: Optional[EntitySystem] = None,
               schema: Optional[GoogleCloudDataplexV1SchemaArgs] = None,
               format: Optional[GoogleCloudDataplexV1StorageFormatArgs] = None,
               id: Optional[str] = None,
               description: Optional[str] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               etag: Optional[str] = None,
               display_name: Optional[str] = None,
               data_path_pattern: Optional[str] = None,
               zone: Optional[str] = None)
    func NewEntity(ctx *Context, name string, args EntityArgs, opts ...ResourceOption) (*Entity, error)
    public Entity(string name, EntityArgs args, CustomResourceOptions? opts = null)
    public Entity(String name, EntityArgs args)
    public Entity(String name, EntityArgs args, CustomResourceOptions options)
    
    type: google-native:dataplex/v1:Entity
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_dataplex_v1_entity" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EntityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EntityArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EntityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntityArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var google_nativeEntityResource = new GoogleNative.Dataplex.V1.Entity("google-nativeEntityResource", new()
    {
        LakeId = "string",
        DataPath = "string",
        Type = GoogleNative.Dataplex.V1.EntityType.TypeUnspecified,
        Asset = "string",
        System = GoogleNative.Dataplex.V1.EntitySystem.StorageSystemUnspecified,
        Schema = new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaArgs
        {
            UserManaged = false,
            Fields = 
            {
                new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaSchemaFieldArgs
                {
                    Mode = GoogleNative.Dataplex.V1.GoogleCloudDataplexV1SchemaSchemaFieldMode.ModeUnspecified,
                    Name = "string",
                    Type = GoogleNative.Dataplex.V1.GoogleCloudDataplexV1SchemaSchemaFieldType.TypeUnspecified,
                    Description = "string",
                    Fields = new[]
                    {
                        googleCloudDataplexV1SchemaSchemaField,
                    },
                },
            },
            PartitionFields = new[]
            {
                new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaPartitionFieldArgs
                {
                    Name = "string",
                    Type = GoogleNative.Dataplex.V1.GoogleCloudDataplexV1SchemaPartitionFieldType.TypeUnspecified,
                },
            },
            PartitionStyle = GoogleNative.Dataplex.V1.GoogleCloudDataplexV1SchemaPartitionStyle.PartitionStyleUnspecified,
        },
        Format = new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatArgs
        {
            MimeType = "string",
            CompressionFormat = GoogleNative.Dataplex.V1.GoogleCloudDataplexV1StorageFormatCompressionFormat.CompressionFormatUnspecified,
            Csv = new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatCsvOptionsArgs
            {
                Delimiter = "string",
                Encoding = "string",
                HeaderRows = 0,
                Quote = "string",
            },
            Iceberg = new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatIcebergOptionsArgs
            {
                MetadataLocation = "string",
            },
            Json = new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatJsonOptionsArgs
            {
                Encoding = "string",
            },
        },
        Id = "string",
        Description = "string",
        Location = "string",
        Project = "string",
        Etag = "string",
        DisplayName = "string",
        DataPathPattern = "string",
        Zone = "string",
    });
    
    example, err := dataplex.NewEntity(ctx, "google-nativeEntityResource", &dataplex.EntityArgs{
    	LakeId:   pulumi.String("string"),
    	DataPath: pulumi.String("string"),
    	Type:     dataplex.EntityTypeTypeUnspecified,
    	Asset:    pulumi.String("string"),
    	System:   dataplex.EntitySystemStorageSystemUnspecified,
    	Schema: &dataplex.GoogleCloudDataplexV1SchemaArgs{
    		UserManaged: pulumi.Bool(false),
    		Fields: dataplex.GoogleCloudDataplexV1SchemaSchemaFieldArray{
    			&dataplex.GoogleCloudDataplexV1SchemaSchemaFieldArgs{
    				Mode:        dataplex.GoogleCloudDataplexV1SchemaSchemaFieldModeModeUnspecified,
    				Name:        pulumi.String("string"),
    				Type:        dataplex.GoogleCloudDataplexV1SchemaSchemaFieldTypeTypeUnspecified,
    				Description: pulumi.String("string"),
    				Fields: dataplex.GoogleCloudDataplexV1SchemaSchemaFieldArray{
    					googleCloudDataplexV1SchemaSchemaField,
    				},
    			},
    		},
    		PartitionFields: dataplex.GoogleCloudDataplexV1SchemaPartitionFieldArray{
    			&dataplex.GoogleCloudDataplexV1SchemaPartitionFieldArgs{
    				Name: pulumi.String("string"),
    				Type: dataplex.GoogleCloudDataplexV1SchemaPartitionFieldTypeTypeUnspecified,
    			},
    		},
    		PartitionStyle: dataplex.GoogleCloudDataplexV1SchemaPartitionStylePartitionStyleUnspecified,
    	},
    	Format: &dataplex.GoogleCloudDataplexV1StorageFormatArgs{
    		MimeType:          pulumi.String("string"),
    		CompressionFormat: dataplex.GoogleCloudDataplexV1StorageFormatCompressionFormatCompressionFormatUnspecified,
    		Csv: &dataplex.GoogleCloudDataplexV1StorageFormatCsvOptionsArgs{
    			Delimiter:  pulumi.String("string"),
    			Encoding:   pulumi.String("string"),
    			HeaderRows: pulumi.Int(0),
    			Quote:      pulumi.String("string"),
    		},
    		Iceberg: &dataplex.GoogleCloudDataplexV1StorageFormatIcebergOptionsArgs{
    			MetadataLocation: pulumi.String("string"),
    		},
    		Json: &dataplex.GoogleCloudDataplexV1StorageFormatJsonOptionsArgs{
    			Encoding: pulumi.String("string"),
    		},
    	},
    	Id:              pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Location:        pulumi.String("string"),
    	Project:         pulumi.String("string"),
    	Etag:            pulumi.String("string"),
    	DisplayName:     pulumi.String("string"),
    	DataPathPattern: pulumi.String("string"),
    	Zone:            pulumi.String("string"),
    })
    
    resource "google-native_dataplex_v1_entity" "google-nativeEntityResource" {
      lifecycle {
        create_before_destroy = true
      }
      lake_id   = "string"
      data_path = "string"
      type      = "TYPE_UNSPECIFIED"
      asset     = "string"
      system    = "STORAGE_SYSTEM_UNSPECIFIED"
      schema = {
        user_managed = false
        fields = [{
          mode        = "MODE_UNSPECIFIED"
          name        = "string"
          type        = "TYPE_UNSPECIFIED"
          description = "string"
          fields      = [googleCloudDataplexV1SchemaSchemaField]
        }]
        partition_fields = [{
          name = "string"
          type = "TYPE_UNSPECIFIED"
        }]
        partition_style = "PARTITION_STYLE_UNSPECIFIED"
      }
      format = {
        mime_type          = "string"
        compression_format = "COMPRESSION_FORMAT_UNSPECIFIED"
        csv = {
          delimiter   = "string"
          encoding    = "string"
          header_rows = 0
          quote       = "string"
        }
        iceberg = {
          metadata_location = "string"
        }
        json = {
          encoding = "string"
        }
      }
      id                = "string"
      description       = "string"
      location          = "string"
      project           = "string"
      etag              = "string"
      display_name      = "string"
      data_path_pattern = "string"
      zone              = "string"
    }
    
    var google_nativeEntityResource = new com.pulumi.googlenative.dataplex_v1.Entity("google-nativeEntityResource", com.pulumi.googlenative.dataplex_v1.EntityArgs.builder()
        .lakeId("string")
        .dataPath("string")
        .type(com.pulumi.googlenative.dataplex_v1.enums.EntityType.TypeUnspecified)
        .asset("string")
        .system(com.pulumi.googlenative.dataplex_v1.enums.EntitySystem.StorageSystemUnspecified)
        .schema(GoogleCloudDataplexV1SchemaArgs.builder()
            .userManaged(false)
            .fields(GoogleCloudDataplexV1SchemaSchemaFieldArgs.builder()
                .mode(com.pulumi.googlenative.dataplex_v1.enums.GoogleCloudDataplexV1SchemaSchemaFieldMode.ModeUnspecified)
                .name("string")
                .type(com.pulumi.googlenative.dataplex_v1.enums.GoogleCloudDataplexV1SchemaSchemaFieldType.TypeUnspecified)
                .description("string")
                .fields(googleCloudDataplexV1SchemaSchemaField)
                .build())
            .partitionFields(GoogleCloudDataplexV1SchemaPartitionFieldArgs.builder()
                .name("string")
                .type(com.pulumi.googlenative.dataplex_v1.enums.GoogleCloudDataplexV1SchemaPartitionFieldType.TypeUnspecified)
                .build())
            .partitionStyle(com.pulumi.googlenative.dataplex_v1.enums.GoogleCloudDataplexV1SchemaPartitionStyle.PartitionStyleUnspecified)
            .build())
        .format(GoogleCloudDataplexV1StorageFormatArgs.builder()
            .mimeType("string")
            .compressionFormat(com.pulumi.googlenative.dataplex_v1.enums.GoogleCloudDataplexV1StorageFormatCompressionFormat.CompressionFormatUnspecified)
            .csv(GoogleCloudDataplexV1StorageFormatCsvOptionsArgs.builder()
                .delimiter("string")
                .encoding("string")
                .headerRows(0)
                .quote("string")
                .build())
            .iceberg(GoogleCloudDataplexV1StorageFormatIcebergOptionsArgs.builder()
                .metadataLocation("string")
                .build())
            .json(GoogleCloudDataplexV1StorageFormatJsonOptionsArgs.builder()
                .encoding("string")
                .build())
            .build())
        .id("string")
        .description("string")
        .location("string")
        .project("string")
        .etag("string")
        .displayName("string")
        .dataPathPattern("string")
        .zone("string")
        .build());
    
    google_native_entity_resource = google_native.dataplex.v1.Entity("google-nativeEntityResource",
        lake_id="string",
        data_path="string",
        type=google_native.dataplex.v1.EntityType.TYPE_UNSPECIFIED,
        asset="string",
        system=google_native.dataplex.v1.EntitySystem.STORAGE_SYSTEM_UNSPECIFIED,
        schema={
            "user_managed": False,
            "fields": [{
                "mode": google_native.dataplex.v1.GoogleCloudDataplexV1SchemaSchemaFieldMode.MODE_UNSPECIFIED,
                "name": "string",
                "type": google_native.dataplex.v1.GoogleCloudDataplexV1SchemaSchemaFieldType.TYPE_UNSPECIFIED,
                "description": "string",
                "fields": [google_cloud_dataplex_v1_schema_schema_field],
            }],
            "partition_fields": [{
                "name": "string",
                "type": google_native.dataplex.v1.GoogleCloudDataplexV1SchemaPartitionFieldType.TYPE_UNSPECIFIED,
            }],
            "partition_style": google_native.dataplex.v1.GoogleCloudDataplexV1SchemaPartitionStyle.PARTITION_STYLE_UNSPECIFIED,
        },
        format={
            "mime_type": "string",
            "compression_format": google_native.dataplex.v1.GoogleCloudDataplexV1StorageFormatCompressionFormat.COMPRESSION_FORMAT_UNSPECIFIED,
            "csv": {
                "delimiter": "string",
                "encoding": "string",
                "header_rows": 0,
                "quote": "string",
            },
            "iceberg": {
                "metadata_location": "string",
            },
            "json": {
                "encoding": "string",
            },
        },
        id="string",
        description="string",
        location="string",
        project="string",
        etag="string",
        display_name="string",
        data_path_pattern="string",
        zone="string")
    
    const google_nativeEntityResource = new google_native.dataplex.v1.Entity("google-nativeEntityResource", {
        lakeId: "string",
        dataPath: "string",
        type: google_native.dataplex.v1.EntityType.TypeUnspecified,
        asset: "string",
        system: google_native.dataplex.v1.EntitySystem.StorageSystemUnspecified,
        schema: {
            userManaged: false,
            fields: [{
                mode: google_native.dataplex.v1.GoogleCloudDataplexV1SchemaSchemaFieldMode.ModeUnspecified,
                name: "string",
                type: google_native.dataplex.v1.GoogleCloudDataplexV1SchemaSchemaFieldType.TypeUnspecified,
                description: "string",
                fields: [googleCloudDataplexV1SchemaSchemaField],
            }],
            partitionFields: [{
                name: "string",
                type: google_native.dataplex.v1.GoogleCloudDataplexV1SchemaPartitionFieldType.TypeUnspecified,
            }],
            partitionStyle: google_native.dataplex.v1.GoogleCloudDataplexV1SchemaPartitionStyle.PartitionStyleUnspecified,
        },
        format: {
            mimeType: "string",
            compressionFormat: google_native.dataplex.v1.GoogleCloudDataplexV1StorageFormatCompressionFormat.CompressionFormatUnspecified,
            csv: {
                delimiter: "string",
                encoding: "string",
                headerRows: 0,
                quote: "string",
            },
            iceberg: {
                metadataLocation: "string",
            },
            json: {
                encoding: "string",
            },
        },
        id: "string",
        description: "string",
        location: "string",
        project: "string",
        etag: "string",
        displayName: "string",
        dataPathPattern: "string",
        zone: "string",
    });
    
    type: google-native:dataplex/v1:Entity
    properties:
        asset: string
        dataPath: string
        dataPathPattern: string
        description: string
        displayName: string
        etag: string
        format:
            compressionFormat: COMPRESSION_FORMAT_UNSPECIFIED
            csv:
                delimiter: string
                encoding: string
                headerRows: 0
                quote: string
            iceberg:
                metadataLocation: string
            json:
                encoding: string
            mimeType: string
        id: string
        lakeId: string
        location: string
        project: string
        schema:
            fields:
                - description: string
                  fields:
                    - ${googleCloudDataplexV1SchemaSchemaField}
                  mode: MODE_UNSPECIFIED
                  name: string
                  type: TYPE_UNSPECIFIED
            partitionFields:
                - name: string
                  type: TYPE_UNSPECIFIED
            partitionStyle: PARTITION_STYLE_UNSPECIFIED
            userManaged: false
        system: STORAGE_SYSTEM_UNSPECIFIED
        type: TYPE_UNSPECIFIED
        zone: string
    

    Entity Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Entity resource accepts the following input properties:

    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.
    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.
    Format Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormat
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    Id string
    A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
    LakeId string
    Schema Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1Schema
    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 Pulumi.GoogleNative.Dataplex.V1.EntitySystem
    Immutable. Identifies the storage system of the entity data.
    Type Pulumi.GoogleNative.Dataplex.V1.EntityType
    Immutable. The type of entity.
    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.
    Location string
    Project string
    Zone string
    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.
    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.
    Format GoogleCloudDataplexV1StorageFormatArgs
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    Id string
    A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
    LakeId string
    Schema GoogleCloudDataplexV1SchemaArgs
    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 EntitySystem
    Immutable. Identifies the storage system of the entity data.
    Type EntityType
    Immutable. The type of entity.
    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.
    Location string
    Project string
    Zone string
    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.
    data_path 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.
    format object
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    id string
    A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
    lake_id string
    schema object
    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 "STORAGE_SYSTEM_UNSPECIFIED" | "CLOUD_STORAGE" | "BIGQUERY"
    Immutable. Identifies the storage system of the entity data.
    type "TYPE_UNSPECIFIED" | "TABLE" | "FILESET"
    Immutable. The type of entity.
    data_path_pattern 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.
    display_name 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.
    location string
    project string
    zone string
    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.
    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.
    format GoogleCloudDataplexV1StorageFormat
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    id String
    A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
    lakeId String
    schema GoogleCloudDataplexV1Schema
    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 EntitySystem
    Immutable. Identifies the storage system of the entity data.
    type EntityType
    Immutable. The type of entity.
    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.
    location String
    project String
    zone String
    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.
    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.
    format GoogleCloudDataplexV1StorageFormat
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    id string
    A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
    lakeId string
    schema GoogleCloudDataplexV1Schema
    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 EntitySystem
    Immutable. Identifies the storage system of the entity data.
    type EntityType
    Immutable. The type of entity.
    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.
    location string
    project string
    zone string
    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.
    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.
    format GoogleCloudDataplexV1StorageFormatArgs
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    id str
    A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
    lake_id str
    schema GoogleCloudDataplexV1SchemaArgs
    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 EntitySystem
    Immutable. Identifies the storage system of the entity data.
    type EntityType
    Immutable. The type of entity.
    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.
    location str
    project str
    zone str
    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.
    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.
    format Property Map
    Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
    id String
    A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
    lakeId String
    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 "STORAGE_SYSTEM_UNSPECIFIED" | "CLOUD_STORAGE" | "BIGQUERY"
    Immutable. Identifies the storage system of the entity data.
    type "TYPE_UNSPECIFIED" | "TABLE" | "FILESET"
    Immutable. The type of entity.
    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.
    location String
    project String
    zone String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Entity resource produces the following output properties:

    Access Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1StorageAccessResponse
    Identifies the access mechanism to the entity. Not user settable.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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}.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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}.
    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 object
    Identifies the access mechanism to the entity. Not user settable.
    catalog_entry string
    The name of the associated Data Catalog entry.
    compatibility object
    Metadata stores that the entity is compatible with.
    create_time string
    The time when the entity was created.
    id string
    The provider-assigned unique ID for this managed resource.
    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}.
    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.
    update_time string
    The time when the entity was last updated.
    access GoogleCloudDataplexV1StorageAccessResponse
    Identifies the access mechanism to the entity. Not user settable.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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}.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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}.
    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.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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}.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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}.
    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.

    Look up Existing Entity Resource

    Get an existing Entity resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Entity
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Entity
    func GetEntity(ctx *Context, name string, id IDInput, state *EntityState, opts ...ResourceOption) (*Entity, error)
    public static Entity Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Entity get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingEntity:    type: google-native:dataplex/v1:Entity    get:      id: ${id}
    import {
      to = google-native_dataplex_v1_entity.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state EntityState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    EntitySystem, EntitySystemArgs

    Required. Immutable. Identifies the storage system of the entity data.
    NameValueDescription
    StorageSystemUnspecifiedSTORAGE_SYSTEM_UNSPECIFIEDStorage system unspecified.
    CloudStorageCLOUD_STORAGEThe entity data is contained within a Cloud Storage bucket.
    BigqueryBIGQUERYThe entity data is contained within a BigQuery dataset.
    NameValueDescription
    EntitySystemStorageSystemUnspecifiedSTORAGE_SYSTEM_UNSPECIFIEDStorage system unspecified.
    EntitySystemCloudStorageCLOUD_STORAGEThe entity data is contained within a Cloud Storage bucket.
    EntitySystemBigqueryBIGQUERYThe entity data is contained within a BigQuery dataset.
    ValueDescription
    STORAGE_SYSTEM_UNSPECIFIEDStorage system unspecified.
    CLOUD_STORAGEThe entity data is contained within a Cloud Storage bucket.
    BIGQUERYThe entity data is contained within a BigQuery dataset.
    NameValueDescription
    StorageSystemUnspecifiedSTORAGE_SYSTEM_UNSPECIFIEDStorage system unspecified.
    CloudStorageCLOUD_STORAGEThe entity data is contained within a Cloud Storage bucket.
    BigqueryBIGQUERYThe entity data is contained within a BigQuery dataset.
    NameValueDescription
    StorageSystemUnspecifiedSTORAGE_SYSTEM_UNSPECIFIEDStorage system unspecified.
    CloudStorageCLOUD_STORAGEThe entity data is contained within a Cloud Storage bucket.
    BigqueryBIGQUERYThe entity data is contained within a BigQuery dataset.
    NameValueDescription
    STORAGE_SYSTEM_UNSPECIFIEDSTORAGE_SYSTEM_UNSPECIFIEDStorage system unspecified.
    CLOUD_STORAGECLOUD_STORAGEThe entity data is contained within a Cloud Storage bucket.
    BIGQUERYBIGQUERYThe entity data is contained within a BigQuery dataset.
    ValueDescription
    STORAGE_SYSTEM_UNSPECIFIEDStorage system unspecified.
    CLOUD_STORAGEThe entity data is contained within a Cloud Storage bucket.
    BIGQUERYThe entity data is contained within a BigQuery dataset.

    EntityType, EntityTypeArgs

    Required. Immutable. The type of entity.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDType unspecified.
    TableTABLEStructured and semi-structured data.
    FilesetFILESETUnstructured data.
    NameValueDescription
    EntityTypeTypeUnspecifiedTYPE_UNSPECIFIEDType unspecified.
    EntityTypeTableTABLEStructured and semi-structured data.
    EntityTypeFilesetFILESETUnstructured data.
    ValueDescription
    TYPE_UNSPECIFIEDType unspecified.
    TABLEStructured and semi-structured data.
    FILESETUnstructured data.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDType unspecified.
    TableTABLEStructured and semi-structured data.
    FilesetFILESETUnstructured data.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDType unspecified.
    TableTABLEStructured and semi-structured data.
    FilesetFILESETUnstructured data.
    NameValueDescription
    TYPE_UNSPECIFIEDTYPE_UNSPECIFIEDType unspecified.
    TABLETABLEStructured and semi-structured data.
    FILESETFILESETUnstructured data.
    ValueDescription
    TYPE_UNSPECIFIEDType unspecified.
    TABLEStructured and semi-structured data.
    FILESETUnstructured data.

    GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse, GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponseArgs

    Provides compatibility information for a specific 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 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, GoogleCloudDataplexV1EntityCompatibilityStatusResponseArgs

    Provides compatibility information for various metadata stores.
    Bigquery GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with BigQuery.
    HiveMetastore GoogleCloudDataplexV1EntityCompatibilityStatusCompatibilityResponse
    Whether this entity is compatible with Hive Metastore.
    bigquery object
    Whether this entity is compatible with BigQuery.
    hive_metastore object
    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.

    GoogleCloudDataplexV1Schema, GoogleCloudDataplexV1SchemaArgs

    Schema information describing the structure and layout of the data.
    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<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaSchemaField>
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    PartitionFields List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaPartitionField>
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    PartitionStyle Pulumi.GoogleNative.Dataplex.V1.GoogleCloudDataplexV1SchemaPartitionStyle
    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 []GoogleCloudDataplexV1SchemaSchemaField
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    PartitionFields []GoogleCloudDataplexV1SchemaPartitionField
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    PartitionStyle GoogleCloudDataplexV1SchemaPartitionStyle
    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(object)
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partition_fields list(object)
    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 "PARTITION_STYLE_UNSPECIFIED" | "HIVE_COMPATIBLE"
    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 List<GoogleCloudDataplexV1SchemaSchemaField>
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partitionFields List<GoogleCloudDataplexV1SchemaPartitionField>
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    partitionStyle GoogleCloudDataplexV1SchemaPartitionStyle
    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 GoogleCloudDataplexV1SchemaSchemaField[]
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partitionFields GoogleCloudDataplexV1SchemaPartitionField[]
    Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
    partitionStyle GoogleCloudDataplexV1SchemaPartitionStyle
    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 Sequence[GoogleCloudDataplexV1SchemaSchemaField]
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partition_fields Sequence[GoogleCloudDataplexV1SchemaPartitionField]
    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 GoogleCloudDataplexV1SchemaPartitionStyle
    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 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 "PARTITION_STYLE_UNSPECIFIED" | "HIVE_COMPATIBLE"
    Optional. The structure of paths containing partition data within the entity.

    GoogleCloudDataplexV1SchemaPartitionField, GoogleCloudDataplexV1SchemaPartitionFieldArgs

    Represents a key field within the entity's partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.
    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 Pulumi.GoogleNative.Dataplex.V1.GoogleCloudDataplexV1SchemaPartitionFieldType
    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 GoogleCloudDataplexV1SchemaPartitionFieldType
    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 "TYPE_UNSPECIFIED" | "BOOLEAN" | "BYTE" | "INT16" | "INT32" | "INT64" | "FLOAT" | "DOUBLE" | "DECIMAL" | "STRING" | "BINARY" | "TIMESTAMP" | "DATE" | "TIME" | "RECORD" | "NULL"
    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 GoogleCloudDataplexV1SchemaPartitionFieldType
    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 GoogleCloudDataplexV1SchemaPartitionFieldType
    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 GoogleCloudDataplexV1SchemaPartitionFieldType
    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 "TYPE_UNSPECIFIED" | "BOOLEAN" | "BYTE" | "INT16" | "INT32" | "INT64" | "FLOAT" | "DOUBLE" | "DECIMAL" | "STRING" | "BINARY" | "TIMESTAMP" | "DATE" | "TIME" | "RECORD" | "NULL"
    Immutable. The type of field.

    GoogleCloudDataplexV1SchemaPartitionFieldResponse, GoogleCloudDataplexV1SchemaPartitionFieldResponseArgs

    Represents a key field within the entity's partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.
    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 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.

    GoogleCloudDataplexV1SchemaPartitionFieldType, GoogleCloudDataplexV1SchemaPartitionFieldTypeArgs

    Required. Immutable. The type of field.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDSchemaType unspecified.
    BooleanBOOLEANBoolean field.
    ByteBYTESingle byte numeric field.
    Int16INT1616-bit numeric field.
    Int32INT3232-bit numeric field.
    Int64INT6464-bit numeric field.
    FloatFLOATFloating point numeric field.
    DoubleDOUBLEDouble precision numeric field.
    DecimalDECIMALReal value numeric field.
    StringSTRINGSequence of characters field.
    BinaryBINARYSequence of bytes field.
    TimestampTIMESTAMPDate and time field.
    DateDATEDate field.
    TimeTIMETime field.
    RecordRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NullNULLNull field that does not have values.
    NameValueDescription
    GoogleCloudDataplexV1SchemaPartitionFieldTypeTypeUnspecifiedTYPE_UNSPECIFIEDSchemaType unspecified.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeBooleanBOOLEANBoolean field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeByteBYTESingle byte numeric field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeInt16INT1616-bit numeric field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeInt32INT3232-bit numeric field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeInt64INT6464-bit numeric field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeFloatFLOATFloating point numeric field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeDoubleDOUBLEDouble precision numeric field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeDecimalDECIMALReal value numeric field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeStringSTRINGSequence of characters field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeBinaryBINARYSequence of bytes field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeTimestampTIMESTAMPDate and time field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeDateDATEDate field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeTimeTIMETime field.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeRecordRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    GoogleCloudDataplexV1SchemaPartitionFieldTypeNullNULLNull field that does not have values.
    ValueDescription
    TYPE_UNSPECIFIEDSchemaType unspecified.
    BOOLEANBoolean field.
    BYTESingle byte numeric field.
    INT1616-bit numeric field.
    INT3232-bit numeric field.
    INT6464-bit numeric field.
    FLOATFloating point numeric field.
    DOUBLEDouble precision numeric field.
    DECIMALReal value numeric field.
    STRINGSequence of characters field.
    BINARYSequence of bytes field.
    TIMESTAMPDate and time field.
    DATEDate field.
    TIMETime field.
    RECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NULLNull field that does not have values.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDSchemaType unspecified.
    BooleanBOOLEANBoolean field.
    ByteBYTESingle byte numeric field.
    Int16INT1616-bit numeric field.
    Int32INT3232-bit numeric field.
    Int64INT6464-bit numeric field.
    FloatFLOATFloating point numeric field.
    DoubleDOUBLEDouble precision numeric field.
    DecimalDECIMALReal value numeric field.
    StringSTRINGSequence of characters field.
    BinaryBINARYSequence of bytes field.
    TimestampTIMESTAMPDate and time field.
    DateDATEDate field.
    TimeTIMETime field.
    RecordRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NullNULLNull field that does not have values.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDSchemaType unspecified.
    BooleanBOOLEANBoolean field.
    ByteBYTESingle byte numeric field.
    Int16INT1616-bit numeric field.
    Int32INT3232-bit numeric field.
    Int64INT6464-bit numeric field.
    FloatFLOATFloating point numeric field.
    DoubleDOUBLEDouble precision numeric field.
    DecimalDECIMALReal value numeric field.
    StringSTRINGSequence of characters field.
    BinaryBINARYSequence of bytes field.
    TimestampTIMESTAMPDate and time field.
    DateDATEDate field.
    TimeTIMETime field.
    RecordRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NullNULLNull field that does not have values.
    NameValueDescription
    TYPE_UNSPECIFIEDTYPE_UNSPECIFIEDSchemaType unspecified.
    BOOLEANBOOLEANBoolean field.
    BYTEBYTESingle byte numeric field.
    INT16INT1616-bit numeric field.
    INT32INT3232-bit numeric field.
    INT64INT6464-bit numeric field.
    FLOATFLOATFloating point numeric field.
    DOUBLEDOUBLEDouble precision numeric field.
    DECIMALDECIMALReal value numeric field.
    STRINGSTRINGSequence of characters field.
    BINARYBINARYSequence of bytes field.
    TIMESTAMPTIMESTAMPDate and time field.
    DATEDATEDate field.
    TIMETIMETime field.
    RECORDRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NULLNULLNull field that does not have values.
    ValueDescription
    TYPE_UNSPECIFIEDSchemaType unspecified.
    BOOLEANBoolean field.
    BYTESingle byte numeric field.
    INT1616-bit numeric field.
    INT3232-bit numeric field.
    INT6464-bit numeric field.
    FLOATFloating point numeric field.
    DOUBLEDouble precision numeric field.
    DECIMALReal value numeric field.
    STRINGSequence of characters field.
    BINARYSequence of bytes field.
    TIMESTAMPDate and time field.
    DATEDate field.
    TIMETime field.
    RECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NULLNull field that does not have values.

    GoogleCloudDataplexV1SchemaPartitionStyle, GoogleCloudDataplexV1SchemaPartitionStyleArgs

    Optional. The structure of paths containing partition data within the entity.
    NameValueDescription
    PartitionStyleUnspecifiedPARTITION_STYLE_UNSPECIFIEDPartitionStyle unspecified
    HiveCompatibleHIVE_COMPATIBLEPartitions are hive-compatible. Examples: gs://bucket/path/to/table/dt=2019-10-31/lang=en, gs://bucket/path/to/table/dt=2019-10-31/lang=en/late.
    NameValueDescription
    GoogleCloudDataplexV1SchemaPartitionStylePartitionStyleUnspecifiedPARTITION_STYLE_UNSPECIFIEDPartitionStyle unspecified
    GoogleCloudDataplexV1SchemaPartitionStyleHiveCompatibleHIVE_COMPATIBLEPartitions are hive-compatible. Examples: gs://bucket/path/to/table/dt=2019-10-31/lang=en, gs://bucket/path/to/table/dt=2019-10-31/lang=en/late.
    ValueDescription
    PARTITION_STYLE_UNSPECIFIEDPartitionStyle unspecified
    HIVE_COMPATIBLEPartitions are hive-compatible. Examples: gs://bucket/path/to/table/dt=2019-10-31/lang=en, gs://bucket/path/to/table/dt=2019-10-31/lang=en/late.
    NameValueDescription
    PartitionStyleUnspecifiedPARTITION_STYLE_UNSPECIFIEDPartitionStyle unspecified
    HiveCompatibleHIVE_COMPATIBLEPartitions are hive-compatible. Examples: gs://bucket/path/to/table/dt=2019-10-31/lang=en, gs://bucket/path/to/table/dt=2019-10-31/lang=en/late.
    NameValueDescription
    PartitionStyleUnspecifiedPARTITION_STYLE_UNSPECIFIEDPartitionStyle unspecified
    HiveCompatibleHIVE_COMPATIBLEPartitions are hive-compatible. Examples: gs://bucket/path/to/table/dt=2019-10-31/lang=en, gs://bucket/path/to/table/dt=2019-10-31/lang=en/late.
    NameValueDescription
    PARTITION_STYLE_UNSPECIFIEDPARTITION_STYLE_UNSPECIFIEDPartitionStyle unspecified
    HIVE_COMPATIBLEHIVE_COMPATIBLEPartitions are hive-compatible. Examples: gs://bucket/path/to/table/dt=2019-10-31/lang=en, gs://bucket/path/to/table/dt=2019-10-31/lang=en/late.
    ValueDescription
    PARTITION_STYLE_UNSPECIFIEDPartitionStyle unspecified
    HIVE_COMPATIBLEPartitions are hive-compatible. Examples: gs://bucket/path/to/table/dt=2019-10-31/lang=en, gs://bucket/path/to/table/dt=2019-10-31/lang=en/late.

    GoogleCloudDataplexV1SchemaResponse, GoogleCloudDataplexV1SchemaResponseArgs

    Schema information describing the structure and layout of the data.
    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(object)
    Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
    partition_fields list(object)
    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 string
    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<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.

    GoogleCloudDataplexV1SchemaSchemaField, GoogleCloudDataplexV1SchemaSchemaFieldArgs

    Represents a column field within a table schema.
    Mode Pulumi.GoogleNative.Dataplex.V1.GoogleCloudDataplexV1SchemaSchemaFieldMode
    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 Pulumi.GoogleNative.Dataplex.V1.GoogleCloudDataplexV1SchemaSchemaFieldType
    The type of field.
    Description string
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    Fields List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1SchemaSchemaField>
    Optional. Any nested field for complex types.
    Mode GoogleCloudDataplexV1SchemaSchemaFieldMode
    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 GoogleCloudDataplexV1SchemaSchemaFieldType
    The type of field.
    Description string
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    Fields []GoogleCloudDataplexV1SchemaSchemaField
    Optional. Any nested field for complex types.
    mode "MODE_UNSPECIFIED" | "REQUIRED" | "NULLABLE" | "REPEATED"
    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 "TYPE_UNSPECIFIED" | "BOOLEAN" | "BYTE" | "INT16" | "INT32" | "INT64" | "FLOAT" | "DOUBLE" | "DECIMAL" | "STRING" | "BINARY" | "TIMESTAMP" | "DATE" | "TIME" | "RECORD" | "NULL"
    The type of field.
    description string
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    fields list(object)
    Optional. Any nested field for complex types.
    mode GoogleCloudDataplexV1SchemaSchemaFieldMode
    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 GoogleCloudDataplexV1SchemaSchemaFieldType
    The type of field.
    description String
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    fields List<GoogleCloudDataplexV1SchemaSchemaField>
    Optional. Any nested field for complex types.
    mode GoogleCloudDataplexV1SchemaSchemaFieldMode
    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 GoogleCloudDataplexV1SchemaSchemaFieldType
    The type of field.
    description string
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    fields GoogleCloudDataplexV1SchemaSchemaField[]
    Optional. Any nested field for complex types.
    mode GoogleCloudDataplexV1SchemaSchemaFieldMode
    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 GoogleCloudDataplexV1SchemaSchemaFieldType
    The type of field.
    description str
    Optional. User friendly field description. Must be less than or equal to 1024 characters.
    fields Sequence[GoogleCloudDataplexV1SchemaSchemaField]
    Optional. Any nested field for complex types.
    mode "MODE_UNSPECIFIED" | "REQUIRED" | "NULLABLE" | "REPEATED"
    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 "TYPE_UNSPECIFIED" | "BOOLEAN" | "BYTE" | "INT16" | "INT32" | "INT64" | "FLOAT" | "DOUBLE" | "DECIMAL" | "STRING" | "BINARY" | "TIMESTAMP" | "DATE" | "TIME" | "RECORD" | "NULL"
    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.

    GoogleCloudDataplexV1SchemaSchemaFieldMode, GoogleCloudDataplexV1SchemaSchemaFieldModeArgs

    Required. Additional field semantics.
    NameValueDescription
    ModeUnspecifiedMODE_UNSPECIFIEDMode unspecified.
    RequiredREQUIREDThe field has required semantics.
    NullableNULLABLEThe field has optional semantics, and may be null.
    RepeatedREPEATEDThe field has repeated (0 or more) semantics, and is a list of values.
    NameValueDescription
    GoogleCloudDataplexV1SchemaSchemaFieldModeModeUnspecifiedMODE_UNSPECIFIEDMode unspecified.
    GoogleCloudDataplexV1SchemaSchemaFieldModeRequiredREQUIREDThe field has required semantics.
    GoogleCloudDataplexV1SchemaSchemaFieldModeNullableNULLABLEThe field has optional semantics, and may be null.
    GoogleCloudDataplexV1SchemaSchemaFieldModeRepeatedREPEATEDThe field has repeated (0 or more) semantics, and is a list of values.
    ValueDescription
    MODE_UNSPECIFIEDMode unspecified.
    REQUIREDThe field has required semantics.
    NULLABLEThe field has optional semantics, and may be null.
    REPEATEDThe field has repeated (0 or more) semantics, and is a list of values.
    NameValueDescription
    ModeUnspecifiedMODE_UNSPECIFIEDMode unspecified.
    RequiredREQUIREDThe field has required semantics.
    NullableNULLABLEThe field has optional semantics, and may be null.
    RepeatedREPEATEDThe field has repeated (0 or more) semantics, and is a list of values.
    NameValueDescription
    ModeUnspecifiedMODE_UNSPECIFIEDMode unspecified.
    RequiredREQUIREDThe field has required semantics.
    NullableNULLABLEThe field has optional semantics, and may be null.
    RepeatedREPEATEDThe field has repeated (0 or more) semantics, and is a list of values.
    NameValueDescription
    MODE_UNSPECIFIEDMODE_UNSPECIFIEDMode unspecified.
    REQUIREDREQUIREDThe field has required semantics.
    NULLABLENULLABLEThe field has optional semantics, and may be null.
    REPEATEDREPEATEDThe field has repeated (0 or more) semantics, and is a list of values.
    ValueDescription
    MODE_UNSPECIFIEDMode unspecified.
    REQUIREDThe field has required semantics.
    NULLABLEThe field has optional semantics, and may be null.
    REPEATEDThe field has repeated (0 or more) semantics, and is a list of values.

    GoogleCloudDataplexV1SchemaSchemaFieldResponse, GoogleCloudDataplexV1SchemaSchemaFieldResponseArgs

    Represents a column field within a table schema.
    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(object)
    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.

    GoogleCloudDataplexV1SchemaSchemaFieldType, GoogleCloudDataplexV1SchemaSchemaFieldTypeArgs

    Required. The type of field.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDSchemaType unspecified.
    BooleanBOOLEANBoolean field.
    ByteBYTESingle byte numeric field.
    Int16INT1616-bit numeric field.
    Int32INT3232-bit numeric field.
    Int64INT6464-bit numeric field.
    FloatFLOATFloating point numeric field.
    DoubleDOUBLEDouble precision numeric field.
    DecimalDECIMALReal value numeric field.
    StringSTRINGSequence of characters field.
    BinaryBINARYSequence of bytes field.
    TimestampTIMESTAMPDate and time field.
    DateDATEDate field.
    TimeTIMETime field.
    RecordRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NullNULLNull field that does not have values.
    NameValueDescription
    GoogleCloudDataplexV1SchemaSchemaFieldTypeTypeUnspecifiedTYPE_UNSPECIFIEDSchemaType unspecified.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeBooleanBOOLEANBoolean field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeByteBYTESingle byte numeric field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeInt16INT1616-bit numeric field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeInt32INT3232-bit numeric field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeInt64INT6464-bit numeric field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeFloatFLOATFloating point numeric field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeDoubleDOUBLEDouble precision numeric field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeDecimalDECIMALReal value numeric field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeStringSTRINGSequence of characters field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeBinaryBINARYSequence of bytes field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeTimestampTIMESTAMPDate and time field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeDateDATEDate field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeTimeTIMETime field.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeRecordRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    GoogleCloudDataplexV1SchemaSchemaFieldTypeNullNULLNull field that does not have values.
    ValueDescription
    TYPE_UNSPECIFIEDSchemaType unspecified.
    BOOLEANBoolean field.
    BYTESingle byte numeric field.
    INT1616-bit numeric field.
    INT3232-bit numeric field.
    INT6464-bit numeric field.
    FLOATFloating point numeric field.
    DOUBLEDouble precision numeric field.
    DECIMALReal value numeric field.
    STRINGSequence of characters field.
    BINARYSequence of bytes field.
    TIMESTAMPDate and time field.
    DATEDate field.
    TIMETime field.
    RECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NULLNull field that does not have values.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDSchemaType unspecified.
    BooleanBOOLEANBoolean field.
    ByteBYTESingle byte numeric field.
    Int16INT1616-bit numeric field.
    Int32INT3232-bit numeric field.
    Int64INT6464-bit numeric field.
    FloatFLOATFloating point numeric field.
    DoubleDOUBLEDouble precision numeric field.
    DecimalDECIMALReal value numeric field.
    StringSTRINGSequence of characters field.
    BinaryBINARYSequence of bytes field.
    TimestampTIMESTAMPDate and time field.
    DateDATEDate field.
    TimeTIMETime field.
    RecordRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NullNULLNull field that does not have values.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDSchemaType unspecified.
    BooleanBOOLEANBoolean field.
    ByteBYTESingle byte numeric field.
    Int16INT1616-bit numeric field.
    Int32INT3232-bit numeric field.
    Int64INT6464-bit numeric field.
    FloatFLOATFloating point numeric field.
    DoubleDOUBLEDouble precision numeric field.
    DecimalDECIMALReal value numeric field.
    StringSTRINGSequence of characters field.
    BinaryBINARYSequence of bytes field.
    TimestampTIMESTAMPDate and time field.
    DateDATEDate field.
    TimeTIMETime field.
    RecordRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NullNULLNull field that does not have values.
    NameValueDescription
    TYPE_UNSPECIFIEDTYPE_UNSPECIFIEDSchemaType unspecified.
    BOOLEANBOOLEANBoolean field.
    BYTEBYTESingle byte numeric field.
    INT16INT1616-bit numeric field.
    INT32INT3232-bit numeric field.
    INT64INT6464-bit numeric field.
    FLOATFLOATFloating point numeric field.
    DOUBLEDOUBLEDouble precision numeric field.
    DECIMALDECIMALReal value numeric field.
    STRINGSTRINGSequence of characters field.
    BINARYBINARYSequence of bytes field.
    TIMESTAMPTIMESTAMPDate and time field.
    DATEDATEDate field.
    TIMETIMETime field.
    RECORDRECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NULLNULLNull field that does not have values.
    ValueDescription
    TYPE_UNSPECIFIEDSchemaType unspecified.
    BOOLEANBoolean field.
    BYTESingle byte numeric field.
    INT1616-bit numeric field.
    INT3232-bit numeric field.
    INT6464-bit numeric field.
    FLOATFloating point numeric field.
    DOUBLEDouble precision numeric field.
    DECIMALReal value numeric field.
    STRINGSequence of characters field.
    BINARYSequence of bytes field.
    TIMESTAMPDate and time field.
    DATEDate field.
    TIMETime field.
    RECORDStructured field. Nested fields that define the structure of the map. If all nested fields are nullable, this field represents a union.
    NULLNull field that does not have values.

    GoogleCloudDataplexV1StorageAccessResponse, GoogleCloudDataplexV1StorageAccessResponseArgs

    Describes the access mechanism of the data within its storage location.
    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 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.

    GoogleCloudDataplexV1StorageFormat, GoogleCloudDataplexV1StorageFormatArgs

    Describes the format of the data within its storage location.
    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 Pulumi.GoogleNative.Dataplex.V1.GoogleCloudDataplexV1StorageFormatCompressionFormat
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    Csv Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatCsvOptions
    Optional. Additional information about CSV formatted data.
    Iceberg Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatIcebergOptions
    Optional. Additional information about iceberg tables.
    Json Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1StorageFormatJsonOptions
    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 GoogleCloudDataplexV1StorageFormatCompressionFormat
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    Csv GoogleCloudDataplexV1StorageFormatCsvOptions
    Optional. Additional information about CSV formatted data.
    Iceberg GoogleCloudDataplexV1StorageFormatIcebergOptions
    Optional. Additional information about iceberg tables.
    Json GoogleCloudDataplexV1StorageFormatJsonOptions
    Optional. Additional information about CSV formatted data.
    mime_type 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 "COMPRESSION_FORMAT_UNSPECIFIED" | "GZIP" | "BZIP2"
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv object
    Optional. Additional information about CSV formatted data.
    iceberg object
    Optional. Additional information about iceberg tables.
    json object
    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 GoogleCloudDataplexV1StorageFormatCompressionFormat
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv GoogleCloudDataplexV1StorageFormatCsvOptions
    Optional. Additional information about CSV formatted data.
    iceberg GoogleCloudDataplexV1StorageFormatIcebergOptions
    Optional. Additional information about iceberg tables.
    json GoogleCloudDataplexV1StorageFormatJsonOptions
    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 GoogleCloudDataplexV1StorageFormatCompressionFormat
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv GoogleCloudDataplexV1StorageFormatCsvOptions
    Optional. Additional information about CSV formatted data.
    iceberg GoogleCloudDataplexV1StorageFormatIcebergOptions
    Optional. Additional information about iceberg tables.
    json GoogleCloudDataplexV1StorageFormatJsonOptions
    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}
    compression_format GoogleCloudDataplexV1StorageFormatCompressionFormat
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv GoogleCloudDataplexV1StorageFormatCsvOptions
    Optional. Additional information about CSV formatted data.
    iceberg GoogleCloudDataplexV1StorageFormatIcebergOptions
    Optional. Additional information about iceberg tables.
    json GoogleCloudDataplexV1StorageFormatJsonOptions
    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 "COMPRESSION_FORMAT_UNSPECIFIED" | "GZIP" | "BZIP2"
    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.
    iceberg Property Map
    Optional. Additional information about iceberg tables.
    json Property Map
    Optional. Additional information about CSV formatted data.

    GoogleCloudDataplexV1StorageFormatCompressionFormat, GoogleCloudDataplexV1StorageFormatCompressionFormatArgs

    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    NameValueDescription
    CompressionFormatUnspecifiedCOMPRESSION_FORMAT_UNSPECIFIEDCompressionFormat unspecified. Implies uncompressed data.
    GzipGZIPGZip compressed set of files.
    Bzip2BZIP2BZip2 compressed set of files.
    NameValueDescription
    GoogleCloudDataplexV1StorageFormatCompressionFormatCompressionFormatUnspecifiedCOMPRESSION_FORMAT_UNSPECIFIEDCompressionFormat unspecified. Implies uncompressed data.
    GoogleCloudDataplexV1StorageFormatCompressionFormatGzipGZIPGZip compressed set of files.
    GoogleCloudDataplexV1StorageFormatCompressionFormatBzip2BZIP2BZip2 compressed set of files.
    ValueDescription
    COMPRESSION_FORMAT_UNSPECIFIEDCompressionFormat unspecified. Implies uncompressed data.
    GZIPGZip compressed set of files.
    BZIP2BZip2 compressed set of files.
    NameValueDescription
    CompressionFormatUnspecifiedCOMPRESSION_FORMAT_UNSPECIFIEDCompressionFormat unspecified. Implies uncompressed data.
    GzipGZIPGZip compressed set of files.
    Bzip2BZIP2BZip2 compressed set of files.
    NameValueDescription
    CompressionFormatUnspecifiedCOMPRESSION_FORMAT_UNSPECIFIEDCompressionFormat unspecified. Implies uncompressed data.
    GzipGZIPGZip compressed set of files.
    Bzip2BZIP2BZip2 compressed set of files.
    NameValueDescription
    COMPRESSION_FORMAT_UNSPECIFIEDCOMPRESSION_FORMAT_UNSPECIFIEDCompressionFormat unspecified. Implies uncompressed data.
    GZIPGZIPGZip compressed set of files.
    BZIP2BZIP2BZip2 compressed set of files.
    ValueDescription
    COMPRESSION_FORMAT_UNSPECIFIEDCompressionFormat unspecified. Implies uncompressed data.
    GZIPGZip compressed set of files.
    BZIP2BZip2 compressed set of files.

    GoogleCloudDataplexV1StorageFormatCsvOptions, GoogleCloudDataplexV1StorageFormatCsvOptionsArgs

    Describes CSV and similar semi-structured data formats.
    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.
    header_rows 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 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.

    GoogleCloudDataplexV1StorageFormatCsvOptionsResponse, GoogleCloudDataplexV1StorageFormatCsvOptionsResponseArgs

    Describes CSV and similar semi-structured data formats.
    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.
    header_rows 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 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.

    GoogleCloudDataplexV1StorageFormatIcebergOptions, GoogleCloudDataplexV1StorageFormatIcebergOptionsArgs

    Describes Iceberg data format.
    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 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

    GoogleCloudDataplexV1StorageFormatIcebergOptionsResponse, GoogleCloudDataplexV1StorageFormatIcebergOptionsResponseArgs

    Describes Iceberg data format.
    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 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

    GoogleCloudDataplexV1StorageFormatJsonOptions, GoogleCloudDataplexV1StorageFormatJsonOptionsArgs

    Describes JSON data format.
    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 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.

    GoogleCloudDataplexV1StorageFormatJsonOptionsResponse, GoogleCloudDataplexV1StorageFormatJsonOptionsResponseArgs

    Describes JSON data format.
    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 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, GoogleCloudDataplexV1StorageFormatResponseArgs

    Describes the format of the data within its storage location.
    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}
    compression_format string
    Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    csv object
    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 object
    Optional. Additional information about iceberg tables.
    json object
    Optional. Additional information about CSV formatted data.
    mime_type 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

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

    Viewing docs for Google Cloud Native v0.32.0
    published on Wednesday, Nov 29, 2023 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial