pulumi-google-native-kotlin/com.pulumi.googlenative.dataplex.v1.kotlin/EntityArgs

EntityArgs

data class EntityArgs(val asset: Output<String>? = null, val dataPath: Output<String>? = null, val dataPathPattern: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val etag: Output<String>? = null, val format: Output<GoogleCloudDataplexV1StorageFormatArgs>? = null, val id: Output<String>? = null, val lakeId: Output<String>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val schema: Output<GoogleCloudDataplexV1SchemaArgs>? = null, val system: Output<EntitySystem>? = null, val type: Output<EntityType>? = null, val zone: Output<String>? = null) : ConvertibleToJava<EntityArgs>

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

Constructors

EntityArgs

fun EntityArgs(asset: Output<String>? = null, dataPath: Output<String>? = null, dataPathPattern: Output<String>? = null, description: Output<String>? = null, displayName: Output<String>? = null, etag: Output<String>? = null, format: Output<GoogleCloudDataplexV1StorageFormatArgs>? = null, id: Output<String>? = null, lakeId: Output<String>? = null, location: Output<String>? = null, project: Output<String>? = null, schema: Output<GoogleCloudDataplexV1SchemaArgs>? = null, system: Output<EntitySystem>? = null, type: Output<EntityType>? = null, zone: Output<String>? = null)

Functions

toJava

open override fun toJava(): EntityArgs

Properties

asset

val asset: Output<String>? = null

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

val dataPath: Output<String>? = null

Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

dataPathPattern

val dataPathPattern: Output<String>? = null

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

val description: Output<String>? = null

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

displayName

val displayName: Output<String>? = null

Optional. Display name must be shorter than or equal to 256 characters.

etag

val etag: Output<String>? = null

Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.

format

val format: Output<GoogleCloudDataplexV1StorageFormatArgs>? = null

Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

val id: Output<String>? = null

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

val lakeId: Output<String>? = null

location

val location: Output<String>? = null

project

val project: Output<String>? = null

schema

val schema: Output<GoogleCloudDataplexV1SchemaArgs>? = null

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

val system: Output<EntitySystem>? = null

Immutable. Identifies the storage system of the entity data.

type

val type: Output<EntityType>? = null

Immutable. The type of entity.

zone

val zone: Output<String>? = null