Skip to content

dataproc.v1beta1.dataprocCluster

Index

Fields

fn new

new(name)

new returns an instance of DataprocCluster

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withLocation

withLocation(location)

"Immutable. The location for the resource, usually a GCP region."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of metadata.name is used as the default."

obj spec.config

"Immutable. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated."

fn spec.config.withInitializationActions

withInitializationActions(initializationActions)

"Immutable. Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi"

fn spec.config.withInitializationActionsMixin

withInitializationActionsMixin(initializationActions)

"Immutable. Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi"

Note: This function appends passed data to existing values

obj spec.config.autoscalingConfig

"Immutable. Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset."

obj spec.config.autoscalingConfig.policyRef

"Immutable."

fn spec.config.autoscalingConfig.policyRef.withExternal

withExternal(external)

"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.\n\nAllowed value: The Google Cloud resource name of a DataprocAutoscalingPolicy resource (format: projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{name}})."

fn spec.config.autoscalingConfig.policyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.autoscalingConfig.policyRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.dataprocMetricConfig

"Immutable. Optional. The config for Dataproc metrics."

fn spec.config.dataprocMetricConfig.withMetrics

withMetrics(metrics)

"Immutable. Required. Metrics sources to enable."

fn spec.config.dataprocMetricConfig.withMetricsMixin

withMetricsMixin(metrics)

"Immutable. Required. Metrics sources to enable."

Note: This function appends passed data to existing values

obj spec.config.dataprocMetricConfig.metrics

"Immutable. Required. Metrics sources to enable."

fn spec.config.dataprocMetricConfig.metrics.withMetricOverrides

withMetricOverrides(metricOverrides)

"Immutable. Optional. Specify one or more [available OSS metrics] (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics) to collect for the metric course (for the SPARK metric source, any [Spark metric] (https://spark.apache.org/docs/latest/monitoring.html#metrics) can be specified). Provide metrics in the following format: METRIC_SOURCE:INSTANCE:GROUP:METRIC Use camelcase as appropriate. Examples: yarn:ResourceManager:QueueMetrics:AppsCompleted spark:driver:DAGScheduler:job.allJobs sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed hiveserver2:JVM:Memory:NonHeapMemoryUsage.used Notes: * Only the specified overridden metrics will be collected for the metric source. For example, if one or more spark:executive metrics are listed as metric overrides, other SPARK metrics will not be collected. The collection of the default metrics for other OSS metric sources is unaffected. For example, if both SPARK andd YARN metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected."

fn spec.config.dataprocMetricConfig.metrics.withMetricOverridesMixin

withMetricOverridesMixin(metricOverrides)

"Immutable. Optional. Specify one or more [available OSS metrics] (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics) to collect for the metric course (for the SPARK metric source, any [Spark metric] (https://spark.apache.org/docs/latest/monitoring.html#metrics) can be specified). Provide metrics in the following format: METRIC_SOURCE:INSTANCE:GROUP:METRIC Use camelcase as appropriate. Examples: yarn:ResourceManager:QueueMetrics:AppsCompleted spark:driver:DAGScheduler:job.allJobs sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed hiveserver2:JVM:Memory:NonHeapMemoryUsage.used Notes: * Only the specified overridden metrics will be collected for the metric source. For example, if one or more spark:executive metrics are listed as metric overrides, other SPARK metrics will not be collected. The collection of the default metrics for other OSS metric sources is unaffected. For example, if both SPARK andd YARN metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected."

Note: This function appends passed data to existing values

fn spec.config.dataprocMetricConfig.metrics.withMetricSource

withMetricSource(metricSource)

"Immutable. Required. Default metrics are collected unless metricOverrides are specified for the metric source (see [Available OSS metrics] (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics) for more information). Possible values: METRIC_SOURCE_UNSPECIFIED, MONITORING_AGENT_DEFAULTS, HDFS, SPARK, YARN, SPARK_HISTORY_SERVER, HIVESERVER2"

obj spec.config.encryptionConfig

"Immutable. Optional. Encryption settings for the cluster."

obj spec.config.encryptionConfig.gcePdKmsKeyRef

"Immutable."

fn spec.config.encryptionConfig.gcePdKmsKeyRef.withExternal

withExternal(external)

"Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.\n\nAllowed value: The selfLink field of a KMSCryptoKey resource."

fn spec.config.encryptionConfig.gcePdKmsKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.encryptionConfig.gcePdKmsKeyRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.endpointConfig

"Immutable. Optional. Port/endpoint configuration for this cluster"

fn spec.config.endpointConfig.withEnableHttpPortAccess

withEnableHttpPortAccess(enableHttpPortAccess)

"Immutable. Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false."

obj spec.config.gceClusterConfig

"Immutable. Optional. The shared Compute Engine config settings for all instances in a cluster."

fn spec.config.gceClusterConfig.withInternalIPOnly

withInternalIPOnly(internalIPOnly)

"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."

