Package-level declarations

Types

Link copied to clipboard
class AppProfile : KotlinCustomResource

App profile is a configuration object describing how Cloud Bigtable should treat traffic from a particular end user application. To get more information about AppProfile, see:

Link copied to clipboard
data class AppProfileArgs(val appProfileId: Output<String>? = null, val dataBoostIsolationReadOnly: Output<AppProfileDataBoostIsolationReadOnlyArgs>? = null, val description: Output<String>? = null, val ignoreWarnings: Output<Boolean>? = null, val instance: Output<String>? = null, val multiClusterRoutingClusterIds: Output<List<String>>? = null, val multiClusterRoutingUseAny: Output<Boolean>? = null, val project: Output<String>? = null, val rowAffinity: Output<Boolean>? = null, val singleClusterRouting: Output<AppProfileSingleClusterRoutingArgs>? = null, val standardIsolation: Output<AppProfileStandardIsolationArgs>? = null) : ConvertibleToJava<AppProfileArgs>

App profile is a configuration object describing how Cloud Bigtable should treat traffic from a particular end user application. To get more information about AppProfile, see:

Link copied to clipboard
Link copied to clipboard
object AppProfileMapper : ResourceMapper<AppProfile>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class BiReservation : KotlinCustomResource

Represents a BI Reservation. To get more information about BiReservation, see:

Link copied to clipboard
data class BiReservationArgs(val location: Output<String>? = null, val preferredTables: Output<List<BiReservationPreferredTableArgs>>? = null, val project: Output<String>? = null, val size: Output<Int>? = null) : ConvertibleToJava<BiReservationArgs>

Represents a BI Reservation. To get more information about BiReservation, see:

Link copied to clipboard
Link copied to clipboard
object BiReservationMapper : ResourceMapper<BiReservation>
Link copied to clipboard
Link copied to clipboard
class CapacityCommitment : KotlinCustomResource

Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. To get more information about CapacityCommitment, see:

Link copied to clipboard
data class CapacityCommitmentArgs(val capacityCommitmentId: Output<String>? = null, val edition: Output<String>? = null, val enforceSingleAdminProjectPerOrg: Output<String>? = null, val location: Output<String>? = null, val plan: Output<String>? = null, val project: Output<String>? = null, val renewalPlan: Output<String>? = null, val slotCount: Output<Int>? = null) : ConvertibleToJava<CapacityCommitmentArgs>

Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. To get more information about CapacityCommitment, see:

Link copied to clipboard
Link copied to clipboard
class Connection : KotlinCustomResource

A connection allows BigQuery connections to external data sources.. To get more information about Connection, see:

Link copied to clipboard
data class ConnectionArgs(val aws: Output<ConnectionAwsArgs>? = null, val azure: Output<ConnectionAzureArgs>? = null, val cloudResource: Output<ConnectionCloudResourceArgs>? = null, val cloudSpanner: Output<ConnectionCloudSpannerArgs>? = null, val cloudSql: Output<ConnectionCloudSqlArgs>? = null, val connectionId: Output<String>? = null, val description: Output<String>? = null, val friendlyName: Output<String>? = null, val kmsKeyName: Output<String>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val spark: Output<ConnectionSparkArgs>? = null) : ConvertibleToJava<ConnectionArgs>

A connection allows BigQuery connections to external data sources.. To get more information about Connection, see:

Link copied to clipboard
Link copied to clipboard
class ConnectionIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery Connection Connection. Each of these resources serves a different use case:

