Gcp/dataproc
@swamp/gcp/dataprocv2026.07.28.1
01README
Google Cloud dataproc infrastructure models
02Release Notes
- Updated: workflowtemplates, clusters
03Models
@swamp/gcp/dataproc/autoscalingpoliciesv2026.07.21.3autoscalingpolicies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| basicAlgorithm? | object | Basic algorithm for autoscaling. |
| clusterType? | enum | Optional. The type of the clusters for which this autoscaling policy is to be configured. |
| id? | string | Required. The policy id.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. |
| labels? | record | Optional. The labels to associate with this autoscaling policy. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with an autoscaling policy. |
| secondaryWorkerConfig | object | |
| minInstances? | number | Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0. |
| weight? | number | Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers w |
| workerConfig | object | |
| minInstances? | number | Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0. |
| weight? | number | Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers w |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a autoscalingPolicies
fn get(identifier: string)
Get a autoscalingPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the autoscalingPolicies |
fn update(identifier?: string)
Update autoscalingPolicies attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific autoscalingPolicies by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the autoscalingPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the autoscalingPolicies |
fn sync(identifier?: string)
Sync autoscalingPolicies state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific autoscalingPolicies by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List autoscalingPolicies resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— Describes an autoscaling policy for Dataproc cluster autoscaler.
@swamp/gcp/dataproc/batchesv2026.07.21.4batches.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| environmentConfig? | object | Optional. Environment configuration for the batch execution. |
| labels? | record | Optional. The labels to associate with this batch. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a batch. |
| pysparkBatch? | object | Optional. PySpark batch config. |
| pysparkNotebookBatch? | object | Optional. PySpark notebook batch config. |
| runtimeConfig? | object | Optional. Runtime configuration for the batch execution. |
| sparkBatch? | object | Optional. Spark batch config. |
| sparkRBatch? | object | Optional. SparkR batch config. |
| sparkSqlBatch? | object | Optional. SparkSql batch config. |
| batchId? | string | Optional. The ID to use for the batch, which will become the final component of the batch's resource name.This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/. |
| requestId? | string | Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the operation that corresponds to the first Batch created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a batches
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a batches
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the batches |
fn delete(identifier: string)
Delete the batches
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the batches |
fn sync(identifier?: string)
Sync batches state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific batches by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List batches resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter for the batches to return in the response.A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields: * batch_id * batch_uuid * state * create_time * labels * runtime_info.cohort_info.cohort e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-0 |
| orderBy? | string | Optional. Field(s) on which to sort the list of batches.Currently the only supported sort orders are unspecified (empty) and create_time desc to sort by most recently created batches first.See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn analyze(requestId?: any, requestorId?: any)
analyze
| Argument | Type | Description |
|---|---|---|
| requestId? | any | |
| requestorId? | any |
Resources
state(infinite)— A representation of a batch workload in the service.
@swamp/gcp/dataproc/clustersv2026.07.28.1clusters.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| clusterName? | string | Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused. |
| autoscalingConfig? | object | Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset. |
| auxiliaryNodeGroups? | array | Optional. The node group settings. |
| clusterTier? | enum | Optional. The cluster tier. |
| clusterType? | enum | Optional. The type of the cluster. |
| configBucket? | string | 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, the service 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 staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bu |
| dataprocMetricConfig? | object | Optional. The cluster config for a cluster of Compute Engine Instances. Note that the service may set default values, and values may change when clusters are updated.Exactly one of ClusterConfig or VirtualClusterConfig must be specified. |
| labels? | record | Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. |
| projectId? | string | Required. The Google Cloud Platform project ID that the cluster belongs to. |
| virtualClusterConfig? | object | Optional. The virtual cluster config is used when creating a cluster that does not directly control the underlying compute resources, for example, when creating a GKE cluster (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). the service may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified. |
| region | string | Required. The region in which to handle the request. |
| actionOnFailedPrimaryWorkers? | string | Optional. Failure action when primary worker creation fails. |
| requestId? | string | Optional. A unique ID used to identify the request. If the server receives two CreateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must |
fn create()
Create a clusters
fn get(identifier: string)
Get a clusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the clusters |
fn update(identifier?: string)
Update clusters attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific clusters by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the clusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the clusters |
fn sync(identifier?: string)
Sync clusters state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific clusters by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List clusters resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be "*" to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERRO |
| pageSize? | number | Optional. The maximum number of clusters to return in each response. The service may return fewer than this value. If unspecified, the default value is 200. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn diagnose(diagnosisInterval?: any, job?: any, jobs?: any, tarballAccess?: any, tarballGcsDir?: any, yarnApplicationId?: any, yarnApplicationIds?: any)
diagnose
| Argument | Type | Description |
|---|---|---|
| diagnosisInterval? | any | |
| job? | any | |
| jobs? | any | |
| tarballAccess? | any | |
| tarballGcsDir? | any | |
| yarnApplicationId? | any | |
| yarnApplicationIds? | any |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn inject_credentials(clusterUuid?: any, credentialsCiphertext?: any)
inject credentials
| Argument | Type | Description |
|---|---|---|
| clusterUuid? | any | |
| credentialsCiphertext? | any |
fn repair(cluster?: any, clusterUuid?: any, dataprocSuperUser?: any, gracefulDecommissionTimeout?: any, nodePools?: any, parentOperationId?: any, requestId?: any)
repair
| Argument | Type | Description |
|---|---|---|
| cluster? | any | |
| clusterUuid? | any | |
| dataprocSuperUser? | any | |
| gracefulDecommissionTimeout? | any | |
| nodePools? | any | |
| parentOperationId? | any | |
| requestId? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn start(clusterUuid?: any, requestId?: any)
start
| Argument | Type | Description |
|---|---|---|
| clusterUuid? | any | |
| requestId? | any |
fn stop(clusterUuid?: any, requestId?: any)
stop
| Argument | Type | Description |
|---|---|---|
| clusterUuid? | any | |
| requestId? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— Describes the identifying information, config, and status of a cluster
@swamp/gcp/dataproc/clusters-nodegroupsv2026.07.21.4clusters_nodegroups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| labels? | record | Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labels. |
| name? | string | The Node group resource name (https://aip.dev/122). |
| nodeGroupConfig? | object | Optional. The node group instance group configuration. |
| roles? | array | Required. Node group roles. |
| nodeGroupId? | string | Optional. An optional node group ID. Generated if not specified.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 from 3 to 33 characters. |
| parentOperationId? | string | Optional. operation id of the parent operation sending the create request |
| requestId? | string | Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequest) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only lette |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a nodeGroups
fn get(identifier: string)
Get a nodeGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nodeGroups |
fn sync(identifier?: string)
Sync nodeGroups state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific nodeGroups by name (e.g. one discovered by list) |
fn repair(instanceNames?: any, repairAction?: any, requestId?: any)
repair
| Argument | Type | Description |
|---|---|---|
| instanceNames? | any | |
| repairAction? | any | |
| requestId? | any |
fn resize(gracefulDecommissionTimeout?: any, parentOperationId?: any, requestId?: any, size?: any)
resize
| Argument | Type | Description |
|---|---|---|
| gracefulDecommissionTimeout? | any | |
| parentOperationId? | any | |
| requestId? | any | |
| size? | any |
Resources
state(infinite)— Node Group. The NodeGroup resource is not related to the NodeGroupAffinity re...
@swamp/gcp/dataproc/jobsv2026.07.21.3jobs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| done? | boolean | Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled. |
| driverControlFilesUri? | string | Output only. If present, the location of miscellaneous control files which can be used as part of job setup and handling. If not present, control files might be placed in the same location as driver_output_uri. |
| driverOutputResourceUri? | string | Output only. A URI pointing to the location of the stdout of the job's driver program. |
| driverSchedulingConfig? | object | Optional. Driver scheduling configuration. |
| flinkJob? | object | Optional. Job is a Flink job. |
| hadoopJob? | object | Optional. Job is a Hadoop job. |
| hiveJob? | object | Optional. Job is a Hive job. |
| jobUuid? | string | Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that might be reused over time. |
| labels? | record | Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. |
| pigJob? | object | Optional. Job is a Pig job. |
| placement? | object | Required. Job information, including how, when, and where to run the job. |
| prestoJob? | object | Optional. Job is a Presto job. |
| pysparkJob? | object | Optional. Job is a PySpark job. |
| reference? | object | Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id. |
| scheduling? | object | Optional. Job scheduling configuration. |
| sparkJob? | object | Optional. Job is a Spark job. |
| sparkRJob? | object | Optional. Job is a SparkR job. |
| sparkSqlJob? | object | Optional. Job is a SparkSql job. |
| status? | object | Output only. The job status. Additional application-specific status information might be contained in the type_job and yarn_applications fields. |
| statusHistory? | array | Output only. The previous job status. |
| trinoJob? | object | Optional. Job is a Trino job. |
| yarnApplications? | array | Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. |
| region | string | Required. The Dataproc region in which to handle the request. |
fn get(identifier: string)
Get a jobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobs |
fn update(identifier?: string)
Update jobs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific jobs by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the jobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobs |
fn sync(identifier?: string)
Sync jobs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific jobs by name (e.g. one discovered by list) |
fn list(clusterName?: string, filter?: string, jobStateMatcher?: string, pageSize?: number, maxPages?: number)
List jobs resources
| Argument | Type | Description |
|---|---|---|
| clusterName? | string | Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster. |
| filter? | string | Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or insertTime, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Allows insertTime to be a timestamp in RFC 3339 format in double quotes, such as 2025-01-01T00:00:00Z. Only the logical AND operator is supported; space-separated items are treated as hav |
| jobStateMatcher? | string | Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored. |
| pageSize? | number | Optional. The number of results to return in each response. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn cancel()
cancel
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn submit(job?: any, requestId?: any)
submit
| Argument | Type | Description |
|---|---|---|
| job? | any | |
| requestId? | any |
fn submit_as_operation(job?: any, requestId?: any)
submit as operation
| Argument | Type | Description |
|---|---|---|
| job? | any | |
| requestId? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A Dataproc job resource.
@swamp/gcp/dataproc/sessionsv2026.07.21.4sessions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| environmentConfig? | object | Optional. Environment configuration for the session execution. |
| jupyterSession? | object | Optional. Jupyter session config. |
| labels? | record | Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session. |
| name? | string | Identifier. The resource name of the session. |
| runtimeConfig? | object | Optional. Runtime configuration for the session execution. |
| sessionTemplate? | string | Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session. |
| sparkConnectSession? | object | Optional. Spark connect session config. |
| user? | string | Optional. The email address of the user who owns the session. |
| requestId? | string | Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored, and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9 |
| sessionId? | string | Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a sessions
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn delete(identifier: string)
Delete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn sync(identifier?: string)
Sync sessions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessions by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List sessions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = A |
| pageSize? | number | Optional. The maximum number of sessions to return in each response. The service may return fewer than this value. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn terminate(requestId?: any)
terminate
| Argument | Type | Description |
|---|---|---|
| requestId? | any |
Resources
state(infinite)— A representation of a session.
@swamp/gcp/dataproc/sessiontemplatesv2026.07.21.4sessiontemplates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| description? | string | Optional. Brief description of the template. |
| environmentConfig? | object | Optional. Environment configuration for session execution. |
| jupyterSession? | object | Optional. Jupyter session config. |
| labels? | record | Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session. |
| name? | string | Required. Identifier. The resource name of the session template. |
| runtimeConfig? | object | Optional. Runtime configuration for session execution. |
| sparkConnectSession? | object | Optional. Spark connect session config. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a sessionTemplates
fn get(identifier: string)
Get a sessionTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessionTemplates |
fn update(identifier?: string)
Update sessionTemplates attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessionTemplates by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the sessionTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessionTemplates |
fn sync(identifier?: string)
Sync sessionTemplates state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessionTemplates by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List sessionTemplates resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter for the session templates to return in the response. Filters are case sensitive and have the following syntax:field = value AND field = value ... |
| pageSize? | number | Optional. The maximum number of sessions to return in each response. The service may return fewer than this value. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A representation of a session template.
@swamp/gcp/dataproc/workflowtemplatesv2026.07.28.1workflowtemplates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| dagTimeout? | string | 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, the cluster is deleted. |
| encryptionConfig? | object | Optional. Encryption settings for encrypting workflow template job arguments. |
| id? | string | |
| jobs? | array | Required. The Directed Acyclic Graph of Jobs to submit. |
| labels? | record | Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. |
| parameters? | array | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. |
| placement? | object | Required. WorkflowTemplate scheduling information. |
| version? | number | Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a workflowTemplates
fn get(identifier: string)
Get a workflowTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowTemplates |
fn update(identifier?: string)
Update workflowTemplates attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workflowTemplates by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the workflowTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowTemplates |
fn sync(identifier?: string)
Sync workflowTemplates state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workflowTemplates by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List workflowTemplates resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of results to return in each response. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn instantiate(parameters?: any, requestId?: any, version?: any)
instantiate
| Argument | Type | Description |
|---|---|---|
| parameters? | any | |
| requestId? | any | |
| version? | any |
fn instantiate_inline(createTime?: any, dagTimeout?: any, encryptionConfig?: any, id?: any, jobs?: any, labels?: any, name?: any, parameters?: any, placement?: any, updateTime?: any, version?: any)
instantiate inline
| Argument | Type | Description |
|---|---|---|
| createTime? | any | |
| dagTimeout? | any | |
| encryptionConfig? | any | |
| id? | any | |
| jobs? | any | |
| labels? | any | |
| name? | any | |
| parameters? | any | |
| placement? | any | |
| updateTime? | any | |
| version? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A Dataproc workflow template resource.
04Previous Versions
2026.07.21.4
- Updated: batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups
2026.07.21.1
- Updated: autoscalingpolicies, batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups, jobs
2026.07.20.2
- Updated: batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups
2026.07.20.1
- Updated: autoscalingpolicies, batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups, jobs
2026.07.19.2
- Updated: jobs
2026.07.19.1
- Updated: autoscalingpolicies, batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups, jobs
2026.07.18.2
- Updated: autoscalingpolicies, batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups, jobs
2026.07.17.2
- Updated: sessiontemplates, sessions, clusters, clusters_nodegroups, jobs
2026.07.17.1
- Updated: autoscalingpolicies, batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups
2026.07.02.1
- Updated: clusters, clusters_nodegroups
2026.06.24.1
- Updated: workflowtemplates, clusters
2026.06.08.2
- Updated: autoscalingpolicies, batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups, jobs
2026.06.07.1
- Updated: autoscalingpolicies, batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups, jobs
2026.06.05.1
- Updated: batches, workflowtemplates, clusters, clusters_nodegroups
2026.05.28.1
- Updated: batches, sessions
2026.05.27.1
- Updated: batches, sessions
2026.05.26.1
- Updated: batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups
2026.05.25.2
- Updated: autoscalingpolicies, batches, sessiontemplates, sessions, workflowtemplates, clusters, clusters_nodegroups, jobs
Modified 7 models
2026.05.25.1
- Updated: batches, sessions
05Stats
A
100 / 100
Downloads
0
Archive size
307.0 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels