Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
class Entry : KotlinCustomResource

Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients can use the linkedResource field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag. To get more information about Entry, see:

Link copied to clipboard
data class EntryArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val entryGroup: Output<String>? = null, val entryId: Output<String>? = null, val gcsFilesetSpec: Output<EntryGcsFilesetSpecArgs>? = null, val linkedResource: Output<String>? = null, val schema: Output<String>? = null, val type: Output<String>? = null, val userSpecifiedSystem: Output<String>? = null, val userSpecifiedType: Output<String>? = null) : ConvertibleToJava<EntryArgs>

Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients can use the linkedResource field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag. To get more information about Entry, see:

Link copied to clipboard

Builder for EntryArgs.

Link copied to clipboard
class EntryGroup : KotlinCustomResource

An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources. To get more information about EntryGroup, see:

Link copied to clipboard
data class EntryGroupArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val entryGroupId: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null) : ConvertibleToJava<EntryGroupArgs>

An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources. To get more information about EntryGroup, see:

Link copied to clipboard
Link copied to clipboard
class EntryGroupIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

Link copied to clipboard
data class EntryGroupIamBindingArgs(val condition: Output<EntryGroupIamBindingConditionArgs>? = null, val entryGroup: Output<String>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<EntryGroupIamBindingArgs>

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class EntryGroupIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

Link copied to clipboard
data class EntryGroupIamMemberArgs(val condition: Output<EntryGroupIamMemberConditionArgs>? = null, val entryGroup: Output<String>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<EntryGroupIamMemberArgs>

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class EntryGroupIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

Link copied to clipboard
data class EntryGroupIamPolicyArgs(val entryGroup: Output<String>? = null, val policyData: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null) : ConvertibleToJava<EntryGroupIamPolicyArgs>

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object EntryGroupMapper : ResourceMapper<EntryGroup>
Link copied to clipboard
Link copied to clipboard
object EntryMapper : ResourceMapper<Entry>
Link copied to clipboard

Builder for Entry.

Link copied to clipboard
class PolicyTag : KotlinCustomResource

Denotes one policy tag in a taxonomy. To get more information about PolicyTag, see:

Link copied to clipboard
data class PolicyTagArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val parentPolicyTag: Output<String>? = null, val taxonomy: Output<String>? = null) : ConvertibleToJava<PolicyTagArgs>

Denotes one policy tag in a taxonomy. To get more information about PolicyTag, see:

Link copied to clipboard
Link copied to clipboard
class PolicyTagIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog PolicyTag. Each of these resources serves a different use case:

Link copied to clipboard
data class PolicyTagIamBindingArgs(val condition: Output<PolicyTagIamBindingConditionArgs>? = null, val members: Output<List<String>>? = null, val policyTag: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<PolicyTagIamBindingArgs>

Three different resources help you manage your IAM policy for Data catalog PolicyTag. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class PolicyTagIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog PolicyTag. Each of these resources serves a different use case:

Link copied to clipboard
data class PolicyTagIamMemberArgs(val condition: Output<PolicyTagIamMemberConditionArgs>? = null, val member: Output<String>? = null, val policyTag: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<PolicyTagIamMemberArgs>

Three different resources help you manage your IAM policy for Data catalog PolicyTag. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class PolicyTagIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog PolicyTag. Each of these resources serves a different use case:

Link copied to clipboard
data class PolicyTagIamPolicyArgs(val policyData: Output<String>? = null, val policyTag: Output<String>? = null) : ConvertibleToJava<PolicyTagIamPolicyArgs>

Three different resources help you manage your IAM policy for Data catalog PolicyTag. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object PolicyTagMapper : ResourceMapper<PolicyTag>
Link copied to clipboard
Link copied to clipboard
class Tag : KotlinCustomResource

Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See Data Catalog IAM for information on the permissions needed to create or view tags. To get more information about Tag, see:

Link copied to clipboard
data class TagArgs(val column: Output<String>? = null, val fields: Output<List<TagFieldArgs>>? = null, val parent: Output<String>? = null, val template: Output<String>? = null) : ConvertibleToJava<TagArgs>

Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See Data Catalog IAM for information on the permissions needed to create or view tags. To get more information about Tag, see:

Link copied to clipboard

Builder for TagArgs.

Link copied to clipboard
object TagMapper : ResourceMapper<Tag>
Link copied to clipboard

Builder for Tag.

Link copied to clipboard
class TagTemplate : KotlinCustomResource

A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. To get more information about TagTemplate, see:

Link copied to clipboard
data class TagTemplateArgs(val displayName: Output<String>? = null, val fields: Output<List<TagTemplateFieldArgs>>? = null, val forceDelete: Output<Boolean>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val tagTemplateId: Output<String>? = null) : ConvertibleToJava<TagTemplateArgs>

A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. To get more information about TagTemplate, see:

Link copied to clipboard
Link copied to clipboard
class TagTemplateIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog TagTemplate. Each of these resources serves a different use case:

Link copied to clipboard
data class TagTemplateIamBindingArgs(val condition: Output<TagTemplateIamBindingConditionArgs>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val role: Output<String>? = null, val tagTemplate: Output<String>? = null) : ConvertibleToJava<TagTemplateIamBindingArgs>

Three different resources help you manage your IAM policy for Data catalog TagTemplate. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class TagTemplateIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog TagTemplate. Each of these resources serves a different use case:

Link copied to clipboard
data class TagTemplateIamMemberArgs(val condition: Output<TagTemplateIamMemberConditionArgs>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val role: Output<String>? = null, val tagTemplate: Output<String>? = null) : ConvertibleToJava<TagTemplateIamMemberArgs>

Three different resources help you manage your IAM policy for Data catalog TagTemplate. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class TagTemplateIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog TagTemplate. Each of these resources serves a different use case:

Link copied to clipboard
data class TagTemplateIamPolicyArgs(val policyData: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val tagTemplate: Output<String>? = null) : ConvertibleToJava<TagTemplateIamPolicyArgs>

Three different resources help you manage your IAM policy for Data catalog TagTemplate. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object TagTemplateMapper : ResourceMapper<TagTemplate>
Link copied to clipboard
Link copied to clipboard
class Taxonomy : KotlinCustomResource

A collection of policy tags that classify data along a common axis. To get more information about Taxonomy, see:

Link copied to clipboard
data class TaxonomyArgs(val activatedPolicyTypes: Output<List<String>>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null) : ConvertibleToJava<TaxonomyArgs>

A collection of policy tags that classify data along a common axis. To get more information about Taxonomy, see:

Link copied to clipboard
Link copied to clipboard
class TaxonomyIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog Taxonomy. Each of these resources serves a different use case:

Link copied to clipboard
data class TaxonomyIamBindingArgs(val condition: Output<TaxonomyIamBindingConditionArgs>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val role: Output<String>? = null, val taxonomy: Output<String>? = null) : ConvertibleToJava<TaxonomyIamBindingArgs>

Three different resources help you manage your IAM policy for Data catalog Taxonomy. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class TaxonomyIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog Taxonomy. Each of these resources serves a different use case:

Link copied to clipboard
data class TaxonomyIamMemberArgs(val condition: Output<TaxonomyIamMemberConditionArgs>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val role: Output<String>? = null, val taxonomy: Output<String>? = null) : ConvertibleToJava<TaxonomyIamMemberArgs>

Three different resources help you manage your IAM policy for Data catalog Taxonomy. Each of these resources serves a different use case:

Link copied to clipboard
object TaxonomyIamMemberMapper : ResourceMapper<TaxonomyIamMember>
Link copied to clipboard
class TaxonomyIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for Data catalog Taxonomy. Each of these resources serves a different use case:

Link copied to clipboard
data class TaxonomyIamPolicyArgs(val policyData: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val taxonomy: Output<String>? = null) : ConvertibleToJava<TaxonomyIamPolicyArgs>

Three different resources help you manage your IAM policy for Data catalog Taxonomy. Each of these resources serves a different use case:

Link copied to clipboard
object TaxonomyIamPolicyMapper : ResourceMapper<TaxonomyIamPolicy>
Link copied to clipboard
object TaxonomyMapper : ResourceMapper<Taxonomy>
Link copied to clipboard

Functions

Link copied to clipboard
fun entry(name: String): Entry
suspend fun entry(name: String, block: suspend EntryResourceBuilder.() -> Unit): Entry
Link copied to clipboard
suspend fun entryGroup(name: String, block: suspend EntryGroupResourceBuilder.() -> Unit): EntryGroup
Link copied to clipboard
suspend fun policyTag(name: String, block: suspend PolicyTagResourceBuilder.() -> Unit): PolicyTag
Link copied to clipboard
fun tag(name: String): Tag
suspend fun tag(name: String, block: suspend TagResourceBuilder.() -> Unit): Tag
Link copied to clipboard
suspend fun tagTemplate(name: String, block: suspend TagTemplateResourceBuilder.() -> Unit): TagTemplate
Link copied to clipboard
suspend fun taxonomy(name: String, block: suspend TaxonomyResourceBuilder.() -> Unit): Taxonomy