@kubernetes-models/gke
Version:
766 lines • 183 kB
TypeScript
import { IObjectMeta } from "@kubernetes-models/apimachinery/apis/meta/v1/ObjectMeta";
import { Model, ModelData } from "@kubernetes-models/base";
export interface IDataprocWorkflowTemplate {
/**
* apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
*/
"apiVersion": "dataproc.cnrm.cloud.google.com/v1beta1";
/**
* kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
*/
"kind": "DataprocWorkflowTemplate";
"metadata"?: IObjectMeta;
"spec": {
/**
* Immutable. Optional. Timeout duration for the DAG of jobs, expressed in seconds (see [JSON representation of duration](https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a [managed cluster](/dataproc/docs/concepts/workflows/using-workflows#configuring_or_selecting_a_cluster), the cluster is deleted.
*/
"dagTimeout"?: string;
/**
* Immutable. Required. The Directed Acyclic Graph of Jobs to submit.
*/
"jobs": Array<{
/**
* Immutable. Optional. Job is a Hadoop job.
*/
"hadoopJob"?: {
/**
* Immutable. Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
*/
"archiveUris"?: Array<string>;
/**
* Immutable. Optional. The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
*/
"args"?: Array<string>;
/**
* Immutable. Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
*/
"fileUris"?: Array<string>;
/**
* Immutable. Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
*/
"jarFileUris"?: Array<string>;
/**
* Immutable. Optional. The runtime log config for job execution.
*/
"loggingConfig"?: {
/**
* Immutable. The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
*/
"driverLogLevels"?: {
[key: string]: string;
};
};
/**
* Immutable. The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
*/
"mainClass"?: string;
/**
* Immutable. The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
*/
"mainJarFileUri"?: string;
/**
* Immutable. Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/\*-site and classes in user code.
*/
"properties"?: {
[key: string]: string;
};
};
/**
* Immutable. Optional. Job is a Hive job.
*/
"hiveJob"?: {
/**
* Immutable. Optional. Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
*/
"continueOnFailure"?: boolean;
/**
* Immutable. Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
*/
"jarFileUris"?: Array<string>;
/**
* Immutable. Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/\*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
*/
"properties"?: {
[key: string]: string;
};
/**
* Immutable. The HCFS URI of the script that contains Hive queries.
*/
"queryFileUri"?: string;
/**
* Immutable. A list of queries.
*/
"queryList"?: {
/**
* Immutable. Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
*/
"queries": Array<string>;
};
/**
* Immutable. Optional. Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
*/
"scriptVariables"?: {
[key: string]: string;
};
};
/**
* Immutable. Optional. The labels to associate with this job. Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: p{Ll}p{Lo}{0,62} Label values must be between 1 and 63 characters long, and must conform to the following regular expression: [p{Ll}p{Lo}p{N}_-]{0,63} No more than 32 labels can be associated with a given job.
*/
"labels"?: {
[key: string]: string;
};
/**
* Immutable. Optional. Job is a Pig job.
*/
"pigJob"?: {
/**
* Immutable. Optional. Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
*/
"continueOnFailure"?: boolean;
/**
* Immutable. Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
*/
"jarFileUris"?: Array<string>;
/**
* Immutable. Optional. The runtime log config for job execution.
*/
"loggingConfig"?: {
/**
* Immutable. The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
*/
"driverLogLevels"?: {
[key: string]: string;
};
};
/**
* Immutable. Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/\*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
*/
"properties"?: {
[key: string]: string;
};
/**
* Immutable. The HCFS URI of the script that contains the Pig queries.
*/
"queryFileUri"?: string;
/**
* Immutable. A list of queries.
*/
"queryList"?: {
/**
* Immutable. Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
*/
"queries": Array<string>;
};
/**
* Immutable. Optional. Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
*/
"scriptVariables"?: {
[key: string]: string;
};
};
/**
* Immutable. Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
*/
"prerequisiteStepIds"?: Array<string>;
/**
* Immutable. Optional. Job is a Presto job.
*/
"prestoJob"?: {
/**
* Immutable. Optional. Presto client tags to attach to this query
*/
"clientTags"?: Array<string>;
/**
* Immutable. Optional. Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
*/
"continueOnFailure"?: boolean;
/**
* Immutable. Optional. The runtime log config for job execution.
*/
"loggingConfig"?: {
/**
* Immutable. The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
*/
"driverLogLevels"?: {
[key: string]: string;
};
};
/**
* Immutable. Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
*/
"outputFormat"?: string;
/**
* Immutable. Optional. A mapping of property names to values. Used to set Presto [session properties](https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
*/
"properties"?: {
[key: string]: string;
};
/**
* Immutable. The HCFS URI of the script that contains SQL queries.
*/
"queryFileUri"?: string;
/**
* Immutable. A list of queries.
*/
"queryList"?: {
/**
* Immutable. Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
*/
"queries": Array<string>;
};
};
/**
* Immutable. Optional. Job is a PySpark job.
*/
"pysparkJob"?: {
/**
* Immutable. Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
*/
"archiveUris"?: Array<string>;
/**
* Immutable. Optional. The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
*/
"args"?: Array<string>;
/**
* Immutable. Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.
*/
"fileUris"?: Array<string>;
/**
* Immutable. Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
*/
"jarFileUris"?: Array<string>;
/**
* Immutable. Optional. The runtime log config for job execution.
*/
"loggingConfig"?: {
/**
* Immutable. The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
*/
"driverLogLevels"?: {
[key: string]: string;
};
};
/**
* Immutable. Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
*/
"mainPythonFileUri": string;
/**
* Immutable. Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
*/
"properties"?: {
[key: string]: string;
};
/**
* Immutable. Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
*/
"pythonFileUris"?: Array<string>;
};
/**
* Immutable. Optional. Job scheduling configuration.
*/
"scheduling"?: {
/**
* Immutable. Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window. Maximum value is 10.
*/
"maxFailuresPerHour"?: number;
/**
* Immutable. Optional. Maximum number of times in total a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. Maximum value is 240.
*/
"maxFailuresTotal"?: number;
};
/**
* Immutable. Optional. Job is a Spark job.
*/
"sparkJob"?: {
/**
* Immutable. Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
*/
"archiveUris"?: Array<string>;
/**
* Immutable. Optional. The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
*/
"args"?: Array<string>;
/**
* Immutable. Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.
*/
"fileUris"?: Array<string>;
/**
* Immutable. Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
*/
"jarFileUris"?: Array<string>;
/**
* Immutable. Optional. The runtime log config for job execution.
*/
"loggingConfig"?: {
/**
* Immutable. The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
*/
"driverLogLevels"?: {
[key: string]: string;
};
};
/**
* Immutable. The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
*/
"mainClass"?: string;
/**
* Immutable. The HCFS URI of the jar file that contains the main class.
*/
"mainJarFileUri"?: string;
/**
* Immutable. Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
*/
"properties"?: {
[key: string]: string;
};
};
/**
* Immutable. Optional. Job is a SparkR job.
*/
"sparkRJob"?: {
/**
* Immutable. Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
*/
"archiveUris"?: Array<string>;
/**
* Immutable. Optional. The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
*/
"args"?: Array<string>;
/**
* Immutable. Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.
*/
"fileUris"?: Array<string>;
/**
* Immutable. Optional. The runtime log config for job execution.
*/
"loggingConfig"?: {
/**
* Immutable. The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
*/
"driverLogLevels"?: {
[key: string]: string;
};
};
/**
* Immutable. Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
*/
"mainRFileUri": string;
/**
* Immutable. Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
*/
"properties"?: {
[key: string]: string;
};
};
/**
* Immutable. Optional. Job is a SparkSql job.
*/
"sparkSqlJob"?: {
/**
* Immutable. Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
*/
"jarFileUris"?: Array<string>;
/**
* Immutable. Optional. The runtime log config for job execution.
*/
"loggingConfig"?: {
/**
* Immutable. The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
*/
"driverLogLevels"?: {
[key: string]: string;
};
};
/**
* Immutable. Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
*/
"properties"?: {
[key: string]: string;
};
/**
* Immutable. The HCFS URI of the script that contains SQL queries.
*/
"queryFileUri"?: string;
/**
* Immutable. A list of queries.
*/
"queryList"?: {
/**
* Immutable. Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
*/
"queries": Array<string>;
};
/**
* Immutable. Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
*/
"scriptVariables"?: {
[key: string]: string;
};
};
/**
* Immutable. Required. The step id. The id must be unique among all jobs within the template. The step id is used as prefix for job id, as job `goog-dataproc-workflow-step-id` label, and in prerequisiteStepIds field from other steps. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
*/
"stepId": string;
}>;
/**
* Immutable. The location for the resource
*/
"location": string;
/**
* Immutable. Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
*/
"parameters"?: Array<{
/**
* Immutable. Optional. Brief description of the parameter. Must not exceed 1024 characters.
*/
"description"?: string;
/**
* Immutable. Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths. A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as `placement.clusterSelector.zone`. Also, field paths can reference fields using the following syntax: \* Values in maps can be referenced by key: \* labels['key'] \* placement.clusterSelector.clusterLabels['key'] \* placement.managedCluster.labels['key'] \* placement.clusterSelector.clusterLabels['key'] \* jobs['step-id'].labels['key'] \* Jobs in the jobs list can be referenced by step-id: \* jobs['step-id'].hadoopJob.mainJarFileUri \* jobs['step-id'].hiveJob.queryFileUri \* jobs['step-id'].pySparkJob.mainPythonFileUri \* jobs['step-id'].hadoopJob.jarFileUris[0] \* jobs['step-id'].hadoopJob.archiveUris[0] \* jobs['step-id'].hadoopJob.fileUris[0] \* jobs['step-id'].pySparkJob.pythonFileUris[0] \* Items in repeated fields can be referenced by a zero-based index: \* jobs['step-id'].sparkJob.args[0] \* Other examples: \* jobs['step-id'].hadoopJob.properties['key'] \* jobs['step-id'].hadoopJob.args[0] \* jobs['step-id'].hiveJob.scriptVariables['key'] \* jobs['step-id'].hadoopJob.mainJarFileUri \* placement.clusterSelector.zone It may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: - placement.clusterSelector.clusterLabels - jobs['step-id'].sparkJob.args
*/
"fields": Array<string>;
/**
* Immutable. Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
*/
"name": string;
/**
* Immutable. Optional. Validation rules to be applied to this parameter's value.
*/
"validation"?: {
/**
* Immutable. Validation based on regular expressions.
*/
"regex"?: {
/**
* Immutable. Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
*/
"regexes": Array<string>;
};
/**
* Immutable. Validation based on a list of allowed values.
*/
"values"?: {
/**
* Immutable. Required. List of allowed values for the parameter.
*/
"values": Array<string>;
};
};
}>;
/**
* Immutable. Required. WorkflowTemplate scheduling information.
*/
"placement": {
/**
* Immutable. Optional. A selector that chooses target cluster for jobs based on metadata. The selector is evaluated at the time each job is submitted.
*/
"clusterSelector"?: {
/**
* Immutable. Required. The cluster labels. Cluster must have all labels to match.
*/
"clusterLabels": {
[key: string]: string;
};
/**
* Immutable. Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster. If unspecified, the zone of the first cluster matching the selector is used.
*/
"zone"?: string;
};
/**
* Immutable. A cluster that is managed by the workflow.
*/
"managedCluster"?: {
/**
* Immutable. Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix. The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
*/
"clusterName": string;
/**
* Immutable. Required. The cluster configuration.
*/
"config": {
/**
* Immutable. Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
*/
"autoscalingConfig"?: {
/**
* Immutable.
*/
"policyRef"?: {
/**
* Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` \* `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` Note that the policy must be in the same project and Dataproc region.
*
* Allowed value: The Google Cloud resource name of a `DataprocAutoscalingPolicy` resource (format: `projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{name}}`).
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
} & (Exclude<{
/**
* Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` \* `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` Note that the policy must be in the same project and Dataproc region.
*
* Allowed value: The Google Cloud resource name of a `DataprocAutoscalingPolicy` resource (format: `projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{name}}`).
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name": string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
}, {
/**
* Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` \* `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` Note that the policy must be in the same project and Dataproc region.
*
* Allowed value: The Google Cloud resource name of a `DataprocAutoscalingPolicy` resource (format: `projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{name}}`).
*/
"external": string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
}> | Exclude<{
/**
* Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` \* `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` Note that the policy must be in the same project and Dataproc region.
*
* Allowed value: The Google Cloud resource name of a `DataprocAutoscalingPolicy` resource (format: `projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{name}}`).
*/
"external": string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
}, {
/**
* Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` \* `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` Note that the policy must be in the same project and Dataproc region.
*
* Allowed value: The Google Cloud resource name of a `DataprocAutoscalingPolicy` resource (format: `projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{name}}`).
*/
"external": string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
} & ({
/**
* Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` \* `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` Note that the policy must be in the same project and Dataproc region.
*
* Allowed value: The Google Cloud resource name of a `DataprocAutoscalingPolicy` resource (format: `projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{name}}`).
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name": string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
} | {
/**
* Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` \* `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` Note that the policy must be in the same project and Dataproc region.
*
* Allowed value: The Google Cloud resource name of a `DataprocAutoscalingPolicy` resource (format: `projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{name}}`).
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace": string;
})>);
};
/**
* Immutable. Optional. Encryption settings for the cluster.
*/
"encryptionConfig"?: {
/**
* Immutable.
*/
"gcePdKmsKeyRef"?: {
/**
* Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
*
* Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
} & (Exclude<{
/**
* Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
*
* Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name": string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
}, {
/**
* Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
*
* Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.
*/
"external": string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
}> | Exclude<{
/**
* Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
*
* Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.
*/
"external": string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
}, {
/**
* Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
*
* Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.
*/
"external": string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
} & ({
/**
* Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
*
* Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name": string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
} | {
/**
* Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
*
* Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace": string;
})>);
};
/**
* Immutable. Optional. Port/endpoint configuration for this cluster
*/
"endpointConfig"?: {
/**
* Immutable. Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
*/
"enableHttpPortAccess"?: boolean;
};
/**
* Immutable. Optional. The shared Compute Engine config settings for all instances in a cluster.
*/
"gceClusterConfig"?: {
/**
* Immutable. Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This `internal_ip_only` restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
*/
"internalIPOnly"?: boolean;
/**
* Immutable. The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
*/
"metadata"?: {
[key: string]: string;
};
/**
* Immutable.
*/
"networkRef"?: {
/**
* Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither `network_uri` nor `subnetwork_uri` is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see [Using Subnetworks](https://cloud.google.com/compute/docs/subnetworks) for more information). A full URL, partial URI, or short name are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default` \* `projects/[project_id]/regions/global/default` \* `default`
*
* Allowed value: The `selfLink` field of a `ComputeNetwork` resource.
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
} & (Exclude<{
/**
* Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither `network_uri` nor `subnetwork_uri` is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see [Using Subnetworks](https://cloud.google.com/compute/docs/subnetworks) for more information). A full URL, partial URI, or short name are valid. Examples: \* `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default` \* `projects/[project_id]/regions/global/default` \* `default`
*
* Allowed value: The `selfLink` field of a `ComputeNetwork` resource.
*/
"external"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name": string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
}, {
/**
* Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither `network_uri` nor `subnetwork_uri` is specified, the "default" network of the project is used, if it