fn spec.config.gceClusterConfig.withMetadata

withMetadata(metadata)

"Immutable. The Compute Engine metadata entries to add to all instances (see Project and instance metadata)."

fn spec.config.gceClusterConfig.withMetadataMixin

withMetadataMixin(metadata)

"Immutable. The Compute Engine metadata entries to add to all instances (see Project and instance metadata)."

Note: This function appends passed data to existing values

fn spec.config.gceClusterConfig.withPrivateIPv6GoogleAccess

withPrivateIPv6GoogleAccess(privateIPv6GoogleAccess)

"Immutable. Optional. The type of IPv6 access for a cluster. Possible values: PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED, INHERIT_FROM_SUBNETWORK, OUTBOUND, BIDIRECTIONAL"

fn spec.config.gceClusterConfig.withServiceAccountScopes

withServiceAccountScopes(serviceAccountScopes)

"Immutable. Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control"

fn spec.config.gceClusterConfig.withServiceAccountScopesMixin

withServiceAccountScopesMixin(serviceAccountScopes)

"Immutable. Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control"

Note: This function appends passed data to existing values

fn spec.config.gceClusterConfig.withTags

withTags(tags)

"Immutable. The Compute Engine tags to add to all instances (see Tagging instances)."

fn spec.config.gceClusterConfig.withTagsMixin

withTagsMixin(tags)

"Immutable. The Compute Engine tags to add to all instances (see Tagging instances)."

Note: This function appends passed data to existing values

fn spec.config.gceClusterConfig.withZone

withZone(zone)

"Immutable. Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present. A full URL, partial URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] * projects/[project_id]/zones/[zone] * us-central1-f"

obj spec.config.gceClusterConfig.confidentialInstanceConfig

"Immutable. Optional. Confidential Instance Config for clusters using Confidential VMs."

fn spec.config.gceClusterConfig.confidentialInstanceConfig.withEnableConfidentialCompute

withEnableConfidentialCompute(enableConfidentialCompute)

"Immutable. Optional. Defines whether the instance should have confidential compute enabled."

obj spec.config.gceClusterConfig.networkRef

"Immutable."

fn spec.config.gceClusterConfig.networkRef.withExternal

withExternal(external)

"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 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\n\nAllowed value: The selfLink field of a ComputeNetwork resource."

fn spec.config.gceClusterConfig.networkRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.gceClusterConfig.networkRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.gceClusterConfig.nodeGroupAffinity

"Immutable. Optional. Node Group Affinity for sole-tenant clusters."

obj spec.config.gceClusterConfig.nodeGroupAffinity.nodeGroupRef

"Immutable."

fn spec.config.gceClusterConfig.nodeGroupAffinity.nodeGroupRef.withExternal

withExternal(external)

"Required. The URI of a sole-tenant node group resource that the cluster will be created on. A full URL, partial URI, or node group name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-central1-a/nodeGroups/node-group-1 * projects/[project_id]/zones/us-central1-a/nodeGroups/node-group-1 * node-group-1\n\nAllowed value: The selfLink field of a ComputeNodeGroup resource."

fn spec.config.gceClusterConfig.nodeGroupAffinity.nodeGroupRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.gceClusterConfig.nodeGroupAffinity.nodeGroupRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.gceClusterConfig.reservationAffinity

"Immutable. Optional. Reservation Affinity for consuming Zonal reservation."

fn spec.config.gceClusterConfig.reservationAffinity.withConsumeReservationType

withConsumeReservationType(consumeReservationType)

"Immutable. Optional. Type of reservation to consume Possible values: TYPE_UNSPECIFIED, NO_RESERVATION, ANY_RESERVATION, SPECIFIC_RESERVATION"

fn spec.config.gceClusterConfig.reservationAffinity.withKey

withKey(key)

"Immutable. Optional. Corresponds to the label key of reservation resource."

fn spec.config.gceClusterConfig.reservationAffinity.withValues

withValues(values)

"Immutable. Optional. Corresponds to the label values of reservation resource."

fn spec.config.gceClusterConfig.reservationAffinity.withValuesMixin

withValuesMixin(values)

"Immutable. Optional. Corresponds to the label values of reservation resource."

Note: This function appends passed data to existing values

obj spec.config.gceClusterConfig.serviceAccountRef

"Immutable."

fn spec.config.gceClusterConfig.serviceAccountRef.withExternal

withExternal(external)

"Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services. If not specified, the Compute Engine default service account is used.\n\nAllowed value: The email field of an IAMServiceAccount resource."

fn spec.config.gceClusterConfig.serviceAccountRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.gceClusterConfig.serviceAccountRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.gceClusterConfig.shieldedInstanceConfig

"Immutable. Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs."

fn spec.config.gceClusterConfig.shieldedInstanceConfig.withEnableIntegrityMonitoring

withEnableIntegrityMonitoring(enableIntegrityMonitoring)

"Immutable. Optional. Defines whether instances have integrity monitoring enabled."

