Package-level declarations

Types

Link copied to clipboard
data class AcceleratorConfigResponse(val acceleratorCount: Int, val acceleratorTypeUri: String)

Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).

Link copied to clipboard
data class AutoscalingConfigResponse(val policyUri: String)

Autoscaling Policy config associated with the cluster.

Link copied to clipboard
data class BasicAutoscalingAlgorithmResponse(val cooldownPeriod: String, val yarnConfig: BasicYarnAutoscalingConfigResponse)

Basic algorithm for autoscaling.

Link copied to clipboard
data class BasicYarnAutoscalingConfigResponse(val gracefulDecommissionTimeout: String, val scaleDownFactor: Double, val scaleDownMinWorkerFraction: Double, val scaleUpFactor: Double, val scaleUpMinWorkerFraction: Double)

Basic autoscaling configurations for YARN.

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members with a role.

Link copied to clipboard
data class ClusterConfigResponse(val autoscalingConfig: AutoscalingConfigResponse, val configBucket: String, val encryptionConfig: EncryptionConfigResponse, val endpointConfig: EndpointConfigResponse, val gceClusterConfig: GceClusterConfigResponse, val gkeClusterConfig: GkeClusterConfigResponse, val initializationActions: List<NodeInitializationActionResponse>, val lifecycleConfig: LifecycleConfigResponse, val masterConfig: InstanceGroupConfigResponse, val metastoreConfig: MetastoreConfigResponse, val secondaryWorkerConfig: InstanceGroupConfigResponse, val securityConfig: SecurityConfigResponse, val softwareConfig: SoftwareConfigResponse, val tempBucket: String, val workerConfig: InstanceGroupConfigResponse)

The cluster config.

Link copied to clipboard
data class ClusterMetricsResponse(val hdfsMetrics: Map<String, String>, val yarnMetrics: Map<String, String>)

Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Link copied to clipboard
data class ClusterSelectorResponse(val clusterLabels: Map<String, String>, val zone: String)

A selector that chooses target cluster for jobs based on metadata.

Link copied to clipboard
data class ClusterStatusResponse(val detail: String, val state: String, val stateStartTime: String, val substate: String)

The status of a cluster and its instances.

Link copied to clipboard
data class DiskConfigResponse(val bootDiskSizeGb: Int, val bootDiskType: String, val numLocalSsds: Int)

Specifies the config of disk options for a group of VM instances.

Link copied to clipboard
data class EncryptionConfigResponse(val gcePdKmsKeyName: String)

Encryption settings for the cluster.

Link copied to clipboard
data class EndpointConfigResponse(val enableHttpPortAccess: Boolean, val httpPorts: Map<String, String>)

Endpoint config for this cluster

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Link copied to clipboard
data class GceClusterConfigResponse(val internalIpOnly: Boolean, val metadata: Map<String, String>, val networkUri: String, val nodeGroupAffinity: NodeGroupAffinityResponse, val privateIpv6GoogleAccess: String, val reservationAffinity: ReservationAffinityResponse, val serviceAccount: String, val serviceAccountScopes: List<String>, val shieldedInstanceConfig: ShieldedInstanceConfigResponse, val subnetworkUri: String, val tags: List<String>, val zoneUri: String)

Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster.

Link copied to clipboard
data class GetAutoscalingPolicyIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
Link copied to clipboard
data class GetClusterResult(val clusterName: String, val clusterUuid: String, val config: ClusterConfigResponse, val labels: Map<String, String>, val metrics: ClusterMetricsResponse, val project: String, val status: ClusterStatusResponse, val statusHistory: List<ClusterStatusResponse>)
Link copied to clipboard
data class GetJobResult(val done: Boolean, val driverControlFilesUri: String, val driverOutputResourceUri: String, val hadoopJob: HadoopJobResponse, val hiveJob: HiveJobResponse, val jobUuid: String, val labels: Map<String, String>, val pigJob: PigJobResponse, val placement: JobPlacementResponse, val prestoJob: PrestoJobResponse, val pysparkJob: PySparkJobResponse, val reference: JobReferenceResponse, val scheduling: JobSchedulingResponse, val sparkJob: SparkJobResponse, val sparkRJob: SparkRJobResponse, val sparkSqlJob: SparkSqlJobResponse, val status: JobStatusResponse, val statusHistory: List<JobStatusResponse>, val submittedBy: String, val yarnApplications: List<YarnApplicationResponse>)
data class GetRegionAutoscalingPolicyIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetRegionClusterIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetRegionJobIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetRegionOperationIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetRegionWorkflowTemplateIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetWorkflowTemplateIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetWorkflowTemplateResult(val createTime: String, val dagTimeout: String, val jobs: List<OrderedJobResponse>, val labels: Map<String, String>, val name: String, val parameters: List<TemplateParameterResponse>, val placement: WorkflowTemplatePlacementResponse, val updateTime: String, val version: Int)
Link copied to clipboard
data class GkeClusterConfigResponse(val namespacedGkeDeploymentTarget: NamespacedGkeDeploymentTargetResponse)

