bigqueryjob_types.go

// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// ----------------------------------------------------------------------------
//
//     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
//
// ----------------------------------------------------------------------------
//
//     This file is automatically generated by Config Connector and manual
//     changes will be clobbered when the file is regenerated.
//
// ----------------------------------------------------------------------------

// *** DISCLAIMER ***
// Config Connector's go-client for CRDs is currently in ALPHA, which means
// that future versions of the go-client may include breaking changes.
// Please try it out and give us feedback!

package v1beta1

import (
	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/apis/k8s/v1alpha1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

type JobCopy struct {
	/* Immutable. Specifies whether the job is allowed to create new tables. The following values are supported:
	CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table.
	CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result.
	Creation, truncation and append actions occur as one atomic update upon job completion Default value: "CREATE_NEVER" Possible values: ["CREATE_IF_NEEDED", "CREATE_NEVER"] */
	// +optional
	CreateDisposition *string `json:"createDisposition,omitempty"`

	/* Immutable. Custom encryption configuration (e.g., Cloud KMS keys) */
	// +optional
	DestinationEncryptionConfiguration *JobDestinationEncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`

	/* Immutable. The destination table. */
	// +optional
	DestinationTable *JobDestinationTable `json:"destinationTable,omitempty"`

	/* Immutable. Source tables to copy. */
	SourceTables []JobSourceTables `json:"sourceTables"`

	/* Immutable. Specifies the action that occurs if the destination table already exists. The following values are supported:
	WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result.
	WRITE_APPEND: If the table already exists, BigQuery appends the data to the table.
	WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result.
	Each action is atomic and only occurs if BigQuery is able to complete the job successfully.
	Creation, truncation and append actions occur as one atomic update upon job completion. Default value: "WRITE_EMPTY" Possible values: ["WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY"] */
	// +optional
	WriteDisposition *string `json:"writeDisposition,omitempty"`
}

type JobDefaultDataset struct {
	/* A reference to the dataset. */
	DatasetRef v1alpha1.ResourceRef `json:"datasetRef"`
}

type JobDestinationEncryptionConfiguration struct {
	/* Describes the Cloud KMS encryption key that will be used to protect
	destination BigQuery table. The BigQuery Service Account associated
	with your project requires access to this encryption key. */
	KmsKeyRef v1alpha1.ResourceRef `json:"kmsKeyRef"`
}

type JobDestinationTable struct {
	/* A reference to the table. */
	TableRef v1alpha1.ResourceRef `json:"tableRef"`
}

type JobExtract struct {
	/* Immutable. The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE.
	The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. */
	// +optional
	Compression *string `json:"compression,omitempty"`

	/* Immutable. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO for tables and SAVED_MODEL for models.
	The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV.
	The default value for models is SAVED_MODEL. */
	// +optional
	DestinationFormat *string `json:"destinationFormat,omitempty"`

	/* Immutable. A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. */
	DestinationUris []string `json:"destinationUris"`

	/* Immutable. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data.
	Default is ',' */
	// +optional
	FieldDelimiter *string `json:"fieldDelimiter,omitempty"`

	/* Immutable. Whether to print out a header row in the results. Default is true. */
	// +optional
	PrintHeader *bool `json:"printHeader,omitempty"`

	/* Immutable. A reference to the table being exported. */
	// +optional
	SourceTable *JobSourceTable `json:"sourceTable,omitempty"`

	/* Immutable. Whether to use logical types when extracting to AVRO format. */
	// +optional
	UseAvroLogicalTypes *bool `json:"useAvroLogicalTypes,omitempty"`
}

type JobLoad struct {
	/* Immutable. Accept rows that are missing trailing optional columns. The missing values are treated as nulls.
	If false, records with missing trailing columns are treated as bad records, and if there are too many bad records,
	an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats. */
	// +optional
	AllowJaggedRows *bool `json:"allowJaggedRows,omitempty"`

	/* Immutable. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file.
	The default value is false. */
	// +optional
	AllowQuotedNewlines *bool `json:"allowQuotedNewlines,omitempty"`

	/* Immutable. Indicates if we should automatically infer the options and schema for CSV and JSON sources. */
	// +optional
	Autodetect *bool `json:"autodetect,omitempty"`

	/* Immutable. Specifies whether the job is allowed to create new tables. The following values are supported:
	CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table.
	CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result.
	Creation, truncation and append actions occur as one atomic update upon job completion Default value: "CREATE_NEVER" Possible values: ["CREATE_IF_NEEDED", "CREATE_NEVER"] */
	// +optional
	CreateDisposition *string `json:"createDisposition,omitempty"`

	/* Immutable. Custom encryption configuration (e.g., Cloud KMS keys) */
	// +optional
	DestinationEncryptionConfiguration *JobDestinationEncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`

	/* Immutable. The destination table to load the data into. */
	DestinationTable JobDestinationTable `json:"destinationTable"`

	/* Immutable. The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.
	The default value is UTF-8. BigQuery decodes the data after the raw, binary data
	has been split using the values of the quote and fieldDelimiter properties. */
	// +optional
	Encoding *string `json:"encoding,omitempty"`

	/* Immutable. The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character.
	To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts
	the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the
	data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator.
	The default value is a comma (','). */
	// +optional
	FieldDelimiter *string `json:"fieldDelimiter,omitempty"`

	/* Immutable. Indicates if BigQuery should allow extra values that are not represented in the table schema.
	If true, the extra values are ignored. If false, records with extra columns are treated as bad records,
	and if there are too many bad records, an invalid error is returned in the job result.
	The default value is false. The sourceFormat property determines what BigQuery treats as an extra value:
	CSV: Trailing columns
	JSON: Named values that don't match any column names */
	// +optional
	IgnoreUnknownValues *bool `json:"ignoreUnknownValues,omitempty"`

	/* Immutable. The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value,
	an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. */
	// +optional
	MaxBadRecords *int `json:"maxBadRecords,omitempty"`

	/* Immutable. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value
	when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an
	empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as
	an empty value. */
	// +optional
	NullMarker *string `json:"nullMarker,omitempty"`

	/* Immutable. If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup.
	Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties.
	If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. */
	// +optional
	ProjectionFields []string `json:"projectionFields,omitempty"`

	/* Immutable. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding,
	and then uses the first byte of the encoded string to split the data in its raw, binary state.
	The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string.
	If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. */
	// +optional
	Quote *string `json:"quote,omitempty"`

	/* Immutable. Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or
	supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND;
	when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators.
	For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified:
	ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema.
	ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */
	// +optional
	SchemaUpdateOptions []string `json:"schemaUpdateOptions,omitempty"`

	/* Immutable. The number of rows at the top of a CSV file that BigQuery will skip when loading the data.
	The default value is 0. This property is useful if you have header rows in the file that should be skipped.
	When autodetect is on, the behavior is the following:
	skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected,
	the row is read as data. Otherwise data is read starting from the second row.
	skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row.
	skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected,
	row N is just skipped. Otherwise row N is used to extract column names for the detected schema. */
	// +optional
	SkipLeadingRows *int `json:"skipLeadingRows,omitempty"`

	/* Immutable. The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP".
	For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET".
	For orc, specify "ORC". [Beta] For Bigtable, specify "BIGTABLE".
	The default value is CSV. */
	// +optional
	SourceFormat *string `json:"sourceFormat,omitempty"`

	/* Immutable. The fully-qualified URIs that point to your data in Google Cloud.
	For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character
	and it must come after the 'bucket' name. Size limits related to load jobs apply
	to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be
	specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table.
	For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. */
	SourceUris []string `json:"sourceUris"`

	/* Immutable. Time-based partitioning specification for the destination table. */
	// +optional
	TimePartitioning *JobTimePartitioning `json:"timePartitioning,omitempty"`

	/* Immutable. Specifies the action that occurs if the destination table already exists. The following values are supported:
	WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result.
	WRITE_APPEND: If the table already exists, BigQuery appends the data to the table.
	WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result.
	Each action is atomic and only occurs if BigQuery is able to complete the job successfully.
	Creation, truncation and append actions occur as one atomic update upon job completion. Default value: "WRITE_EMPTY" Possible values: ["WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY"] */
	// +optional
	WriteDisposition *string `json:"writeDisposition,omitempty"`
}

type JobQuery struct {
	/* Immutable. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance.
	Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed.
	However, you must still set destinationTable when result size exceeds the allowed maximum response size. */
	// +optional
	AllowLargeResults *bool `json:"allowLargeResults,omitempty"`

	/* Immutable. Specifies whether the job is allowed to create new tables. The following values are supported:
	CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table.
	CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result.
	Creation, truncation and append actions occur as one atomic update upon job completion Default value: "CREATE_NEVER" Possible values: ["CREATE_IF_NEEDED", "CREATE_NEVER"] */
	// +optional
	CreateDisposition *string `json:"createDisposition,omitempty"`

	/* Immutable. Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. */
	// +optional
	DefaultDataset *JobDefaultDataset `json:"defaultDataset,omitempty"`

	/* Immutable. Custom encryption configuration (e.g., Cloud KMS keys) */
	// +optional
	DestinationEncryptionConfiguration *JobDestinationEncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`

	/* Immutable. Describes the table where the query results should be stored.
	This property must be set for large results that exceed the maximum response size.
	For queries that produce anonymous (cached) results, this field will be populated by BigQuery. */
	// +optional
	DestinationTable *JobDestinationTable `json:"destinationTable,omitempty"`

	/* Immutable. If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results.
	allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. */
	// +optional
	FlattenResults *bool `json:"flattenResults,omitempty"`

	/* Immutable. Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge).
	If unspecified, this will be set to your project default. */
	// +optional
	MaximumBillingTier *int `json:"maximumBillingTier,omitempty"`

	/* Immutable. Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge).
	If unspecified, this will be set to your project default. */
	// +optional
	MaximumBytesBilled *string `json:"maximumBytesBilled,omitempty"`

	/* Immutable. Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */
	// +optional
	ParameterMode *string `json:"parameterMode,omitempty"`

	/* Immutable. Specifies a priority for the query. Default value: "INTERACTIVE" Possible values: ["INTERACTIVE", "BATCH"] */
	// +optional
	Priority *string `json:"priority,omitempty"`

	/* Immutable. SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
	*NOTE*: queries containing [DML language](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language)
	('DELETE', 'UPDATE', 'MERGE', 'INSERT') must specify 'create_disposition = ""' and 'write_disposition = ""'. */
	Query string `json:"query"`

	/* Immutable. Allows the schema of the destination table to be updated as a side effect of the query job.
	Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND;
	when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table,
	specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema.
	One or more of the following values are specified:
	ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema.
	ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */
	// +optional
	SchemaUpdateOptions []string `json:"schemaUpdateOptions,omitempty"`

	/* Immutable. Options controlling the execution of scripts. */
	// +optional
	ScriptOptions *JobScriptOptions `json:"scriptOptions,omitempty"`

	/* Immutable. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true.
	If set to false, the query will use BigQuery's standard SQL. */
	// +optional
	UseLegacySql *bool `json:"useLegacySql,omitempty"`

	/* Immutable. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever
	tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
	The default value is true. */
	// +optional
	UseQueryCache *bool `json:"useQueryCache,omitempty"`

	/* Immutable. Describes user-defined function resources used in the query. */
	// +optional
	UserDefinedFunctionResources []JobUserDefinedFunctionResources `json:"userDefinedFunctionResources,omitempty"`

	/* Immutable. Specifies the action that occurs if the destination table already exists. The following values are supported:
	WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result.
	WRITE_APPEND: If the table already exists, BigQuery appends the data to the table.
	WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result.
	Each action is atomic and only occurs if BigQuery is able to complete the job successfully.
	Creation, truncation and append actions occur as one atomic update upon job completion. Default value: "WRITE_EMPTY" Possible values: ["WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY"] */
	// +optional
	WriteDisposition *string `json:"writeDisposition,omitempty"`
}

type JobScriptOptions struct {
	/* Immutable. Determines which statement in the script represents the "key result",
	used to populate the schema and query results of the script job. Possible values: ["LAST", "FIRST_SELECT"] */
	// +optional
	KeyResultStatement *string `json:"keyResultStatement,omitempty"`

	/* Immutable. Limit on the number of bytes billed per statement. Exceeding this budget results in an error. */
	// +optional
	StatementByteBudget *string `json:"statementByteBudget,omitempty"`

	/* Immutable. Timeout period for each statement in a script. */
	// +optional
	StatementTimeoutMs *string `json:"statementTimeoutMs,omitempty"`
}

type JobSourceTable struct {
	/* A reference to the table. */
	TableRef v1alpha1.ResourceRef `json:"tableRef"`
}

type JobSourceTables struct {
	/* A reference to the table. */
	TableRef v1alpha1.ResourceRef `json:"tableRef"`
}

type JobTimePartitioning struct {
	/* Immutable. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. */
	// +optional
	ExpirationMs *string `json:"expirationMs,omitempty"`

	/* Immutable. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field.
	The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
	A wrapper is used here because an empty string is an invalid value. */
	// +optional
	Field *string `json:"field,omitempty"`

	/* Immutable. The only type supported is DAY, which will generate one partition per day. Providing an empty string used to cause an error,
	but in OnePlatform the field will be treated as unset. */
	Type string `json:"type"`
}

type JobUserDefinedFunctionResources struct {
	/* Immutable. An inline resource that contains code for a user-defined function (UDF).
	Providing a inline code resource is equivalent to providing a URI for a file containing the same code. */
	// +optional
	InlineCode *string `json:"inlineCode,omitempty"`

	/* Immutable. A code resource to load from a Google Cloud Storage URI (gs://bucket/path). */
	// +optional
	ResourceUri *string `json:"resourceUri,omitempty"`
}

type BigQueryJobSpec struct {
	/* Immutable. Copies a table. */
	// +optional
	Copy *JobCopy `json:"copy,omitempty"`

	/* Immutable. Configures an extract job. */
	// +optional
	Extract *JobExtract `json:"extract,omitempty"`

	/* Immutable. Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. */
	// +optional
	JobTimeoutMs *string `json:"jobTimeoutMs,omitempty"`

	/* Immutable. Configures a load job. */
	// +optional
	Load *JobLoad `json:"load,omitempty"`

	/* Immutable. The geographic location of the job. The default value is US. */
	// +optional
	Location *string `json:"location,omitempty"`

	/* Immutable. Configures a query job. */
	// +optional
	Query *JobQuery `json:"query,omitempty"`

	/* Immutable. Optional. The jobId of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`
}

type JobErrorResultStatus struct {
	/* Specifies where the error occurred, if present. */
	Location string `json:"location,omitempty"`

	/* A human-readable description of the error. */
	Message string `json:"message,omitempty"`

	/* A short error code that summarizes the error. */
	Reason string `json:"reason,omitempty"`
}

type JobErrorsStatus struct {
	/* Specifies where the error occurred, if present. */
	Location string `json:"location,omitempty"`

	/* A human-readable description of the error. */
	Message string `json:"message,omitempty"`

	/* A short error code that summarizes the error. */
	Reason string `json:"reason,omitempty"`
}

type JobStatusStatus struct {
	/* Final error result of the job. If present, indicates that the job has completed and was unsuccessful. */
	ErrorResult []JobErrorResultStatus `json:"errorResult,omitempty"`

	/* The first errors encountered during the running of the job. The final message
	includes the number of errors that caused the process to stop. Errors here do
	not necessarily mean that the job has not completed or was unsuccessful. */
	Errors []JobErrorsStatus `json:"errors,omitempty"`

	/* Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'. */
	State string `json:"state,omitempty"`
}

type BigQueryJobStatus struct {
	/* Conditions represent the latest available observations of the
	   BigQueryJob's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* The type of the job. */
	JobType string `json:"jobType,omitempty"`
	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	ObservedGeneration int `json:"observedGeneration,omitempty"`
	/* The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. */
	Status []JobStatusStatus `json:"status,omitempty"`
	/* Email address of the user who ran the job. */
	UserEmail string `json:"userEmail,omitempty"`
}

// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// BigQueryJob is the Schema for the bigquery API
// +k8s:openapi-gen=true
type BigQueryJob struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BigQueryJobSpec   `json:"spec,omitempty"`
	Status BigQueryJobStatus `json:"status,omitempty"`
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// BigQueryJobList contains a list of BigQueryJob
type BigQueryJobList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BigQueryJob `json:"items"`
}

func init() {
	SchemeBuilder.Register(&BigQueryJob{}, &BigQueryJobList{})
}