fn spec.config.gceClusterConfig.shieldedInstanceConfig.withEnableSecureBoot

withEnableSecureBoot(enableSecureBoot)

"Immutable. Optional. Defines whether instances have Secure Boot enabled."

fn spec.config.gceClusterConfig.shieldedInstanceConfig.withEnableVtpm

withEnableVtpm(enableVtpm)

"Immutable. Optional. Defines whether instances have the vTPM enabled."

obj spec.config.gceClusterConfig.subnetworkRef

"Immutable."

fn spec.config.gceClusterConfig.subnetworkRef.withExternal

withExternal(external)

"Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. A full URL, partial URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 * projects/[project_id]/regions/us-east1/subnetworks/sub0 * sub0\n\nAllowed value: The selfLink field of a ComputeSubnetwork resource."

fn spec.config.gceClusterConfig.subnetworkRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.gceClusterConfig.subnetworkRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.initializationActions

"Immutable. Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi"

fn spec.config.initializationActions.withExecutableFile

withExecutableFile(executableFile)

"Immutable. Required. Cloud Storage URI of executable file."

fn spec.config.initializationActions.withExecutionTimeout

withExecutionTimeout(executionTimeout)

"Immutable. Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration). Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period."

obj spec.config.lifecycleConfig

"Immutable. Optional. Lifecycle setting for the cluster."

fn spec.config.lifecycleConfig.withAutoDeleteTime

withAutoDeleteTime(autoDeleteTime)

"Immutable. Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp)."

fn spec.config.lifecycleConfig.withAutoDeleteTtl

withAutoDeleteTtl(autoDeleteTtl)

"Immutable. Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration)."

fn spec.config.lifecycleConfig.withIdleDeleteTtl

withIdleDeleteTtl(idleDeleteTtl)

"Immutable. Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 5 minutes; maximum value is 14 days (see JSON representation of Duration)."

obj spec.config.masterConfig

"Immutable. Optional. The Compute Engine config settings for the master instance in a cluster."

fn spec.config.masterConfig.withAccelerators

withAccelerators(accelerators)

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

fn spec.config.masterConfig.withAcceleratorsMixin

withAcceleratorsMixin(accelerators)

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

Note: This function appends passed data to existing values

fn spec.config.masterConfig.withMachineType

withMachineType(machineType)

"Immutable. Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * n1-standard-2 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2."

fn spec.config.masterConfig.withMinCpuPlatform

withMinCpuPlatform(minCpuPlatform)

"Immutable. Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform."

fn spec.config.masterConfig.withNumInstances

withNumInstances(numInstances)

"Immutable. Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1."

fn spec.config.masterConfig.withPreemptibility

withPreemptibility(preemptibility)

"Immutable. Optional. Specifies the preemptibility of the instance group. The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed. The default value for secondary instances is PREEMPTIBLE. Possible values: PREEMPTIBILITY_UNSPECIFIED, NON_PREEMPTIBLE, PREEMPTIBLE"

obj spec.config.masterConfig.accelerators

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

fn spec.config.masterConfig.accelerators.withAcceleratorCount

withAcceleratorCount(acceleratorCount)

"Immutable. The number of the accelerator cards of this type exposed to this instance."

fn spec.config.masterConfig.accelerators.withAcceleratorType

withAcceleratorType(acceleratorType)

"Immutable. Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes. Examples: * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80."

obj spec.config.masterConfig.diskConfig

"Immutable. Optional. Disk option config settings."

fn spec.config.masterConfig.diskConfig.withBootDiskSizeGb

withBootDiskSizeGb(bootDiskSizeGb)

"Immutable. Optional. Size in GB of the boot disk (default is 500GB)."

fn spec.config.masterConfig.diskConfig.withBootDiskType

withBootDiskType(bootDiskType)

"Immutable. Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-balanced\" (Persistent Disk Balanced Solid State Drive), \"pd-ssd\" (Persistent Disk Solid State Drive), or \"pd-standard\" (Persistent Disk Hard Disk Drive). See Disk types."

fn spec.config.masterConfig.diskConfig.withLocalSsdInterface

withLocalSsdInterface(localSsdInterface)

"Immutable. Optional. Interface type of local SSDs (default is \"scsi\"). Valid values: \"scsi\" (Small Computer System Interface), \"nvme\" (Non-Volatile Memory Express). See local SSD performance."

fn spec.config.masterConfig.diskConfig.withNumLocalSsds

withNumLocalSsds(numLocalSsds)

"Immutable. Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries."

obj spec.config.masterConfig.imageRef

"Immutable."

fn spec.config.masterConfig.imageRef.withExternal

withExternal(external)

"Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples: * https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] * projects/[project_id]/global/images/[image-id] * image-id Image family examples. Dataproc will use the most recent image from the family: * https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name] * projects/[project_id]/global/images/family/[custom-image-family-name] If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.\n\nAllowed value: The selfLink field of a ComputeImage resource."

fn spec.config.masterConfig.imageRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.masterConfig.imageRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.metastoreConfig

"Immutable. Optional. Metastore configuration."

obj spec.config.metastoreConfig.dataprocMetastoreServiceRef

"Immutable."

fn spec.config.metastoreConfig.dataprocMetastoreServiceRef.withExternal

withExternal(external)

"Required. Resource name of an existing Dataproc Metastore service. Example: * projects/[project_id]/locations/[dataproc_region]/services/[service-name]"

fn spec.config.metastoreConfig.dataprocMetastoreServiceRef.withName

withName(name)

"[WARNING] DataprocMetastoreService not yet supported in Config Connector, use 'external' field to reference existing resources.\nName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.metastoreConfig.dataprocMetastoreServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.secondaryWorkerConfig

"Immutable. Optional. The Compute Engine config settings for additional worker instances in a cluster."

fn spec.config.secondaryWorkerConfig.withAccelerators

withAccelerators(accelerators)

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

fn spec.config.secondaryWorkerConfig.withAcceleratorsMixin

withAcceleratorsMixin(accelerators)

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

Note: This function appends passed data to existing values

fn spec.config.secondaryWorkerConfig.withMachineType

withMachineType(machineType)

"Immutable. Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * n1-standard-2 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2."

fn spec.config.secondaryWorkerConfig.withMinCpuPlatform

withMinCpuPlatform(minCpuPlatform)

"Immutable. Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform."

fn spec.config.secondaryWorkerConfig.withNumInstances

withNumInstances(numInstances)

"Immutable. Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1."

fn spec.config.secondaryWorkerConfig.withPreemptibility

withPreemptibility(preemptibility)

"Immutable. Optional. Specifies the preemptibility of the instance group. The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed. The default value for secondary instances is PREEMPTIBLE. Possible values: PREEMPTIBILITY_UNSPECIFIED, NON_PREEMPTIBLE, PREEMPTIBLE"

obj spec.config.secondaryWorkerConfig.accelerators

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

fn spec.config.secondaryWorkerConfig.accelerators.withAcceleratorCount

withAcceleratorCount(acceleratorCount)

"Immutable. The number of the accelerator cards of this type exposed to this instance."

fn spec.config.secondaryWorkerConfig.accelerators.withAcceleratorType

withAcceleratorType(acceleratorType)

"Immutable. Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes. Examples: * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80."

obj spec.config.secondaryWorkerConfig.diskConfig

"Immutable. Optional. Disk option config settings."

fn spec.config.secondaryWorkerConfig.diskConfig.withBootDiskSizeGb

withBootDiskSizeGb(bootDiskSizeGb)

"Immutable. Optional. Size in GB of the boot disk (default is 500GB)."

fn spec.config.secondaryWorkerConfig.diskConfig.withBootDiskType

withBootDiskType(bootDiskType)

"Immutable. Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-balanced\" (Persistent Disk Balanced Solid State Drive), \"pd-ssd\" (Persistent Disk Solid State Drive), or \"pd-standard\" (Persistent Disk Hard Disk Drive). See Disk types."

fn spec.config.secondaryWorkerConfig.diskConfig.withLocalSsdInterface

withLocalSsdInterface(localSsdInterface)

"Immutable. Optional. Interface type of local SSDs (default is \"scsi\"). Valid values: \"scsi\" (Small Computer System Interface), \"nvme\" (Non-Volatile Memory Express). See local SSD performance."

fn spec.config.secondaryWorkerConfig.diskConfig.withNumLocalSsds

withNumLocalSsds(numLocalSsds)

"Immutable. Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries."

obj spec.config.secondaryWorkerConfig.imageRef

"Immutable."

fn spec.config.secondaryWorkerConfig.imageRef.withExternal

withExternal(external)

"Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples: * https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] * projects/[project_id]/global/images/[image-id] * image-id Image family examples. Dataproc will use the most recent image from the family: * https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name] * projects/[project_id]/global/images/family/[custom-image-family-name] If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.\n\nAllowed value: The selfLink field of a ComputeImage resource."

fn spec.config.secondaryWorkerConfig.imageRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.secondaryWorkerConfig.imageRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.securityConfig

"Immutable. Optional. Security settings for the cluster."

obj spec.config.securityConfig.identityConfig

"Immutable. Optional. Identity related configuration, including service account based secure multi-tenancy user mappings."

fn spec.config.securityConfig.identityConfig.withUserServiceAccountMapping

withUserServiceAccountMapping(userServiceAccountMapping)

"Immutable. Required. Map of user to service account."

fn spec.config.securityConfig.identityConfig.withUserServiceAccountMappingMixin

withUserServiceAccountMappingMixin(userServiceAccountMapping)

"Immutable. Required. Map of user to service account."

Note: This function appends passed data to existing values

obj spec.config.securityConfig.kerberosConfig

"Immutable. Optional. Kerberos related configuration."

fn spec.config.securityConfig.kerberosConfig.withCrossRealmTrustAdminServer