The GKE config for this cluster.

Link copied to clipboard
data class HadoopJobResponse(val archiveUris: List<String>, val args: List<String>, val fileUris: List<String>, val jarFileUris: List<String>, val loggingConfig: LoggingConfigResponse, val mainClass: String, val mainJarFileUri: String, val properties: Map<String, String>)

A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).

Link copied to clipboard
data class HiveJobResponse(val continueOnFailure: Boolean, val jarFileUris: List<String>, val properties: Map<String, String>, val queryFileUri: String, val queryList: QueryListResponse, val scriptVariables: Map<String, String>)

A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.

data class InstanceGroupAutoscalingPolicyConfigResponse(val maxInstances: Int, val minInstances: Int, val weight: Int)

Configuration for the size bounds of an instance group, including its proportional size to other groups.

Link copied to clipboard
data class InstanceGroupConfigResponse(val accelerators: List<AcceleratorConfigResponse>, val diskConfig: DiskConfigResponse, val imageUri: String, val instanceNames: List<String>, val instanceReferences: List<InstanceReferenceResponse>, val isPreemptible: Boolean, val machineTypeUri: String, val managedGroupConfig: ManagedGroupConfigResponse, val minCpuPlatform: String, val numInstances: Int, val preemptibility: String)

The config settings for Compute Engine resources in an instance group, such as a master or worker group.

Link copied to clipboard
data class InstanceReferenceResponse(val instanceId: String, val instanceName: String, val publicKey: String)

A reference to a Compute Engine instance.

Link copied to clipboard
data class JobPlacementResponse(val clusterLabels: Map<String, String>, val clusterName: String, val clusterUuid: String)

Dataproc job config.

Link copied to clipboard
data class JobReferenceResponse(val jobId: String, val project: String)

Encapsulates the full scoping used to reference a job.

Link copied to clipboard
data class JobSchedulingResponse(val maxFailuresPerHour: Int, val maxFailuresTotal: Int)

Job scheduling options.

Link copied to clipboard
data class JobStatusResponse(val details: String, val state: String, val stateStartTime: String, val substate: String)

Dataproc job status.

Link copied to clipboard
data class KerberosConfigResponse(val crossRealmTrustAdminServer: String, val crossRealmTrustKdc: String, val crossRealmTrustRealm: String, val crossRealmTrustSharedPasswordUri: String, val enableKerberos: Boolean, val kdcDbKeyUri: String, val keyPasswordUri: String, val keystorePasswordUri: String, val keystoreUri: String, val kmsKeyUri: String, val realm: String, val rootPrincipalPasswordUri: String, val tgtLifetimeHours: Int, val truststorePasswordUri: String, val truststoreUri: String)

Specifies Kerberos related configuration.

Link copied to clipboard
data class LifecycleConfigResponse(val autoDeleteTime: String, val autoDeleteTtl: String, val idleDeleteTtl: String, val idleStartTime: String)

Specifies the cluster auto-delete schedule configuration.

Link copied to clipboard
data class LoggingConfigResponse(val driverLogLevels: Map<String, String>)

The runtime logging config of the job.

Link copied to clipboard
data class ManagedClusterResponse(val clusterName: String, val config: ClusterConfigResponse, val labels: Map<String, String>)

Cluster that is managed by the workflow.

Link copied to clipboard
data class ManagedGroupConfigResponse(val instanceGroupManagerName: String, val instanceTemplateName: String)

Specifies the resources used to actively manage an instance group.

Link copied to clipboard
data class MetastoreConfigResponse(val dataprocMetastoreService: String)

Specifies a Metastore configuration.

Link copied to clipboard
data class NamespacedGkeDeploymentTargetResponse(val clusterNamespace: String, val targetGkeCluster: String)

A full, namespace-isolated deployment target for an existing GKE cluster.

Link copied to clipboard
data class NodeGroupAffinityResponse(val nodeGroupUri: String)

Node Group Affinity for clusters using sole-tenant node groups.

Link copied to clipboard
data class NodeInitializationActionResponse(val executableFile: String, val executionTimeout: String)

Specifies an executable to run on a fully configured node and a timeout period for executable completion.

Link copied to clipboard
data class OrderedJobResponse(val hadoopJob: HadoopJobResponse, val hiveJob: HiveJobResponse, val labels: Map<String, String>, val pigJob: PigJobResponse, val prerequisiteStepIds: List<String>, val prestoJob: PrestoJobResponse, val pysparkJob: PySparkJobResponse, val scheduling: JobSchedulingResponse, val sparkJob: SparkJobResponse, val sparkRJob: SparkRJobResponse, val sparkSqlJob: SparkSqlJobResponse, val stepId: String)

A job executed by the workflow.

Link copied to clipboard

Configuration for parameter validation.

Link copied to clipboard
data class PigJobResponse(val continueOnFailure: Boolean, val jarFileUris: List<String>, val loggingConfig: LoggingConfigResponse, val properties: Map<String, String>, val queryFileUri: String, val queryList: QueryListResponse, val scriptVariables: Map<String, String>)

A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.

Link copied to clipboard
data class PrestoJobResponse(val clientTags: List<String>, val continueOnFailure: Boolean, val loggingConfig: LoggingConfigResponse, val outputFormat: String, val properties: Map<String, String>, val queryFileUri: String, val queryList: QueryListResponse)

A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster.

Link copied to clipboard
data class PySparkJobResponse(val archiveUris: List<String>, val args: List<String>, val fileUris: List<String>, val jarFileUris: List<String>, val loggingConfig: LoggingConfigResponse, val mainPythonFileUri: String, val properties: Map<String, String>, val pythonFileUris: List<String>)

A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.

Link copied to clipboard
data class QueryListResponse(val queries: List<String>)

A list of queries to run on a cluster.

Link copied to clipboard
data class RegexValidationResponse(val regexes: List<String>)

Validation based on regular expressions.

Link copied to clipboard
data class ReservationAffinityResponse(val consumeReservationType: String, val key: String, val values: List<String>)

Reservation Affinity for consuming Zonal reservation.

Link copied to clipboard
data class SecurityConfigResponse(val kerberosConfig: KerberosConfigResponse)

Security related configuration, including encryption, Kerberos, etc.

Link copied to clipboard
data class ShieldedInstanceConfigResponse(val enableIntegrityMonitoring: Boolean, val enableSecureBoot: Boolean, val enableVtpm: Boolean)

Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm).

Link copied to clipboard
data class SoftwareConfigResponse(val imageVersion: String, val optionalComponents: List<String>, val properties: Map<String, String>)

Specifies the selection and config of software inside the cluster.

Link copied to clipboard
data class SparkJobResponse(val archiveUris: List<String>, val args: List<String>, val fileUris: List<String>, val jarFileUris: List<String>, val loggingConfig: LoggingConfigResponse, val mainClass: String, val mainJarFileUri: String, val properties: Map<String, String>)

A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class.

Link copied to clipboard
data class SparkRJobResponse(val archiveUris: List<String>, val args: List<String>, val fileUris: List<String>, val loggingConfig: LoggingConfigResponse, val mainRFileUri: String, val properties: Map<String, String>)

A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN.

Link copied to clipboard
data class SparkSqlJobResponse(val jarFileUris: List<String>, val loggingConfig: LoggingConfigResponse, val properties: Map<String, String>, val queryFileUri: String, val queryList: QueryListResponse, val scriptVariables: Map<String, String>)

A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.

Link copied to clipboard
data class TemplateParameterResponse(val description: String, val fields: List<String>, val name: String, val validation: ParameterValidationResponse)

A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)

Link copied to clipboard
data class ValueValidationResponse(val values: List<String>)

Validation based on a list of allowed values.

Link copied to clipboard
data class WorkflowTemplatePlacementResponse(val clusterSelector: ClusterSelectorResponse, val managedCluster: ManagedClusterResponse)

Specifies workflow execution target.Either managed_cluster or cluster_selector is required.

Link copied to clipboard
data class YarnApplicationResponse(val name: String, val progress: Double, val state: String, val trackingUrl: String)

A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release.