Link copied to clipboard
data class ConnectionIamBindingArgs(val condition: Output<ConnectionIamBindingConditionArgs>? = null, val connectionId: Output<String>? = null, val location: Output<String>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<ConnectionIamBindingArgs>

Three different resources help you manage your IAM policy for BigQuery Connection Connection. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class ConnectionIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery Connection Connection. Each of these resources serves a different use case:

Link copied to clipboard
data class ConnectionIamMemberArgs(val condition: Output<ConnectionIamMemberConditionArgs>? = null, val connectionId: Output<String>? = null, val location: Output<String>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<ConnectionIamMemberArgs>

Three different resources help you manage your IAM policy for BigQuery Connection Connection. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
class ConnectionIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery Connection Connection. Each of these resources serves a different use case:

Link copied to clipboard
data class ConnectionIamPolicyArgs(val connectionId: Output<String>? = null, val location: Output<String>? = null, val policyData: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ConnectionIamPolicyArgs>

Three different resources help you manage your IAM policy for BigQuery Connection Connection. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object ConnectionMapper : ResourceMapper<Connection>
Link copied to clipboard
Link copied to clipboard
class Dataset : KotlinCustomResource
Link copied to clipboard
class DatasetAccess : KotlinCustomResource
Link copied to clipboard
data class DatasetAccessArgs(val authorizedDataset: Output<DatasetAccessAuthorizedDatasetArgs>? = null, val condition: Output<DatasetAccessConditionArgs>? = null, val datasetId: Output<String>? = null, val domain: Output<String>? = null, val groupByEmail: Output<String>? = null, val iamMember: Output<String>? = null, val project: Output<String>? = null, val role: Output<String>? = null, val routine: Output<DatasetAccessRoutineArgs>? = null, val specialGroup: Output<String>? = null, val userByEmail: Output<String>? = null, val view: Output<DatasetAccessViewArgs>? = null) : ConvertibleToJava<DatasetAccessArgs>
Link copied to clipboard
Link copied to clipboard
object DatasetAccessMapper : ResourceMapper<DatasetAccess>
Link copied to clipboard
Link copied to clipboard
data class DatasetArgs(val accesses: Output<List<DatasetAccessArgs>>? = null, val datasetId: Output<String>? = null, val defaultCollation: Output<String>? = null, val defaultEncryptionConfiguration: Output<DatasetDefaultEncryptionConfigurationArgs>? = null, val defaultPartitionExpirationMs: Output<Int>? = null, val defaultTableExpirationMs: Output<Int>? = null, val deleteContentsOnDestroy: Output<Boolean>? = null, val description: Output<String>? = null, val externalCatalogDatasetOptions: Output<DatasetExternalCatalogDatasetOptionsArgs>? = null, val externalDatasetReference: Output<DatasetExternalDatasetReferenceArgs>? = null, val friendlyName: Output<String>? = null, val isCaseInsensitive: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val maxTimeTravelHours: Output<String>? = null, val project: Output<String>? = null, val resourceTags: Output<Map<String, String>>? = null, val storageBillingModel: Output<String>? = null) : ConvertibleToJava<DatasetArgs>
Link copied to clipboard
Link copied to clipboard
class DatasetIamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:

Link copied to clipboard
data class DatasetIamBindingArgs(val condition: Output<DatasetIamBindingConditionArgs>? = null, val datasetId: Output<String>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<DatasetIamBindingArgs>

Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:

Link copied to clipboard
object DatasetIamBindingMapper : ResourceMapper<DatasetIamBinding>
Link copied to clipboard
class DatasetIamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:

Link copied to clipboard
data class DatasetIamMemberArgs(val condition: Output<DatasetIamMemberConditionArgs>? = null, val datasetId: Output<String>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<DatasetIamMemberArgs>

Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:

Link copied to clipboard
object DatasetIamMemberMapper : ResourceMapper<DatasetIamMember>
Link copied to clipboard
class DatasetIamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:

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

Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:

Link copied to clipboard
object DatasetIamPolicyMapper : ResourceMapper<DatasetIamPolicy>
Link copied to clipboard
object DatasetMapper : ResourceMapper<Dataset>
Link copied to clipboard
Link copied to clipboard
class DataTransferConfig : KotlinCustomResource

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. To get more information about Config, see:

Link copied to clipboard
data class DataTransferConfigArgs(val dataRefreshWindowDays: Output<Int>? = null, val dataSourceId: Output<String>? = null, val destinationDatasetId: Output<String>? = null, val disabled: Output<Boolean>? = null, val displayName: Output<String>? = null, val emailPreferences: Output<DataTransferConfigEmailPreferencesArgs>? = null, val encryptionConfiguration: Output<DataTransferConfigEncryptionConfigurationArgs>? = null, val location: Output<String>? = null, val notificationPubsubTopic: Output<String>? = null, val params: Output<Map<String, String>>? = null, val project: Output<String>? = null, val schedule: Output<String>? = null, val scheduleOptions: Output<DataTransferConfigScheduleOptionsArgs>? = null, val sensitiveParams: Output<DataTransferConfigSensitiveParamsArgs>? = null, val serviceAccountName: Output<String>? = null) : ConvertibleToJava<DataTransferConfigArgs>

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. To get more information about Config, see:

Link copied to clipboard
Link copied to clipboard
class IamBinding : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:

Link copied to clipboard
data class IamBindingArgs(val condition: Output<IamBindingConditionArgs>? = null, val datasetId: Output<String>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val role: Output<String>? = null, val tableId: Output<String>? = null) : ConvertibleToJava<IamBindingArgs>

Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object IamBindingMapper : ResourceMapper<IamBinding>
Link copied to clipboard
Link copied to clipboard
class IamMember : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:

Link copied to clipboard
data class IamMemberArgs(val condition: Output<IamMemberConditionArgs>? = null, val datasetId: Output<String>? = null, val member: Output<String>? = null, val project: Output<String>? = null, val role: Output<String>? = null, val tableId: Output<String>? = null) : ConvertibleToJava<IamMemberArgs>

Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object IamMemberMapper : ResourceMapper<IamMember>
Link copied to clipboard
Link copied to clipboard
class IamPolicy : KotlinCustomResource

Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:

Link copied to clipboard
data class IamPolicyArgs(val datasetId: Output<String>? = null, val policyData: Output<String>? = null, val project: Output<String>? = null, val tableId: Output<String>? = null) : ConvertibleToJava<IamPolicyArgs>

Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:

Link copied to clipboard
Link copied to clipboard
object IamPolicyMapper : ResourceMapper<IamPolicy>
Link copied to clipboard
Link copied to clipboard
class Job : KotlinCustomResource

Jobs are actions that BigQuery runs on your behalf to load data, export data, query data, or copy data. Once a BigQuery job is created, it cannot be changed or deleted. To get more information about Job, see:

Link copied to clipboard
data class JobArgs(val copy: Output<JobCopyArgs>? = null, val extract: Output<JobExtractArgs>? = null, val jobId: Output<String>? = null, val jobTimeoutMs: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val load: Output<JobLoadArgs>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val query: Output<JobQueryArgs>? = null) : ConvertibleToJava<JobArgs>

Jobs are actions that BigQuery runs on your behalf to load data, export data, query data, or copy data. Once a BigQuery job is created, it cannot be changed or deleted. To get more information about Job, see:

Link copied to clipboard

Builder for JobArgs.

Link copied to clipboard
object JobMapper : ResourceMapper<Job>
Link copied to clipboard

Builder for Job.

Link copied to clipboard
class Reservation : KotlinCustomResource

A reservation is a mechanism used to guarantee BigQuery slots to users. To get more information about Reservation, see:

Link copied to clipboard
data class ReservationArgs(val autoscale: Output<ReservationAutoscaleArgs>? = null, val concurrency: Output<Int>? = null, val edition: Output<String>? = null, val ignoreIdleSlots: Output<Boolean>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val secondaryLocation: Output<String>? = null, val slotCapacity: Output<Int>? = null) : ConvertibleToJava<ReservationArgs>

A reservation is a mechanism used to guarantee BigQuery slots to users. To get more information about Reservation, see:

Link copied to clipboard
Link copied to clipboard
class ReservationAssignment : KotlinCustomResource

The BigqueryReservation Assignment resource. To get more information about ReservationAssignment, see:

Link copied to clipboard
data class ReservationAssignmentArgs(val assignee: Output<String>? = null, val jobType: Output<String>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val reservation: Output<String>? = null) : ConvertibleToJava<ReservationAssignmentArgs>

The BigqueryReservation Assignment resource. To get more information about ReservationAssignment, see:

Link copied to clipboard
Link copied to clipboard
object ReservationMapper : ResourceMapper<Reservation>
Link copied to clipboard
Link copied to clipboard
class Routine : KotlinCustomResource

A user-defined function or a stored procedure that belongs to a Dataset To get more information about Routine, see:

Link copied to clipboard
data class RoutineArgs(val arguments: Output<List<RoutineArgumentArgs>>? = null, val dataGovernanceType: Output<String>? = null, val datasetId: Output<String>? = null, val definitionBody: Output<String>? = null, val description: Output<String>? = null, val determinismLevel: Output<String>? = null, val importedLibraries: Output<List<String>>? = null, val language: Output<String>? = null, val project: Output<String>? = null, val remoteFunctionOptions: Output<RoutineRemoteFunctionOptionsArgs>? = null, val returnTableType: Output<String>? = null, val returnType: Output<String>? = null, val routineId: Output<String>? = null, val routineType: Output<String>? = null, val securityMode: Output<String>? = null, val sparkOptions: Output<RoutineSparkOptionsArgs>? = null) : ConvertibleToJava<RoutineArgs>

A user-defined function or a stored procedure that belongs to a Dataset To get more information about Routine, see:

Link copied to clipboard
Link copied to clipboard
object RoutineMapper : ResourceMapper<Routine>
Link copied to clipboard
Link copied to clipboard
class Table : KotlinCustomResource

Creates a table resource in a dataset for Google BigQuery. For more information see the official documentation and API.

Link copied to clipboard
data class TableArgs(val biglakeConfiguration: Output<TableBiglakeConfigurationArgs>? = null, val clusterings: Output<List<String>>? = null, val datasetId: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val description: Output<String>? = null, val encryptionConfiguration: Output<TableEncryptionConfigurationArgs>? = null, val expirationTime: Output<Int>? = null, val externalCatalogTableOptions: Output<TableExternalCatalogTableOptionsArgs>? = null, val externalDataConfiguration: Output<TableExternalDataConfigurationArgs>? = null, val friendlyName: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val materializedView: Output<TableMaterializedViewArgs>? = null, val maxStaleness: Output<String>? = null, val project: Output<String>? = null, val rangePartitioning: Output<TableRangePartitioningArgs>? = null, val requirePartitionFilter: Output<Boolean>? = null, val resourceTags: Output<Map<String, String>>? = null, val schema: Output<String>? = null, val schemaForeignTypeInfo: Output<TableSchemaForeignTypeInfoArgs>? = null, val tableConstraints: Output<TableTableConstraintsArgs>? = null, val tableId: Output<String>? = null, val tableMetadataView: Output<String>? = null, val tableReplicationInfo: Output<TableTableReplicationInfoArgs>? = null, val timePartitioning: Output<TableTimePartitioningArgs>? = null, val view: Output<TableViewArgs>? = null) : ConvertibleToJava<TableArgs>

Creates a table resource in a dataset for Google BigQuery. For more information see the official documentation and API.

Link copied to clipboard

Builder for TableArgs.

Link copied to clipboard
object TableMapper : ResourceMapper<Table>
Link copied to clipboard

Builder for Table.

Functions

Link copied to clipboard
suspend fun appProfile(name: String, block: suspend AppProfileResourceBuilder.() -> Unit): AppProfile
Link copied to clipboard
Link copied to clipboard
suspend fun connection(name: String, block: suspend ConnectionResourceBuilder.() -> Unit): Connection
Link copied to clipboard
fun dataset(name: String): Dataset
suspend fun dataset(name: String, block: suspend DatasetResourceBuilder.() -> Unit): Dataset
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun iamBinding(name: String, block: suspend IamBindingResourceBuilder.() -> Unit): IamBinding
Link copied to clipboard
suspend fun iamMember(name: String, block: suspend IamMemberResourceBuilder.() -> Unit): IamMember
Link copied to clipboard
suspend fun iamPolicy(name: String, block: suspend IamPolicyResourceBuilder.() -> Unit): IamPolicy
Link copied to clipboard
fun job(name: String): Job
suspend fun job(name: String, block: suspend JobResourceBuilder.() -> Unit): Job
Link copied to clipboard
suspend fun reservation(name: String, block: suspend ReservationResourceBuilder.() -> Unit): Reservation
Link copied to clipboard
fun routine(name: String): Routine
suspend fun routine(name: String, block: suspend RoutineResourceBuilder.() -> Unit): Routine
Link copied to clipboard
fun table(name: String): Table
suspend fun table(name: String, block: suspend TableResourceBuilder.() -> Unit): Table