withCrossRealmTrustAdminServer(crossRealmTrustAdminServer)

"Immutable. Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship."

fn spec.config.securityConfig.kerberosConfig.withCrossRealmTrustKdc

withCrossRealmTrustKdc(crossRealmTrustKdc)

"Immutable. Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship."

fn spec.config.securityConfig.kerberosConfig.withCrossRealmTrustRealm

withCrossRealmTrustRealm(crossRealmTrustRealm)

"Immutable. Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust."

fn spec.config.securityConfig.kerberosConfig.withCrossRealmTrustSharedPassword

withCrossRealmTrustSharedPassword(crossRealmTrustSharedPassword)

"Immutable. Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship."

fn spec.config.securityConfig.kerberosConfig.withEnableKerberos

withEnableKerberos(enableKerberos)

"Immutable. Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster."

fn spec.config.securityConfig.kerberosConfig.withKdcDbKey

withKdcDbKey(kdcDbKey)

"Immutable. Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database."

fn spec.config.securityConfig.kerberosConfig.withKeyPassword

withKeyPassword(keyPassword)

"Immutable. Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc."

fn spec.config.securityConfig.kerberosConfig.withKeystore

withKeystore(keystore)

"Immutable. Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate."

fn spec.config.securityConfig.kerberosConfig.withKeystorePassword

withKeystorePassword(keystorePassword)

"Immutable. Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc."

fn spec.config.securityConfig.kerberosConfig.withRealm

withRealm(realm)

"Immutable. Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm."

fn spec.config.securityConfig.kerberosConfig.withRootPrincipalPassword

withRootPrincipalPassword(rootPrincipalPassword)

"Immutable. Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password."

fn spec.config.securityConfig.kerberosConfig.withTgtLifetimeHours

withTgtLifetimeHours(tgtLifetimeHours)

"Immutable. Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used."

fn spec.config.securityConfig.kerberosConfig.withTruststore

withTruststore(truststore)

"Immutable. Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate."

fn spec.config.securityConfig.kerberosConfig.withTruststorePassword

withTruststorePassword(truststorePassword)

"Immutable. Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc."

obj spec.config.securityConfig.kerberosConfig.kmsKeyRef

"Immutable."

fn spec.config.securityConfig.kerberosConfig.kmsKeyRef.withExternal

withExternal(external)

"Optional. The uri of the KMS key used to encrypt various sensitive files.\n\nAllowed value: The selfLink field of a KMSCryptoKey resource."

fn spec.config.securityConfig.kerberosConfig.kmsKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.securityConfig.kerberosConfig.kmsKeyRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.softwareConfig

"Immutable. Optional. The config settings for software inside the cluster."

fn spec.config.softwareConfig.withImageVersion

withImageVersion(imageVersion)

"Immutable. Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions, such as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the \"preview\" version. If unspecified, it defaults to the latest Debian version."

fn spec.config.softwareConfig.withOptionalComponents

withOptionalComponents(optionalComponents)

"Immutable. Optional. The set of components to activate on the cluster."

fn spec.config.softwareConfig.withOptionalComponentsMixin

withOptionalComponentsMixin(optionalComponents)

"Immutable. Optional. The set of components to activate on the cluster."

Note: This function appends passed data to existing values

fn spec.config.softwareConfig.withProperties

withProperties(properties)

"Immutable. Optional. The properties to set on daemon config files. Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: * capacity-scheduler: capacity-scheduler.xml * core: core-site.xml * distcp: distcp-default.xml * hdfs: hdfs-site.xml * hive: hive-site.xml * mapred: mapred-site.xml * pig: pig.properties * spark: spark-defaults.conf * yarn: yarn-site.xml For more information, see Cluster properties."

fn spec.config.softwareConfig.withPropertiesMixin

withPropertiesMixin(properties)

"Immutable. Optional. The properties to set on daemon config files. Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: * capacity-scheduler: capacity-scheduler.xml * core: core-site.xml * distcp: distcp-default.xml * hdfs: hdfs-site.xml * hive: hive-site.xml * mapred: mapred-site.xml * pig: pig.properties * spark: spark-defaults.conf * yarn: yarn-site.xml For more information, see Cluster properties."

Note: This function appends passed data to existing values

obj spec.config.stagingBucketRef

"Immutable."

fn spec.config.stagingBucketRef.withExternal

withExternal(external)

"Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket). This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket.\n\nAllowed value: The Google Cloud resource name of a StorageBucket resource (format: {{name}})."

fn spec.config.stagingBucketRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.stagingBucketRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.tempBucketRef

"Immutable."

fn spec.config.tempBucketRef.withExternal

withExternal(external)

"Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket. This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket.\n\nAllowed value: The Google Cloud resource name of a StorageBucket resource (format: {{name}})."

fn spec.config.tempBucketRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.tempBucketRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.config.workerConfig

"Immutable. Optional. The Compute Engine config settings for worker instances in a cluster."

fn spec.config.workerConfig.withAccelerators

withAccelerators(accelerators)

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

fn spec.config.workerConfig.withAcceleratorsMixin

withAcceleratorsMixin(accelerators)

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

Note: This function appends passed data to existing values

fn spec.config.workerConfig.withMachineType

withMachineType(machineType)

"Immutable. Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * n1-standard-2 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2."

fn spec.config.workerConfig.withMinCpuPlatform

withMinCpuPlatform(minCpuPlatform)

"Immutable. Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform."

fn spec.config.workerConfig.withNumInstances

withNumInstances(numInstances)

"Immutable. Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1."

fn spec.config.workerConfig.withPreemptibility

withPreemptibility(preemptibility)

"Immutable. Optional. Specifies the preemptibility of the instance group. The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed. The default value for secondary instances is PREEMPTIBLE. Possible values: PREEMPTIBILITY_UNSPECIFIED, NON_PREEMPTIBLE, PREEMPTIBLE"

obj spec.config.workerConfig.accelerators

"Immutable. Optional. The Compute Engine accelerator configuration for these instances."

fn spec.config.workerConfig.accelerators.withAcceleratorCount

withAcceleratorCount(acceleratorCount)

"Immutable. The number of the accelerator cards of this type exposed to this instance."

fn spec.config.workerConfig.accelerators.withAcceleratorType

withAcceleratorType(acceleratorType)

"Immutable. Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes. Examples: * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80."

obj spec.config.workerConfig.diskConfig

"Immutable. Optional. Disk option config settings."

fn spec.config.workerConfig.diskConfig.withBootDiskSizeGb

withBootDiskSizeGb(bootDiskSizeGb)

"Immutable. Optional. Size in GB of the boot disk (default is 500GB)."

fn spec.config.workerConfig.diskConfig.withBootDiskType

withBootDiskType(bootDiskType)

"Immutable. Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-balanced\" (Persistent Disk Balanced Solid State Drive), \"pd-ssd\" (Persistent Disk Solid State Drive), or \"pd-standard\" (Persistent Disk Hard Disk Drive). See Disk types."

fn spec.config.workerConfig.diskConfig.withLocalSsdInterface

withLocalSsdInterface(localSsdInterface)

"Immutable. Optional. Interface type of local SSDs (default is \"scsi\"). Valid values: \"scsi\" (Small Computer System Interface), \"nvme\" (Non-Volatile Memory Express). See local SSD performance."

fn spec.config.workerConfig.diskConfig.withNumLocalSsds

withNumLocalSsds(numLocalSsds)

"Immutable. Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries."

obj spec.config.workerConfig.imageRef

"Immutable."

fn spec.config.workerConfig.imageRef.withExternal

withExternal(external)

"Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples: * https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] * projects/[project_id]/global/images/[image-id] * image-id Image family examples. Dataproc will use the most recent image from the family: * https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name] * projects/[project_id]/global/images/family/[custom-image-family-name] If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.\n\nAllowed value: The selfLink field of a ComputeImage resource."

fn spec.config.workerConfig.imageRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.config.workerConfig.imageRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.projectRef

"Immutable. The Project that this resource belongs to."

fn spec.projectRef.withExternal

withExternal(external)

"Required. The Google Cloud Platform project ID that the cluster belongs to.\n\nAllowed value: The Google Cloud resource name of a Project resource (format: projects/{{name}})."

fn spec.projectRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.projectRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.virtualClusterConfig

"Immutable. Optional. The virtual cluster config is used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified."

obj spec.virtualClusterConfig.auxiliaryServicesConfig

"Immutable. Optional. Configuration of auxiliary services used by this cluster."

obj spec.virtualClusterConfig.auxiliaryServicesConfig.metastoreConfig

"Immutable. Optional. The Hive Metastore configuration for this workload."

obj spec.virtualClusterConfig.auxiliaryServicesConfig.metastoreConfig.dataprocMetastoreServiceRef

"Immutable."

fn spec.virtualClusterConfig.auxiliaryServicesConfig.metastoreConfig.dataprocMetastoreServiceRef.withExternal

withExternal(external)

"Required. Resource name of an existing Dataproc Metastore service. Example: * projects/[project_id]/locations/[dataproc_region]/services/[service-name]"

fn spec.virtualClusterConfig.auxiliaryServicesConfig.metastoreConfig.dataprocMetastoreServiceRef.withName

withName(name)

"[WARNING] DataprocMetastoreService not yet supported in Config Connector, use 'external' field to reference existing resources.\nName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.virtualClusterConfig.auxiliaryServicesConfig.metastoreConfig.dataprocMetastoreServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.virtualClusterConfig.auxiliaryServicesConfig.sparkHistoryServerConfig

"Immutable. Optional. The Spark History Server configuration for the workload."

obj spec.virtualClusterConfig.auxiliaryServicesConfig.sparkHistoryServerConfig.dataprocClusterRef

"Immutable."

fn spec.virtualClusterConfig.auxiliaryServicesConfig.sparkHistoryServerConfig.dataprocClusterRef.withExternal

withExternal(external)

"Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload. Example: * projects/[project_id]/regions/[region]/clusters/[cluster_name]\n\nAllowed value: The selfLink field of a DataprocCluster resource."

fn spec.virtualClusterConfig.auxiliaryServicesConfig.sparkHistoryServerConfig.dataprocClusterRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.virtualClusterConfig.auxiliaryServicesConfig.sparkHistoryServerConfig.dataprocClusterRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.virtualClusterConfig.kubernetesClusterConfig

"Immutable. Required. The configuration for running the Dataproc cluster on Kubernetes."

fn spec.virtualClusterConfig.kubernetesClusterConfig.withKubernetesNamespace

withKubernetesNamespace(kubernetesNamespace)

"Immutable. Optional. A namespace within the Kubernetes cluster to deploy into. If this namespace does not exist, it is created. If it exists, Dataproc verifies that another Dataproc VirtualCluster is not installed into it. If not specified, the name of the Dataproc Cluster is used."

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig

"Immutable. Required. The configuration for running the Dataproc cluster on GKE."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.withNodePoolTarget

withNodePoolTarget(nodePoolTarget)

"Immutable. Optional. GKE node pools where workloads will be scheduled. At least one node pool must be assigned the DEFAULT GkeNodePoolTarget.Role. If a GkeNodePoolTarget is not specified, Dataproc constructs a DEFAULT GkeNodePoolTarget. Each role can be given to only one GkeNodePoolTarget. All node pools must have the same location settings."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.withNodePoolTargetMixin

withNodePoolTargetMixin(nodePoolTarget)

"Immutable. Optional. GKE node pools where workloads will be scheduled. At least one node pool must be assigned the DEFAULT GkeNodePoolTarget.Role. If a GkeNodePoolTarget is not specified, Dataproc constructs a DEFAULT GkeNodePoolTarget. Each role can be given to only one GkeNodePoolTarget. All node pools must have the same location settings."

Note: This function appends passed data to existing values

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.gkeClusterTargetRef

"Immutable."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.gkeClusterTargetRef.withExternal

withExternal(external)

"Optional. A target GKE cluster to deploy to. It must be in the same project and region as the Dataproc cluster (the GKE cluster can be zonal or regional). Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'\n\nAllowed value: The selfLink field of a ContainerCluster resource."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.gkeClusterTargetRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.gkeClusterTargetRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget

"Immutable. Optional. GKE node pools where workloads will be scheduled. At least one node pool must be assigned the DEFAULT GkeNodePoolTarget.Role. If a GkeNodePoolTarget is not specified, Dataproc constructs a DEFAULT GkeNodePoolTarget. Each role can be given to only one GkeNodePoolTarget. All node pools must have the same location settings."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.withRoles

withRoles(roles)

"Immutable. Required. The roles associated with the GKE node pool."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.withRolesMixin

withRolesMixin(roles)

"Immutable. Required. The roles associated with the GKE node pool."

Note: This function appends passed data to existing values

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig

"Immutable. Input only. The configuration for the GKE node pool. If specified, Dataproc attempts to create a node pool with the specified shape. If one with the same name already exists, it is verified against all specified fields. If a field differs, the virtual cluster creation will fail. If omitted, any node pool with the specified name is used. If a node pool with the specified name does not exist, Dataproc create a node pool with default values. This is an input only field. It will not be returned by the API."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.withLocations

withLocations(locations)

"Immutable. Optional. The list of Compute Engine zones where node pool nodes associated with a Dataproc on GKE virtual cluster will be located. Note: All node pools associated with a virtual cluster must be located in the same region as the virtual cluster, and they must be located in the same zone within that region. If a location is not specified during node pool creation, Dataproc on GKE will choose the zone."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.withLocationsMixin

withLocationsMixin(locations)

"Immutable. Optional. The list of Compute Engine zones where node pool nodes associated with a Dataproc on GKE virtual cluster will be located. Note: All node pools associated with a virtual cluster must be located in the same region as the virtual cluster, and they must be located in the same zone within that region. If a location is not specified during node pool creation, Dataproc on GKE will choose the zone."

Note: This function appends passed data to existing values

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.autoscaling

"Immutable. Optional. The autoscaler configuration for this node pool. The autoscaler is enabled only when a valid configuration is present."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.autoscaling.withMaxNodeCount

withMaxNodeCount(maxNodeCount)

"Immutable. The maximum number of nodes in the node pool. Must be >= min_node_count, and must be > 0. Note: Quota must be sufficient to scale up the cluster."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.autoscaling.withMinNodeCount

withMinNodeCount(minNodeCount)

"Immutable. The minimum number of nodes in the node pool. Must be >= 0 and <= max_node_count."

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config

"Immutable. Optional. The node pool configuration."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.withAccelerators

withAccelerators(accelerators)

"Immutable. Optional. A list of hardware accelerators to attach to each node."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.withAcceleratorsMixin

withAcceleratorsMixin(accelerators)

"Immutable. Optional. A list of hardware accelerators to attach to each node."

Note: This function appends passed data to existing values

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.withBootDiskKmsKey

withBootDiskKmsKey(bootDiskKmsKey)

"Immutable. Optional. The [Customer Managed Encryption Key (CMEK)] (https://cloud.google.com/kubernetes-engine/docs/how-to/using-cmek) used to encrypt the boot disk attached to each node in the node pool. Specify the key using the following format: projects/KEY_PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.withLocalSsdCount

withLocalSsdCount(localSsdCount)

"Immutable. Optional. The number of local SSD disks to attach to the node, which is limited by the maximum number of disks allowable per zone (see Adding Local SSDs)."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.withMachineType

withMachineType(machineType)

"Immutable. Optional. The name of a Compute Engine machine type."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.withMinCpuPlatform

withMinCpuPlatform(minCpuPlatform)

"Immutable. Optional. Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or a newer CPU platform. Specify the friendly names of CPU platforms, such as \"Intel Haswell\"` or Intel Sandy Bridge\"."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.withPreemptible

withPreemptible(preemptible)

"Immutable. Optional. Whether the nodes are created as legacy [preemptible VM instances] (https://cloud.google.com/compute/docs/instances/preemptible). Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER [role] (/dataproc/docs/reference/rest/v1/projects.regions.clusters#role) or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role)."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.withSpot

withSpot(spot)

"Immutable. Optional. Whether the nodes are created as [Spot VM instances] (https://cloud.google.com/compute/docs/instances/spot). Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role)."

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.accelerators

"Immutable. Optional. A list of hardware accelerators to attach to each node."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.accelerators.withAcceleratorCount

withAcceleratorCount(acceleratorCount)

"Immutable. The number of accelerator cards exposed to an instance."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.accelerators.withAcceleratorType

withAcceleratorType(acceleratorType)

"Immutable. The accelerator type resource namename (see GPUs on Compute Engine)."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.accelerators.withGpuPartitionSize

withGpuPartitionSize(gpuPartitionSize)

"Immutable. Size of partitions to create on the GPU. Valid values are described in the NVIDIA mig user guide."

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.ephemeralStorageConfig

"Immutable. Optional. Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolConfig.config.ephemeralStorageConfig.withLocalSsdCount

withLocalSsdCount(localSsdCount)

"Immutable. Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage."

obj spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolRef

"Immutable."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolRef.withExternal

withExternal(external)

"Required. The target GKE node pool. Format: 'projects/{project}/locations/{location}/clusters/{cluster}/nodePools/{node_pool}'\n\nAllowed value: The selfLink field of a ContainerNodePool resource."

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.virtualClusterConfig.kubernetesClusterConfig.gkeClusterConfig.nodePoolTarget.nodePoolRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.virtualClusterConfig.kubernetesClusterConfig.kubernetesSoftwareConfig

"Immutable. Optional. The software configuration for this Dataproc cluster running on Kubernetes."

fn spec.virtualClusterConfig.kubernetesClusterConfig.kubernetesSoftwareConfig.withComponentVersion

withComponentVersion(componentVersion)

"Immutable. The components that should be installed in this Dataproc cluster. The key must be a string from the KubernetesComponent enumeration. The value is the version of the software to be installed. At least one entry must be specified."

fn spec.virtualClusterConfig.kubernetesClusterConfig.kubernetesSoftwareConfig.withComponentVersionMixin

withComponentVersionMixin(componentVersion)

"Immutable. The components that should be installed in this Dataproc cluster. The key must be a string from the KubernetesComponent enumeration. The value is the version of the software to be installed. At least one entry must be specified."

Note: This function appends passed data to existing values

fn spec.virtualClusterConfig.kubernetesClusterConfig.kubernetesSoftwareConfig.withProperties

withProperties(properties)

"Immutable. The properties to set on daemon config files. Property keys are specified in prefix:property format, for example spark:spark.kubernetes.container.image. The following are supported prefixes and their mappings: * spark: spark-defaults.conf For more information, see Cluster properties."

fn spec.virtualClusterConfig.kubernetesClusterConfig.kubernetesSoftwareConfig.withPropertiesMixin

withPropertiesMixin(properties)

"Immutable. The properties to set on daemon config files. Property keys are specified in prefix:property format, for example spark:spark.kubernetes.container.image. The following are supported prefixes and their mappings: * spark: spark-defaults.conf For more information, see Cluster properties."

Note: This function appends passed data to existing values

obj spec.virtualClusterConfig.stagingBucketRef

"Immutable."

fn spec.virtualClusterConfig.stagingBucketRef.withExternal

withExternal(external)

"Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.\n\nAllowed value: The Google Cloud resource name of a StorageBucket resource (format: {{name}})."

fn spec.virtualClusterConfig.stagingBucketRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.virtualClusterConfig.stagingBucketRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"