Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / dataproc.v1beta2.json
blob: d7e654aaeb2f5e4711cd3b84f3cbe61d588ea4e3 [file] [log] [blame] [edit]
{
"protocol": "rest",
"version_module": true,
"description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
"version": "v1beta2",
"documentationLink": "https://cloud.google.com/dataproc/",
"kind": "discovery#restDescription",
"canonicalName": "Dataproc",
"id": "dataproc:v1beta2",
"basePath": "",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"revision": "20201029",
"name": "dataproc",
"ownerDomain": "google.com",
"rootUrl": "https://dataproc.googleapis.com/",
"mtlsRootUrl": "https://dataproc.mtls.googleapis.com/",
"baseUrl": "https://dataproc.googleapis.com/",
"parameters": {
"$.xgafv": {
"enum": [
"1",
"2"
],
"location": "query",
"type": "string",
"description": "V1 error format.",
"enumDescriptions": [
"v1 error format",
"v2 error format"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"uploadType": {
"type": "string",
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"callback": {
"type": "string",
"location": "query",
"description": "JSONP"
},
"key": {
"type": "string",
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"enum": [
"json",
"media",
"proto"
],
"description": "Data format for response.",
"type": "string",
"default": "json",
"location": "query"
},
"quotaUser": {
"type": "string",
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"location": "query",
"default": "true"
},
"upload_protocol": {
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query"
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
}
},
"title": "Cloud Dataproc API",
"ownerName": "Google",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"schemas": {
"YarnApplication": {
"properties": {
"trackingUrl": {
"description": "Output only. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The application name.",
"readOnly": true,
"type": "string"
},
"progress": {
"format": "float",
"readOnly": true,
"description": "Output only. The numerical progress of the application, from 1 to 100.",
"type": "number"
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"NEW",
"NEW_SAVING",
"SUBMITTED",
"ACCEPTED",
"RUNNING",
"FINISHED",
"FAILED",
"KILLED"
],
"enumDescriptions": [
"Status is unspecified.",
"Status is NEW.",
"Status is NEW_SAVING.",
"Status is SUBMITTED.",
"Status is ACCEPTED.",
"Status is RUNNING.",
"Status is FINISHED.",
"Status is FAILED.",
"Status is KILLED."
],
"description": "Output only. The application state.",
"type": "string",
"readOnly": true
}
},
"id": "YarnApplication",
"description": "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.",
"type": "object"
},
"QueryList": {
"id": "QueryList",
"type": "object",
"description": "A list of queries to run on a cluster.",
"properties": {
"queries": {
"type": "array",
"description": "Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: \"hiveJob\": { \"queryList\": { \"queries\": [ \"query1\", \"query2\", \"query3;query4\", ] } } ",
"items": {
"type": "string"
}
}
}
},
"NamespacedGkeDeploymentTarget": {
"properties": {
"clusterNamespace": {
"type": "string",
"description": "Optional. A namespace within the GKE cluster to deploy into."
},
"targetGkeCluster": {
"type": "string",
"description": "Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'"
}
},
"id": "NamespacedGkeDeploymentTarget",
"description": "A full, namespace-isolated deployment target for an existing GKE cluster.",
"type": "object"
},
"ClusterSelector": {
"properties": {
"zone": {
"type": "string",
"description": "Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used."
},
"clusterLabels": {
"description": "Required. The cluster labels. Cluster must have all labels to match.",
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"id": "ClusterSelector",
"type": "object",
"description": "A selector that chooses target cluster for jobs based on metadata."
},
"RegexValidation": {
"properties": {
"regexes": {
"items": {
"type": "string"
},
"type": "array",
"description": "Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient)."
}
},
"id": "RegexValidation",
"description": "Validation based on regular expressions.",
"type": "object"
},
"OrderedJob": {
"properties": {
"pigJob": {
"$ref": "PigJob",
"description": "Optional. Job is a Pig job."
},
"hadoopJob": {
"$ref": "HadoopJob",
"description": "Optional. Job is a Hadoop job."
},
"stepId": {
"description": "Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.",
"type": "string"
},
"sparkJob": {
"description": "Optional. Job is a Spark job.",
"$ref": "SparkJob"
},
"prestoJob": {
"$ref": "PrestoJob",
"description": "Optional. Job is a Presto job."
},
"pysparkJob": {
"description": "Optional. Job is a PySpark job.",
"$ref": "PySparkJob"
},
"scheduling": {
"description": "Optional. Job scheduling configuration.",
"$ref": "JobScheduling"
},
"sparkRJob": {
"description": "Optional. Job is a SparkR job.",
"$ref": "SparkRJob"
},
"sparkSqlJob": {
"description": "Optional. Job is a SparkSql job.",
"$ref": "SparkSqlJob"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 32 labels can be associated with a given job."
},
"prerequisiteStepIds": {
"description": "Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.",
"items": {
"type": "string"
},
"type": "array"
},
"hiveJob": {
"description": "Optional. Job is a Hive job.",
"$ref": "HiveJob"
}
},
"type": "object",
"id": "OrderedJob",
"description": "A job executed by the workflow."
},
"JobMetadata": {
"properties": {
"startTime": {
"readOnly": true,
"description": "Output only. Job submission time.",
"format": "google-datetime",
"type": "string"
},
"jobId": {
"description": "Output only. The job id.",
"readOnly": true,
"type": "string"
},
"status": {
"readOnly": true,
"$ref": "JobStatus",
"description": "Output only. Most recent job status."
},
"operationType": {
"description": "Output only. Operation type.",
"type": "string",
"readOnly": true
}
},
"id": "JobMetadata",
"type": "object",
"description": "Job Operation metadata."
},
"InstanceGroupAutoscalingPolicyConfig": {
"type": "object",
"description": "Configuration for the size bounds of an instance group, including its proportional size to other groups.",
"id": "InstanceGroupAutoscalingPolicyConfig",
"properties": {
"weight": {
"type": "integer",
"format": "int32",
"description": "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 will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers."
},
"minInstances": {
"format": "int32",
"description": "Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.",
"type": "integer"
},
"maxInstances": {
"description": "Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.",
"format": "int32",
"type": "integer"
}
}
},
"EndpointConfig": {
"type": "object",
"properties": {
"httpPorts": {
"type": "object",
"readOnly": true,
"description": "Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.",
"additionalProperties": {
"type": "string"
}
},
"enableHttpPortAccess": {
"description": "Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.",
"type": "boolean"
}
},
"id": "EndpointConfig",
"description": "Endpoint config for this cluster"
},
"SparkSqlJob": {
"type": "object",
"properties": {
"properties": {
"description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"queryFileUri": {
"type": "string",
"description": "The HCFS URI of the script that contains SQL queries."
},
"queryList": {
"description": "A list of queries.",
"$ref": "QueryList"
},
"jarFileUris": {
"type": "array",
"description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
"items": {
"type": "string"
}
},
"loggingConfig": {
"$ref": "LoggingConfig",
"description": "Optional. The runtime log config for job execution."
},
"scriptVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";)."
}
},
"id": "SparkSqlJob",
"description": "A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries."
},
"GceClusterConfig": {
"id": "GceClusterConfig",
"properties": {
"nodeGroupAffinity": {
"description": "Optional. Node Group Affinity for sole-tenant clusters.",
"$ref": "NodeGroupAffinity"
},
"zoneUri": {
"type": "string",
"description": "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"
},
"networkUri": {
"type": "string",
"description": "Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default projects/[project_id]/regions/global/default default"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata))."
},
"tags": {
"description": "The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).",
"items": {
"type": "string"
},
"type": "array"
},
"reservationAffinity": {
"$ref": "ReservationAffinity",
"description": "Optional. Reservation Affinity for consuming Zonal reservation."
},
"privateIpv6GoogleAccess": {
"description": "Optional. The type of IPv6 access for a cluster.",
"enum": [
"PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED",
"INHERIT_FROM_SUBNETWORK",
"OUTBOUND",
"BIDIRECTIONAL"
],
"enumDescriptions": [
"If unspecified, Compute Engine default behavior will apply, which is the same as INHERIT_FROM_SUBNETWORK.",
"Private access to and from Google Services configuration inherited from the subnetwork configuration. This is the default Compute Engine behavior.",
"Enables outbound private IPv6 access to Google Services from the Dataproc cluster.",
"Enables bidirectional private IPv6 access between Google Services and the Dataproc cluster."
],
"type": "string"
},
"serviceAccount": {
"description": "Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.",
"type": "string"
},
"serviceAccountScopes": {
"items": {
"type": "string"
},
"type": "array",
"description": "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.writeIf 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"
},
"internalIpOnly": {
"type": "boolean",
"description": "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."
},
"subnetworkUri": {
"description": "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",
"type": "string"
}
},
"type": "object",
"description": "Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster."
},
"NodeInitializationAction": {
"properties": {
"executableFile": {
"type": "string",
"description": "Required. Cloud Storage URI of executable file."
},
"executionTimeout": {
"description": "Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).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.",
"format": "google-duration",
"type": "string"
}
},
"type": "object",
"id": "NodeInitializationAction",
"description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion."
},
"ClusterOperationStatus": {
"properties": {
"stateStartTime": {
"description": "Output only. The time this state was entered.",
"type": "string",
"format": "google-datetime"
},
"innerState": {
"description": "Output only. A message containing the detailed operation state.",
"type": "string"
},
"state": {
"enum": [
"UNKNOWN",
"PENDING",
"RUNNING",
"DONE"
],
"enumDescriptions": [
"Unused.",
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
],
"description": "Output only. A message containing the operation state.",
"type": "string"
},
"details": {
"type": "string",
"description": "Output only. A message containing any operation metadata details."
}
},
"type": "object",
"description": "The status of the operation.",
"id": "ClusterOperationStatus"
},
"WorkflowTemplate": {
"description": "A Dataproc workflow template resource.",
"id": "WorkflowTemplate",
"properties": {
"version": {
"format": "int32",
"description": "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 of the UpdateWorkflowTemplate request.",
"type": "integer"
},
"name": {
"type": "string",
"readOnly": true,
"description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}"
},
"createTime": {
"readOnly": true,
"format": "google-datetime",
"description": "Output only. The time template was created.",
"type": "string"
},
"updateTime": {
"type": "string",
"readOnly": true,
"description": "Output only. The time template was last updated.",
"format": "google-datetime"
},
"id": {
"description": "Required. The template 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..",
"type": "string"
},
"jobs": {
"type": "array",
"items": {
"$ref": "OrderedJob"
},
"description": "Required. The Directed Acyclic Graph of Jobs to submit."
},
"placement": {
"description": "Required. WorkflowTemplate scheduling information.",
"$ref": "WorkflowTemplatePlacement"
},
"labels": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string"
}
},
"dagTimeout": {
"format": "google-duration",
"description": "Optional. Timeout duration for the DAG of jobs. You can use \"s\", \"m\", \"h\", and \"d\" suffixes for second, minute, hour, and day duration values, respectively. The timeout duration must be from 10 minutes (\"10m\") to 24 hours (\"24h\" or \"1d\"). 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.",
"type": "string"
},
"parameters": {
"description": "Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.",
"items": {
"$ref": "TemplateParameter"
},
"type": "array"
}
},
"type": "object"
},
"AcceleratorConfig": {
"type": "object",
"properties": {
"acceleratorCount": {
"format": "int32",
"description": "The number of the accelerator cards of this type exposed to this instance.",
"type": "integer"
},
"acceleratorTypeUri": {
"type": "string",
"description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/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-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80."
}
},
"description": "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/)).",
"id": "AcceleratorConfig"
},
"WorkflowGraph": {
"type": "object",
"description": "The workflow graph.",
"id": "WorkflowGraph",
"properties": {
"nodes": {
"type": "array",
"readOnly": true,
"description": "Output only. The workflow nodes.",
"items": {
"$ref": "WorkflowNode"
}
}
}
},
"Operation": {
"type": "object",
"id": "Operation",
"properties": {
"metadata": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"name": {
"type": "string",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}."
},
"done": {
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
},
"response": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object",
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse."
}
},
"description": "This resource represents a long-running operation that is the result of a network API call."
},
"GetPolicyOptions": {
"id": "GetPolicyOptions",
"type": "object",
"properties": {
"requestedPolicyVersion": {
"format": "int32",
"description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"type": "integer"
}
},
"description": "Encapsulates settings provided to GetIamPolicy."
},
"BasicAutoscalingAlgorithm": {
"id": "BasicAutoscalingAlgorithm",
"properties": {
"cooldownPeriod": {
"format": "google-duration",
"type": "string",
"description": "Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m."
},
"yarnConfig": {
"description": "Required. YARN autoscaling configuration.",
"$ref": "BasicYarnAutoscalingConfig"
}
},
"description": "Basic algorithm for autoscaling.",
"type": "object"
},
"PrestoJob": {
"id": "PrestoJob",
"properties": {
"continueOnFailure": {
"type": "boolean",
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries."
},
"outputFormat": {
"description": "Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats",
"type": "string"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI"
},
"clientTags": {
"description": "Optional. Presto client tags to attach to this query",
"items": {
"type": "string"
},
"type": "array"
},
"queryList": {
"description": "A list of queries.",
"$ref": "QueryList"
},
"loggingConfig": {
"$ref": "LoggingConfig",
"description": "Optional. The runtime log config for job execution."
},
"queryFileUri": {
"type": "string",
"description": "The HCFS URI of the script that contains SQL queries."
}
},
"type": "object",
"description": "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."
},
"SparkJob": {
"description": "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.",
"properties": {
"mainClass": {
"type": "string",
"description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris."
},
"fileUris": {
"type": "array",
"description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.",
"items": {
"type": "string"
}
},
"archiveUris": {
"description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
"items": {
"type": "string"
},
"type": "array"
},
"jarFileUris": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks."
},
"mainJarFileUri": {
"type": "string",
"description": "The HCFS URI of the jar file that contains the main class."
},
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"type": "array",
"items": {
"type": "string"
}
},
"loggingConfig": {
"$ref": "LoggingConfig",
"description": "Optional. The runtime log config for job execution."
},
"properties": {
"description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object",
"id": "SparkJob"
},
"HadoopJob": {
"id": "HadoopJob",
"description": "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).",
"properties": {
"mainJarFileUri": {
"type": "string",
"description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'"
},
"mainClass": {
"type": "string",
"description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris."
},
"archiveUris": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip."
},
"fileUris": {
"items": {
"type": "string"
},
"description": "Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.",
"type": "array"
},
"properties": {
"description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"type": "array",
"items": {
"type": "string"
}
},
"loggingConfig": {
"$ref": "LoggingConfig",
"description": "Optional. The runtime log config for job execution."
},
"jarFileUris": {
"description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"WorkflowMetadata": {
"properties": {
"dagStartTime": {
"format": "google-datetime",
"readOnly": true,
"type": "string",
"description": "Output only. DAG start time, which is only set for workflows with dag_timeout when the DAG begins."
},
"parameters": {
"type": "object",
"description": "Map from parameter names to values that were used for those parameters.",
"additionalProperties": {
"type": "string"
}
},
"createCluster": {
"$ref": "ClusterOperation",
"readOnly": true,
"description": "Output only. The create cluster operation metadata."
},
"state": {
"enum": [
"UNKNOWN",
"PENDING",
"RUNNING",
"DONE"
],
"type": "string",
"enumDescriptions": [
"Unused.",
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
],
"readOnly": true,
"description": "Output only. The workflow state."
},
"clusterUuid": {
"description": "Output only. The UUID of target cluster.",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. Workflow end time.",
"type": "string",
"readOnly": true,
"format": "google-datetime"
},
"dagTimeout": {
"type": "string",
"readOnly": true,
"description": "Output only. The timeout duration for the DAG of jobs. Minimum timeout duration is 10 minutes and maximum is 24 hours, expressed as a google.protobuf.Duration. For example, \"1800\" = 1800 seconds/30 minutes duration.",
"format": "google-duration"
},
"clusterName": {
"type": "string",
"description": "Output only. The name of the target cluster.",
"readOnly": true
},
"template": {
"type": "string",
"description": "Output only. The resource name of the workflow template as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"readOnly": true
},
"version": {
"type": "integer",
"format": "int32",
"description": "Output only. The version of template at the time of workflow instantiation.",
"readOnly": true
},
"startTime": {
"description": "Output only. Workflow start time.",
"readOnly": true,
"type": "string",
"format": "google-datetime"
},
"deleteCluster": {
"readOnly": true,
"$ref": "ClusterOperation",
"description": "Output only. The delete cluster operation metadata."
},
"dagEndTime": {
"type": "string",
"description": "Output only. DAG end time, which is only set for workflows with dag_timeout when the DAG ends.",
"format": "google-datetime",
"readOnly": true
},
"graph": {
"readOnly": true,
"$ref": "WorkflowGraph",
"description": "Output only. The workflow graph."
}
},
"type": "object",
"id": "WorkflowMetadata",
"description": "A Dataproc workflow template resource."
},
"ListWorkflowTemplatesResponse": {
"type": "object",
"properties": {
"templates": {
"type": "array",
"items": {
"$ref": "WorkflowTemplate"
},
"description": "Output only. WorkflowTemplates list.",
"readOnly": true
},
"nextPageToken": {
"description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListWorkflowTemplatesRequest.",
"type": "string",
"readOnly": true
}
},
"id": "ListWorkflowTemplatesResponse",
"description": "A response to a request to list workflow templates in a project."
},
"SubmitJobRequest": {
"id": "SubmitJobRequest",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job 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 contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters."
},
"job": {
"$ref": "Job",
"description": "Required. The job resource."
}
},
"description": "A request to submit a job."
},
"InstantiateWorkflowTemplateRequest": {
"type": "object",
"properties": {
"instanceId": {
"description": "Deprecated. Please use request_id field instead.",
"type": "string"
},
"requestId": {
"description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"type": "string"
},
"version": {
"description": "Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.",
"format": "int32",
"type": "integer"
},
"parameters": {
"type": "object",
"description": "Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.",
"additionalProperties": {
"type": "string"
}
}
},
"description": "A request to instantiate a workflow template.",
"id": "InstantiateWorkflowTemplateRequest"
},
"Status": {
"properties": {
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
},
"code": {
"type": "integer",
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code."
},
"details": {
"type": "array",
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
}
}
},
"type": "object",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "Status"
},
"CancelJobRequest": {
"type": "object",
"properties": {},
"description": "A request to cancel a job.",
"id": "CancelJobRequest"
},
"HiveJob": {
"id": "HiveJob",
"properties": {
"queryFileUri": {
"type": "string",
"description": "The HCFS URI of the script that contains Hive queries."
},
"jarFileUris": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs."
},
"scriptVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";)."
},
"queryList": {
"$ref": "QueryList",
"description": "A list of queries."
},
"continueOnFailure": {
"type": "boolean",
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries."
},
"properties": {
"description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"description": "A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object"
},
"KerberosConfig": {
"type": "object",
"description": "Specifies Kerberos related configuration.",
"properties": {
"enableKerberos": {
"type": "boolean",
"description": "Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster."
},
"rootPrincipalPasswordUri": {
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.",
"type": "string"
},
"truststorePasswordUri": {
"description": "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.",
"type": "string"
},
"crossRealmTrustKdc": {
"description": "Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.",
"type": "string"
},
"keystoreUri": {
"description": "Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.",
"type": "string"
},
"crossRealmTrustRealm": {
"description": "Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.",
"type": "string"
},
"keystorePasswordUri": {
"description": "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.",
"type": "string"
},
"keyPasswordUri": {
"description": "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.",
"type": "string"
},
"crossRealmTrustAdminServer": {
"description": "Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.",
"type": "string"
},
"kmsKeyUri": {
"description": "Optional. The uri of the KMS key used to encrypt various sensitive files.",
"type": "string"
},
"truststoreUri": {
"type": "string",
"description": "Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate."
},
"kdcDbKeyUri": {
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.",
"type": "string"
},
"realm": {
"description": "Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.",
"type": "string"
},
"tgtLifetimeHours": {
"description": "Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.",
"type": "integer",
"format": "int32"
},
"crossRealmTrustSharedPasswordUri": {
"description": "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.",
"type": "string"
}
},
"id": "KerberosConfig"
},
"DiskConfig": {
"type": "object",
"properties": {
"bootDiskType": {
"type": "string",
"description": "Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) or \"pd-standard\" (Persistent Disk Hard Disk Drive)."
},
"numLocalSsds": {
"type": "integer",
"description": "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 (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) 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.",
"format": "int32"
},
"bootDiskSizeGb": {
"format": "int32",
"type": "integer",
"description": "Optional. Size in GB of the boot disk (default is 500GB)."
}
},
"id": "DiskConfig",
"description": "Specifies the config of disk options for a group of VM instances."
},
"JobPlacement": {
"type": "object",
"properties": {
"clusterUuid": {
"type": "string",
"description": "Output only. A cluster UUID generated by the Dataproc service when the job is submitted.",
"readOnly": true
},
"clusterName": {
"description": "Required. The name of the cluster where the job will be submitted.",
"type": "string"
}
},
"description": "Dataproc job config.",
"id": "JobPlacement"
},
"ManagedGroupConfig": {
"id": "ManagedGroupConfig",
"description": "Specifies the resources used to actively manage an instance group.",
"type": "object",
"properties": {
"instanceTemplateName": {
"readOnly": true,
"description": "Output only. The name of the Instance Template used for the Managed Instance Group.",
"type": "string"
},
"instanceGroupManagerName": {
"description": "Output only. The name of the Instance Group Manager for this group.",
"readOnly": true,
"type": "string"
}
}
},
"ClusterOperation": {
"type": "object",
"id": "ClusterOperation",
"properties": {
"operationId": {
"type": "string",
"readOnly": true,
"description": "Output only. The id of the cluster operation."
},
"done": {
"description": "Output only. Indicates the operation is done.",
"readOnly": true,
"type": "boolean"
},
"error": {
"description": "Output only. Error, if operation failed.",
"readOnly": true,
"type": "string"
}
},
"description": "The cluster operation triggered by a workflow."
},
"AutoscalingConfig": {
"id": "AutoscalingConfig",
"description": "Autoscaling Policy config associated with the cluster.",
"type": "object",
"properties": {
"policyUri": {
"type": "string",
"description": "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."
}
}
},
"TestIamPermissionsRequest": {
"description": "Request message for TestIamPermissions method.",
"id": "TestIamPermissionsRequest",
"properties": {
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions)."
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.",
"properties": {},
"id": "Empty",
"type": "object"
},
"Policy": {
"id": "Policy",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:[email protected]\", \"group:[email protected]\", \"domain:google.com\", \"serviceAccount:[email protected]\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:[email protected]\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } YAML example: bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).",
"properties": {
"version": {
"description": "Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
},
"etag": {
"description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.",
"format": "byte",
"type": "string"
},
"bindings": {
"type": "array",
"items": {
"$ref": "Binding"
},
"description": "Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member."
}
},
"type": "object"
},
"DiagnoseClusterRequest": {
"id": "DiagnoseClusterRequest",
"type": "object",
"description": "A request to collect cluster diagnostic information.",
"properties": {}
},
"JobScheduling": {
"id": "JobScheduling",
"type": "object",
"description": "Job scheduling options.",
"properties": {
"maxFailuresTotal": {
"description": "Optional. Maximum number of times in total a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. Maximum value is 240",
"type": "integer",
"format": "int32"
},
"maxFailuresPerHour": {
"format": "int32",
"type": "integer",
"description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10."
}
}
},
"TemplateParameter": {
"properties": {
"description": {
"type": "string",
"description": "Optional. Brief description of the parameter. Must not exceed 1024 characters."
},
"name": {
"description": "Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.",
"type": "string"
},
"fields": {
"type": "array",
"description": "Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax: Values in maps can be referenced by key: labels'key' placement.clusterSelector.clusterLabels'key' placement.managedCluster.labels'key' placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' Jobs in the jobs list can be referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other examples: jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: placement.clusterSelector.clusterLabels jobs'step-id'.sparkJob.args",
"items": {
"type": "string"
}
},
"validation": {
"description": "Optional. Validation rules to be applied to this parameter's value.",
"$ref": "ParameterValidation"
}
},
"type": "object",
"id": "TemplateParameter",
"description": "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)"
},
"BasicYarnAutoscalingConfig": {
"id": "BasicYarnAutoscalingConfig",
"description": "Basic autoscaling configurations for YARN.",
"type": "object",
"properties": {
"scaleUpFactor": {
"type": "number",
"format": "double",
"description": "Required. Fraction of average YARN pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling). See How autoscaling works for more information.Bounds: 0.0, 1.0."
},
"scaleUpMinWorkerFraction": {
"format": "double",
"type": "number",
"description": "Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0."
},
"gracefulDecommissionTimeout": {
"type": "string",
"format": "google-duration",
"description": "Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d."
},
"scaleDownFactor": {
"format": "double",
"description": "Required. Fraction of average YARN pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job. See How autoscaling works for more information.Bounds: 0.0, 1.0.",
"type": "number"
},
"scaleDownMinWorkerFraction": {
"type": "number",
"format": "double",
"description": "Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0."
}
}
},
"ListOperationsResponse": {
"properties": {
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"description": "The response message for Operations.ListOperations.",
"type": "object",
"id": "ListOperationsResponse"
},
"JobStatus": {
"id": "JobStatus",
"properties": {
"details": {
"description": "Output only. Optional Job state details, such as an error description if the state is ERROR.",
"type": "string",
"readOnly": true
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"SETUP_DONE",
"RUNNING",
"CANCEL_PENDING",
"CANCEL_STARTED",
"CANCELLED",
"DONE",
"ERROR",
"ATTEMPT_FAILURE"
],
"readOnly": true,
"type": "string",
"description": "Output only. A state message specifying the overall job state.",
"enumDescriptions": [
"The job state is unknown.",
"The job is pending; it has been submitted, but is not yet running.",
"Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
"The job is running on the cluster.",
"A CancelJob request has been received, but is pending.",
"Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
"The job cancellation was successful.",
"The job has completed successfully.",
"The job has completed, but encountered an error.",
"Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
]
},
"substate": {
"description": "Output only. Additional state information, which includes status reported by the agent.",
"enum": [
"UNSPECIFIED",
"SUBMITTED",
"QUEUED",
"STALE_STATUS"
],
"enumDescriptions": [
"The job substate is unknown.",
"The Job is submitted to the agent.Applies to RUNNING state.",
"The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
"The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
],
"type": "string",
"readOnly": true
},
"stateStartTime": {
"description": "Output only. The time when this state was entered.",
"type": "string",
"format": "google-datetime",
"readOnly": true
}
},
"type": "object",
"description": "Dataproc job status."
},
"SparkRJob": {
"description": "A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN.",
"properties": {
"properties": {
"type": "object",
"description": "Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
"additionalProperties": {
"type": "string"
}
},
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"type": "array",
"items": {
"type": "string"
}
},
"fileUris": {
"items": {
"type": "string"
},
"description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.",
"type": "array"
},
"loggingConfig": {
"description": "Optional. The runtime log config for job execution.",
"$ref": "LoggingConfig"
},
"mainRFileUri": {
"type": "string",
"description": "Required. The HCFS URI of the main R file to use as the driver. Must be a .R file."
},
"archiveUris": {
"items": {
"type": "string"
},
"description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
"type": "array"
}
},
"type": "object",
"id": "SparkRJob"
},
"ListJobsResponse": {
"properties": {
"jobs": {
"description": "Output only. Jobs list.",
"readOnly": true,
"type": "array",
"items": {
"$ref": "Job"
}
},
"nextPageToken": {
"type": "string",
"description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListJobsRequest."
}
},
"type": "object",
"description": "A list of jobs in a project.",
"id": "ListJobsResponse"
},
"LoggingConfig": {
"type": "object",
"description": "The runtime logging config of the job.",
"properties": {
"driverLogLevels": {
"description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
"type": "object",
"additionalProperties": {
"type": "string",
"enum": [
"LEVEL_UNSPECIFIED",
"ALL",
"TRACE",
"DEBUG",
"INFO",
"WARN",
"ERROR",
"FATAL",
"OFF"
],
"enumDescriptions": [
"Level is unspecified. Use default level for log4j.",
"Use ALL level for log4j.",
"Use TRACE level for log4j.",
"Use DEBUG level for log4j.",
"Use INFO level for log4j.",
"Use WARN level for log4j.",
"Use ERROR level for log4j.",
"Use FATAL level for log4j.",
"Turn off log4j."
]
}
}
},
"id": "LoggingConfig"
},
"NodeGroupAffinity": {
"description": "Node Group Affinity for clusters using sole-tenant node groups.",
"id": "NodeGroupAffinity",
"type": "object",
"properties": {
"nodeGroupUri": {
"description": "Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) 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",
"type": "string"
}
}
},
"ListAutoscalingPoliciesResponse": {
"description": "A response to a request to list autoscaling policies in a project.",
"id": "ListAutoscalingPoliciesResponse",
"type": "object",
"properties": {
"nextPageToken": {
"readOnly": true,
"description": "Output only. This token is included in the response if there are more results to fetch.",
"type": "string"
},
"policies": {
"description": "Output only. Autoscaling policies list.",
"type": "array",
"items": {
"$ref": "AutoscalingPolicy"
},
"readOnly": true
}
}
},
"ListClustersResponse": {
"description": "The list of all clusters in a project.",
"properties": {
"clusters": {
"description": "Output only. The clusters in the project.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "Cluster"
}
},
"nextPageToken": {
"description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest.",
"type": "string",
"readOnly": true
}
},
"id": "ListClustersResponse",
"type": "object"
},
"WorkflowTemplatePlacement": {
"id": "WorkflowTemplatePlacement",
"description": "Specifies workflow execution target.Either managed_cluster or cluster_selector is required.",
"type": "object",
"properties": {
"managedCluster": {
"description": "Optional. A cluster that is managed by the workflow.",
"$ref": "ManagedCluster"
},
"clusterSelector": {
"$ref": "ClusterSelector",
"description": "Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted."
}
}
},
"SetIamPolicyRequest": {
"properties": {
"policy": {
"description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.",
"$ref": "Policy"
}
},
"description": "Request message for SetIamPolicy method.",
"type": "object",
"id": "SetIamPolicyRequest"
},
"MetastoreConfig": {
"type": "object",
"id": "MetastoreConfig",
"properties": {
"dataprocMetastoreService": {
"description": "Required. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name]",
"type": "string"
}
},
"description": "Specifies a Metastore configuration."
},
"ClusterConfig": {
"description": "The cluster config.",
"id": "ClusterConfig",
"type": "object",
"properties": {
"encryptionConfig": {
"description": "Optional. Encryption settings for the cluster.",
"$ref": "EncryptionConfig"
},
"softwareConfig": {
"description": "Optional. The config settings for software inside the cluster.",
"$ref": "SoftwareConfig"
},
"securityConfig": {
"description": "Optional. Security related configuration.",
"$ref": "SecurityConfig"
},
"gceClusterConfig": {
"description": "Optional. The shared Compute Engine config settings for all instances in a cluster.",
"$ref": "GceClusterConfig"
},
"autoscalingConfig": {
"description": "Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.",
"$ref": "AutoscalingConfig"
},
"gkeClusterConfig": {
"$ref": "GkeClusterConfig",
"description": "Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config."
},
"workerConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Compute Engine config settings for worker instances in a cluster."
},
"metastoreConfig": {
"description": "Optional. Metastore configuration.",
"$ref": "MetastoreConfig"
},
"secondaryWorkerConfig": {
"description": "Optional. The Compute Engine config settings for additional worker instances in a cluster.",
"$ref": "InstanceGroupConfig"
},
"tempBucket": {
"type": "string",
"description": "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."
},
"configBucket": {
"type": "string",
"description": "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 (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket))."
},
"initializationActions": {
"type": "array",
"description": "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/v1beta2/instance/attributes/dataproc-role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi ",
"items": {
"$ref": "NodeInitializationAction"
}
},
"masterConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Compute Engine config settings for the master instance in a cluster."
},
"lifecycleConfig": {
"$ref": "LifecycleConfig",
"description": "Optional. The config setting for auto delete cluster schedule."
},
"endpointConfig": {
"description": "Optional. Port/endpoint configuration for this cluster",
"$ref": "EndpointConfig"
}
}
},
"WorkflowNode": {
"description": "The workflow node.",
"id": "WorkflowNode",
"properties": {
"prerequisiteStepIds": {
"readOnly": true,
"items": {
"type": "string"
},
"type": "array",
"description": "Output only. Node's prerequisite nodes."
},
"jobId": {
"type": "string",
"description": "Output only. The job id; populated after the node enters RUNNING state.",
"readOnly": true
},
"state": {
"enum": [
"NODE_STATUS_UNSPECIFIED",
"BLOCKED",
"RUNNABLE",
"RUNNING",
"COMPLETED",
"FAILED"
],
"readOnly": true,
"description": "Output only. The node state.",
"type": "string",
"enumDescriptions": [
"State is unspecified.",
"The node is awaiting prerequisite node to finish.",
"The node is runnable but not running.",
"The node is running.",
"The node completed successfully.",
"The node failed. A node can be marked FAILED because its ancestor or peer failed."
]
},
"error": {
"type": "string",
"description": "Output only. The error detail.",
"readOnly": true
},
"stepId": {
"type": "string",
"description": "Output only. The name of the node.",
"readOnly": true
}
},
"type": "object"
},
"Cluster": {
"id": "Cluster",
"properties": {
"status": {
"readOnly": true,
"description": "Output only. Cluster status.",
"$ref": "ClusterStatus"
},
"projectId": {
"type": "string",
"description": "Required. The Google Cloud Platform project ID that the cluster belongs to."
},
"clusterName": {
"description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "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.",
"type": "object"
},
"metrics": {
"readOnly": true,
"$ref": "ClusterMetrics",
"description": "Output only. 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."
},
"clusterUuid": {
"type": "string",
"readOnly": true,
"description": "Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster."
},
"statusHistory": {
"type": "array",
"description": "Output only. The previous cluster status.",
"items": {
"$ref": "ClusterStatus"
},
"readOnly": true
},
"config": {
"description": "Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.",
"$ref": "ClusterConfig"
}
},
"type": "object",
"description": "Describes the identifying information, config, and status of a cluster of Compute Engine instances."
},
"PySparkJob": {
"properties": {
"archiveUris": {
"description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
"type": "array",
"items": {
"type": "string"
}
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission."
},
"jarFileUris": {
"items": {
"type": "string"
},
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
"type": "array"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
"type": "object"
},
"pythonFileUris": {
"description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
"items": {
"type": "string"
},
"type": "array"
},
"mainPythonFileUri": {
"description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.",
"type": "string"
},
"loggingConfig": {
"description": "Optional. The runtime log config for job execution.",
"$ref": "LoggingConfig"
},
"fileUris": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks."
}
},
"type": "object",
"id": "PySparkJob",
"description": "A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN."
},
"Expr": {
"type": "object",
"id": "Expr",
"properties": {
"description": {
"type": "string",
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI."
},
"expression": {
"type": "string",
"description": "Textual representation of an expression in Common Expression Language syntax."
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
"type": "string"
}
},
"description": "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() \u003c 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."
},
"DiagnoseClusterResults": {
"id": "DiagnoseClusterResults",
"type": "object",
"properties": {
"outputUri": {
"readOnly": true,
"description": "Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.",
"type": "string"
}
},
"description": "The location of diagnostic output."
},
"GkeClusterConfig": {
"id": "GkeClusterConfig",
"type": "object",
"properties": {
"namespacedGkeDeploymentTarget": {
"description": "Optional. A target for the deployment.",
"$ref": "NamespacedGkeDeploymentTarget"
}
},
"description": "The GKE config for this cluster."
},
"ClusterMetrics": {
"id": "ClusterMetrics",
"type": "object",
"properties": {
"yarnMetrics": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "int64"
},
"description": "The YARN metrics."
},
"hdfsMetrics": {
"additionalProperties": {
"format": "int64",
"type": "string"
},
"type": "object",
"description": "The HDFS metrics."
}
},
"description": "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."
},
"ReservationAffinity": {
"properties": {
"consumeReservationType": {
"enum": [
"TYPE_UNSPECIFIED",
"NO_RESERVATION",
"ANY_RESERVATION",
"SPECIFIC_RESERVATION"
],
"type": "string",
"description": "Optional. Type of reservation to consume",
"enumDescriptions": [
"",
"Do not consume from any allocated capacity.",
"Consume any reservation available.",
"Must consume from a specific reservation. Must specify key value fields for specifying the reservations."
]
},
"values": {
"type": "array",
"description": "Optional. Corresponds to the label values of reservation resource.",
"items": {
"type": "string"
}
},
"key": {
"description": "Optional. Corresponds to the label key of reservation resource.",
"type": "string"
}
},
"description": "Reservation Affinity for consuming Zonal reservation.",
"id": "ReservationAffinity",
"type": "object"
},
"InstanceReference": {
"description": "A reference to a Compute Engine instance.",
"type": "object",
"id": "InstanceReference",
"properties": {
"instanceId": {
"description": "The unique identifier of the Compute Engine instance.",
"type": "string"
},
"instanceName": {
"type": "string",
"description": "The user-friendly name of the Compute Engine instance."
}
}
},
"InstanceGroupConfig": {
"type": "object",
"description": "The config settings for Compute Engine resources in an instance group, such as a master or worker group.",
"properties": {
"instanceNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.",
"readOnly": true
},
"imageUri": {
"type": "string",
"description": "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-idImage 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."
},
"isPreemptible": {
"type": "boolean",
"readOnly": true,
"description": "Output only. Specifies that this instance group contains preemptible instances."
},
"instanceReferences": {
"description": "Output only. List of references to Compute Engine instances.",
"items": {
"$ref": "InstanceReference"
},
"type": "array",
"readOnly": true
},
"numInstances": {
"description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
"type": "integer",
"format": "int32"
},
"machineTypeUri": {
"type": "string",
"description": "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-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2."
},
"diskConfig": {
"$ref": "DiskConfig",
"description": "Optional. Disk option config settings."
},
"managedGroupConfig": {
"$ref": "ManagedGroupConfig",
"readOnly": true,
"description": "Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
},
"preemptibility": {
"enum": [
"PREEMPTIBILITY_UNSPECIFIED",
"NON_PREEMPTIBLE",
"PREEMPTIBLE"
],
"type": "string",
"enumDescriptions": [
"Preemptibility is unspecified, the system will choose the appropriate setting for each instance group.",
"Instances are non-preemptible.This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.",
"Instances are preemptible.This option is allowed only for secondary worker groups."
],
"description": "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."
},
"minCpuPlatform": {
"type": "string",
"description": "Specifies the minimum cpu platform for the Instance Group. See Dataproc -\u003e Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu)."
},
"accelerators": {
"description": "Optional. The Compute Engine accelerator configuration for these instances.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
}
},
"id": "InstanceGroupConfig"
},
"ClusterOperationMetadata": {
"type": "object",
"description": "Metadata describing the operation.",
"id": "ClusterOperationMetadata",
"properties": {
"clusterName": {
"description": "Output only. Name of the cluster for the operation.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "Output only. Labels associated with the operation"
},
"clusterUuid": {
"description": "Output only. Cluster UUID for the operation.",
"type": "string"
},
"warnings": {
"description": "Output only. Errors encountered during operation execution.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Output only. Current operation status.",
"$ref": "ClusterOperationStatus"
},
"description": {
"description": "Output only. Short description of operation.",
"type": "string"
},
"operationType": {
"type": "string",
"description": "Output only. The operation type."
},
"statusHistory": {
"items": {
"$ref": "ClusterOperationStatus"
},
"type": "array",
"description": "Output only. The previous operation status."
}
}
},
"PigJob": {
"type": "object",
"properties": {
"queryFileUri": {
"description": "The HCFS URI of the script that contains the Pig queries.",
"type": "string"
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
"items": {
"type": "string"
},
"type": "array"
},
"continueOnFailure": {
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
},
"loggingConfig": {
"description": "Optional. The runtime log config for job execution.",
"$ref": "LoggingConfig"
},
"scriptVariables": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value])."
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
"type": "object"
},
"queryList": {
"$ref": "QueryList",
"description": "A list of queries."
}
},
"description": "A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
"id": "PigJob"
},
"ValueValidation": {
"properties": {
"values": {
"description": "Required. List of allowed values for the parameter.",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object",
"description": "Validation based on a list of allowed values.",
"id": "ValueValidation"
},
"TestIamPermissionsResponse": {
"type": "object",
"description": "Response message for TestIamPermissions method.",
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"items": {
"type": "string"
},
"description": "A subset of TestPermissionsRequest.permissions that the caller is allowed.",
"type": "array"
}
}
},
"LifecycleConfig": {
"type": "object",
"description": "Specifies the cluster auto-delete schedule configuration.",
"properties": {
"idleStartTime": {
"type": "string",
"readOnly": true,
"format": "google-datetime",
"description": "Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json))."
},
"autoDeleteTime": {
"type": "string",
"description": "Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).",
"format": "google-datetime"
},
"idleDeleteTtl": {
"format": "google-duration",
"type": "string",
"description": "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 (https://developers.google.com/protocol-buffers/docs/proto3#json)."
},
"autoDeleteTtl": {
"type": "string",
"description": "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 (https://developers.google.com/protocol-buffers/docs/proto3#json)).",
"format": "google-duration"
}
},
"id": "LifecycleConfig"
},
"SecurityConfig": {
"type": "object",
"properties": {
"kerberosConfig": {
"description": "Kerberos related configuration.",
"$ref": "KerberosConfig"
}
},
"description": "Security related configuration, including encryption, Kerberos, etc.",
"id": "SecurityConfig"
},
"AutoscalingPolicy": {
"id": "AutoscalingPolicy",
"type": "object",
"properties": {
"secondaryWorkerConfig": {
"$ref": "InstanceGroupAutoscalingPolicyConfig",
"description": "Optional. Describes how the autoscaler will operate for secondary workers."
},
"id": {
"description": "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.",
"type": "string"
},
"name": {
"readOnly": true,
"type": "string",
"description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}"
},
"workerConfig": {
"$ref": "InstanceGroupAutoscalingPolicyConfig",
"description": "Required. Describes how the autoscaler will operate for primary workers."
},
"basicAlgorithm": {
"$ref": "BasicAutoscalingAlgorithm"
}
},
"description": "Describes an autoscaling policy for Dataproc cluster autoscaler."
},
"EncryptionConfig": {
"description": "Encryption settings for the cluster.",
"id": "EncryptionConfig",
"type": "object",
"properties": {
"gcePdKmsKeyName": {
"type": "string",
"description": "Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster."
}
}
},
"Job": {
"properties": {
"placement": {
"$ref": "JobPlacement",
"description": "Required. Job information, including how, when, and where to run the job."
},
"sparkRJob": {
"description": "Optional. Job is a SparkR job.",
"$ref": "SparkRJob"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "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 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 job."
},
"reference": {
"description": "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.",
"$ref": "JobReference"
},
"jobUuid": {
"readOnly": true,
"type": "string",
"description": "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 may be reused over time."
},
"scheduling": {
"description": "Optional. Job scheduling configuration.",
"$ref": "JobScheduling"
},
"hadoopJob": {
"$ref": "HadoopJob",
"description": "Optional. Job is a Hadoop job."
},
"submittedBy": {
"type": "string",
"description": "Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.",
"readOnly": true
},
"driverOutputResourceUri": {
"description": "Output only. A URI pointing to the location of the stdout of the job's driver program.",
"readOnly": true,
"type": "string"
},
"prestoJob": {
"$ref": "PrestoJob",
"description": "Optional. Job is a Presto job."
},
"sparkSqlJob": {
"description": "Optional. Job is a SparkSql job.",
"$ref": "SparkSqlJob"
},
"status": {
"description": "Output only. The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.",
"readOnly": true,
"$ref": "JobStatus"
},
"pysparkJob": {
"$ref": "PySparkJob",
"description": "Optional. Job is a PySpark job."
},
"done": {
"readOnly": true,
"description": "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.",
"type": "boolean"
},
"pigJob": {
"description": "Optional. Job is a Pig job.",
"$ref": "PigJob"
},
"yarnApplications": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "YarnApplication"
},
"description": "Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release."
},
"driverControlFilesUri": {
"type": "string",
"description": "Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
"readOnly": true
},
"sparkJob": {
"description": "Optional. Job is a Spark job.",
"$ref": "SparkJob"
},
"hiveJob": {
"description": "Optional. Job is a Hive job.",
"$ref": "HiveJob"
},
"statusHistory": {
"type": "array",
"items": {
"$ref": "JobStatus"
},
"readOnly": true,
"description": "Output only. The previous job status."
}
},
"description": "A Dataproc job resource.",
"id": "Job",
"type": "object"
},
"StopClusterRequest": {
"description": "A request to stop a cluster.",
"properties": {
"requestId": {
"description": "Optional. A unique id used to identify the request. If the server receives two StopClusterRequest requests 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 contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"type": "string"
},
"clusterUuid": {
"description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.",
"type": "string"
}
},
"type": "object",
"id": "StopClusterRequest"
},
"ClusterStatus": {
"id": "ClusterStatus",
"properties": {
"state": {
"enum": [
"UNKNOWN",
"CREATING",
"RUNNING",
"ERROR",
"DELETING",
"UPDATING",
"STOPPING",
"STOPPED",
"STARTING"
],
"enumDescriptions": [
"The cluster state is unknown.",
"The cluster is being created and set up. It is not ready for use.",
"The cluster is currently running and healthy. It is ready for use.",
"The cluster encountered an error. It is not ready for use.",
"The cluster is being deleted. It cannot be used.",
"The cluster is being updated. It continues to accept and process jobs.",
"The cluster is being stopped. It cannot be used.",
"The cluster is currently stopped. It is not ready for use.",
"The cluster is being started. It is not ready for use."
],
"readOnly": true,
"description": "Output only. The cluster's state.",
"type": "string"
},
"stateStartTime": {
"description": "Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).",
"type": "string",
"format": "google-datetime",
"readOnly": true
},
"substate": {
"description": "Output only. Additional state information that includes status reported by the agent.",
"enum": [
"UNSPECIFIED",
"UNHEALTHY",
"STALE_STATUS"
],
"enumDescriptions": [
"The cluster substate is unknown.",
"The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.",
"The agent-reported status is out of date (may occur if Dataproc loses communication with Agent).Applies to RUNNING state."
],
"type": "string",
"readOnly": true
},
"detail": {
"description": "Output only. Optional details of cluster's state.",
"readOnly": true,
"type": "string"
}
},
"description": "The status of a cluster and its instances.",
"type": "object"
},
"ParameterValidation": {
"id": "ParameterValidation",
"description": "Configuration for parameter validation.",
"type": "object",
"properties": {
"regex": {
"description": "Validation based on regular expressions.",
"$ref": "RegexValidation"
},
"values": {
"$ref": "ValueValidation",
"description": "Validation based on a list of allowed values."
}
}
},
"GetIamPolicyRequest": {
"description": "Request message for GetIamPolicy method.",
"type": "object",
"properties": {
"options": {
"$ref": "GetPolicyOptions",
"description": "OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy."
}
},
"id": "GetIamPolicyRequest"
},
"SoftwareConfig": {
"properties": {
"optionalComponents": {
"description": "The set of optional components to activate on the cluster.",
"type": "array",
"items": {
"enum": [
"COMPONENT_UNSPECIFIED",
"ANACONDA",
"DOCKER",
"DRUID",
"FLINK",
"HBASE",
"HIVE_WEBHCAT",
"JUPYTER",
"KERBEROS",
"PRESTO",
"RANGER",
"SOLR",
"ZEPPELIN",
"ZOOKEEPER"
],
"type": "string",
"enumDescriptions": [
"Unspecified component. Specifying this will cause Cluster creation to fail.",
"The Anaconda python distribution. The Anaconda component is not supported in the Dataproc preview 2.0 image. The 2.0 preview image is pre-installed with Miniconda.",
"Docker",
"The Druid query engine.",
"Flink",
"HBase.",
"The Hive Web HCatalog (the REST service for accessing HCatalog).",
"The Jupyter Notebook.",
"The Kerberos security feature.",
"The Presto query engine.",
"The Ranger service.",
"The Solr service.",
"The Zeppelin notebook.",
"The Zookeeper service."
]
}
},
"imageVersion": {
"description": "Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions), such as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the \"preview\" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.",
"type": "string"
},
"properties": {
"description": "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.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"id": "SoftwareConfig",
"type": "object",
"description": "Specifies the selection and config of software inside the cluster."
},
"StartClusterRequest": {
"id": "StartClusterRequest",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "Optional. A unique id used to identify the request. If the server receives two StartClusterRequest requests 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 contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters."
},
"clusterUuid": {
"type": "string",
"description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist."
}
},
"description": "A request to start a cluster."
},
"Binding": {
"id": "Binding",
"properties": {
"role": {
"description": "Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.",
"type": "string"
},
"bindingId": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, [email protected] . serviceAccount:{emailid}: An email address that represents a service account. For example, [email protected]. group:{emailid}: An email address that represents a Google group. For example, [email protected]. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.",
"type": "array"
},
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies)."
}
},
"description": "Associates members with a role.",
"type": "object"
},
"JobReference": {
"type": "object",
"id": "JobReference",
"properties": {
"projectId": {
"type": "string",
"description": "Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID."
},
"jobId": {
"type": "string",
"description": "Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server."
}
},
"description": "Encapsulates the full scoping used to reference a job."
},
"ManagedCluster": {
"description": "Cluster that is managed by the workflow.",
"id": "ManagedCluster",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.",
"type": "object"
},
"clusterName": {
"type": "string",
"description": "Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters."
},
"config": {
"description": "Required. The cluster configuration.",
"$ref": "ClusterConfig"
}
},
"type": "object"
}
},
"resources": {
"projects": {
"resources": {
"regions": {
"resources": {
"operations": {
"methods": {
"setIamPolicy": {
"parameters": {
"resource": {
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path"
}
},
"parameterOrder": [
"resource"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/{+resource}:setIamPolicy",
"id": "dataproc.projects.regions.operations.setIamPolicy",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:setIamPolicy",
"response": {
"$ref": "Policy"
},
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"request": {
"$ref": "SetIamPolicyRequest"
},
"httpMethod": "POST"
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
"path": "v1beta2/{+name}",
"id": "dataproc.projects.regions.operations.delete",
"httpMethod": "DELETE",
"parameters": {
"name": {
"location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
}
},
"list": {
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations",
"parameters": {
"pageSize": {
"type": "integer",
"format": "int32",
"location": "query",
"description": "The standard list page size."
},
"name": {
"pattern": "^projects/[^/]+/regions/[^/]+/operations$",
"required": true,
"location": "path",
"type": "string",
"description": "The name of the operation's parent resource."
},
"filter": {
"location": "query",
"type": "string",
"description": "The standard list filter."
},
"pageToken": {
"location": "query",
"description": "The standard list page token.",
"type": "string"
}
},
"response": {
"$ref": "ListOperationsResponse"
},
"path": "v1beta2/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"id": "dataproc.projects.regions.operations.list",
"parameterOrder": [
"name"
],
"httpMethod": "GET"
},
"getIamPolicy": {
"path": "v1beta2/{+resource}:getIamPolicy",
"id": "dataproc.projects.regions.operations.getIamPolicy",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:getIamPolicy",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"type": "integer",
"location": "query",
"format": "int32"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"required": true
}
},
"parameterOrder": [
"resource"
],
"response": {
"$ref": "Policy"
}
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Operation"
},
"id": "dataproc.projects.regions.operations.get",
"httpMethod": "GET",
"parameters": {
"name": {
"location": "path",
"type": "string",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"required": true,
"description": "The name of the operation resource."
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
"path": "v1beta2/{+name}",
"parameterOrder": [
"name"
]
},
"cancel": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.regions.operations.cancel",
"path": "v1beta2/{+name}:cancel",
"httpMethod": "POST",
"response": {
"$ref": "Empty"
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"type": "string",
"required": true,
"description": "The name of the operation resource to be cancelled.",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"location": "path"
}
}
},
"testIamPermissions": {
"response": {
"$ref": "TestIamPermissionsResponse"
},
"path": "v1beta2/{+resource}:testIamPermissions",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:testIamPermissions",
"httpMethod": "POST",
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"parameterOrder": [
"resource"
],
"id": "dataproc.projects.regions.operations.testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"workflowTemplates": {
"methods": {
"getIamPolicy": {
"id": "dataproc.projects.regions.workflowTemplates.getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
"httpMethod": "GET",
"response": {
"$ref": "Policy"
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:getIamPolicy",
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"location": "query",
"type": "integer",
"format": "int32"
},
"resource": {
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"required": true
}
},
"parameterOrder": [
"resource"
],
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"instantiateInline": {
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates:instantiateInline",
"request": {
"$ref": "WorkflowTemplate"
},
"response": {
"$ref": "Operation"
},
"id": "dataproc.projects.regions.workflowTemplates.instantiateInline",
"path": "v1beta2/{+parent}/workflowTemplates:instantiateInline",
"parameterOrder": [
"parent"
],
"parameters": {
"requestId": {
"description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"pattern": "^projects/[^/]+/regions/[^/]+$",
"type": "string",
"required": true,
"location": "path"
},
"instanceId": {
"type": "string",
"description": "Deprecated. Please use request_id field instead.",
"location": "query"
}
},
"description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"parameters": {
"name": {
"required": true,
"type": "string",
"location": "path",
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
},
"version": {
"type": "integer",
"location": "query",
"description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
"format": "int32"
}
},
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"id": "dataproc.projects.regions.workflowTemplates.delete",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/{+name}",
"description": "Deletes a workflow template. It does not cancel in-progress workflows.",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}"
},
"testIamPermissions": {
"response": {
"$ref": "TestIamPermissionsResponse"
},
"path": "v1beta2/{+resource}:testIamPermissions",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions",
"parameterOrder": [
"resource"
],
"id": "dataproc.projects.regions.workflowTemplates.testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"parameters": {
"resource": {
"location": "path",
"type": "string",
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"required": true
}
},
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning."
},
"create": {
"httpMethod": "POST",
"path": "v1beta2/{+parent}/workflowTemplates",
"parameterOrder": [
"parent"
],
"request": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Creates new workflow template.",
"response": {
"$ref": "WorkflowTemplate"
},
"parameters": {
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"pattern": "^projects/[^/]+/regions/[^/]+$",
"type": "string",
"location": "path",
"required": true
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
"id": "dataproc.projects.regions.workflowTemplates.create"
},
"instantiate": {
"parameters": {
"name": {
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"location": "path",
"type": "string"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
"path": "v1beta2/{+name}:instantiate",
"description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.",
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"id": "dataproc.projects.regions.workflowTemplates.instantiate",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
],
"request": {
"$ref": "InstantiateWorkflowTemplateRequest"
}
},
"update": {
"parameters": {
"name": {
"location": "path",
"type": "string",
"description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
}
},
"request": {
"$ref": "WorkflowTemplate"
},
"response": {
"$ref": "WorkflowTemplate"
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.regions.workflowTemplates.update",
"path": "v1beta2/{+name}",
"httpMethod": "PUT",
"description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version."
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.regions.workflowTemplates.get",
"path": "v1beta2/{+name}",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"httpMethod": "GET",
"description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
"parameterOrder": [
"name"
],
"parameters": {
"version": {
"description": "Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.",
"format": "int32",
"location": "query",
"type": "integer"
},
"name": {
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"location": "path",
"type": "string",
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"required": true
}
},
"response": {
"$ref": "WorkflowTemplate"
}
},
"setIamPolicy": {
"response": {
"$ref": "Policy"
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"location": "path"
}
},
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"parameterOrder": [
"resource"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"path": "v1beta2/{+resource}:setIamPolicy",
"id": "dataproc.projects.regions.workflowTemplates.setIamPolicy"
},
"list": {
"parameters": {
"parent": {
"type": "string",
"pattern": "^projects/[^/]+/regions/[^/]+$",
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"required": true
},
"pageToken": {
"location": "query",
"type": "string",
"description": "Optional. The page token, returned by a previous call, to request the next page of results."
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Optional. The maximum number of results to return in each response.",
"type": "integer"
}
},
"id": "dataproc.projects.regions.workflowTemplates.list",
"path": "v1beta2/{+parent}/workflowTemplates",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"description": "Lists workflows that match the specified filter in the request.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
}
}
}
},
"clusters": {
"methods": {
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
"response": {
"$ref": "Policy"
},
"parameters": {
"resource": {
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"type": "string",
"location": "path"
}
},
"httpMethod": "POST",
"id": "dataproc.projects.regions.clusters.setIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "SetIamPolicyRequest"
},
"parameterOrder": [
"resource"
],
"path": "v1beta2/{+resource}:setIamPolicy"
},
"list": {
"description": "Lists all regions/{region}/clusters in a project alphabetically.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"httpMethod": "GET",
"response": {
"$ref": "ListClustersResponse"
},
"parameterOrder": [
"projectId",
"region"
],
"id": "dataproc.projects.regions.clusters.list",
"parameters": {
"region": {
"type": "string",
"location": "path",
"description": "Required. The Dataproc region in which to handle the request.",
"required": true
},
"projectId": {
"type": "string",
"required": true,
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to."
},
"pageToken": {
"description": "Optional. The standard List page token.",
"location": "query",
"type": "string"
},
"filter": {
"type": "string",
"description": "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, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
"location": "query"
},
"pageSize": {
"description": "Optional. The standard List page size.",
"type": "integer",
"format": "int32",
"location": "query"
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters"
},
"getIamPolicy": {
"id": "dataproc.projects.regions.clusters.getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Policy"
},
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy",
"httpMethod": "GET",
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"location": "path",
"type": "string",
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
"required": true,
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field."
}
},
"parameterOrder": [
"resource"
]
},
"stop": {
"response": {
"$ref": "Operation"
},
"description": "Stops a cluster in a project.",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"parameters": {
"region": {
"required": true,
"description": "Required. The Dataproc region in which to handle the request.",
"type": "string",
"location": "path"
},
"clusterName": {
"description": "Required. The cluster name.",
"required": true,
"location": "path",
"type": "string"
},
"projectId": {
"type": "string",
"required": true,
"description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
"location": "path"
}
},
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop",
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop",
"request": {
"$ref": "StopClusterRequest"
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.regions.clusters.stop"
},
"diagnose": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
"description": "Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata). After the operation completes, Operation.response contains Empty.",
"request": {
"$ref": "DiagnoseClusterRequest"
},
"httpMethod": "POST",
"id": "dataproc.projects.regions.clusters.diagnose",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"region": {
"type": "string",
"required": true,
"location": "path",
"description": "Required. The Dataproc region in which to handle the request."
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"clusterName": {
"required": true,
"description": "Required. The cluster name.",
"location": "path",
"type": "string"
}
}
},
"get": {
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.regions.clusters.get",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"description": "Gets the resource representation for a cluster in a project.",
"parameters": {
"projectId": {
"location": "path",
"required": true,
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string"
},
"region": {
"required": true,
"type": "string",
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path"
},
"clusterName": {
"description": "Required. The cluster name.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"response": {
"$ref": "Cluster"
},
"httpMethod": "GET"
},
"create": {
"response": {
"$ref": "Operation"
},
"description": "Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).",
"httpMethod": "POST",
"id": "dataproc.projects.regions.clusters.create",
"parameterOrder": [
"projectId",
"region"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "Cluster"
},
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"parameters": {
"requestId": {
"location": "query",
"description": "Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests 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 contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"type": "string"
},
"projectId": {
"location": "path",
"required": true,
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string"
},
"region": {
"type": "string",
"required": true,
"location": "path",
"description": "Required. The Dataproc region in which to handle the request."
}
}
},
"testIamPermissions": {
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions",
"id": "dataproc.projects.regions.clusters.testIamPermissions",
"parameterOrder": [
"resource"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$"
}
},
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"path": "v1beta2/{+resource}:testIamPermissions",
"httpMethod": "POST"
},
"patch": {
"id": "dataproc.projects.regions.clusters.patch",
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"request": {
"$ref": "Cluster"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"parameters": {
"clusterName": {
"type": "string",
"required": true,
"location": "path",
"description": "Required. The cluster name."
},
"updateMask": {
"description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { \"config\":{ \"workerConfig\":{ \"numInstances\":\"5\" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { \"config\":{ \"secondaryWorkerConfig\":{ \"numInstances\":\"5\" } } } *Note:* currently only the following fields can be updated: *Mask* *Purpose* labels Updates labels config.worker_config.num_instances Resize primary worker group config.secondary_worker_config.num_instances Resize secondary worker group config.lifecycle_config.auto_delete_ttl Reset MAX TTL duration config.lifecycle_config.auto_delete_time Update MAX TTL deletion timestamp config.lifecycle_config.idle_delete_ttl Update Idle TTL duration config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies ",
"type": "string",
"location": "query",
"format": "google-fieldmask"
},
"projectId": {
"required": true,
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
"type": "string"
},
"region": {
"type": "string",
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true
},
"gracefulDecommissionTimeout": {
"type": "string",
"location": "query",
"format": "google-duration",
"description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher."
},
"requestId": {
"location": "query",
"type": "string",
"description": "Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests 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 contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters."
}
},
"httpMethod": "PATCH",
"description": "Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata)."
},
"start": {
"response": {
"$ref": "Operation"
},
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:start",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Starts a cluster in a project.",
"id": "dataproc.projects.regions.clusters.start",
"request": {
"$ref": "StartClusterRequest"
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:start",
"parameters": {
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"clusterName": {
"type": "string",
"location": "path",
"required": true,
"description": "Required. The cluster name."
},
"region": {
"required": true,
"type": "string",
"location": "path",
"description": "Required. The Dataproc region in which to handle the request."
}
}
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"required": true,
"type": "string",
"location": "path"
},
"clusterUuid": {
"description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.",
"type": "string",
"location": "query"
},
"clusterName": {
"type": "string",
"description": "Required. The cluster name.",
"location": "path",
"required": true
},
"region": {
"required": true,
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"type": "string"
},
"requestId": {
"description": "Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests 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 contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"type": "string",
"location": "query"
}
},
"response": {
"$ref": "Operation"
},
"id": "dataproc.projects.regions.clusters.delete",
"httpMethod": "DELETE",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"description": "Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata)."
}
}
},
"jobs": {
"methods": {
"cancel": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
"parameters": {
"region": {
"type": "string",
"location": "path",
"description": "Required. The Dataproc region in which to handle the request.",
"required": true
},
"jobId": {
"type": "string",
"location": "path",
"description": "Required. The job ID.",
"required": true
},
"projectId": {
"type": "string",
"location": "path",
"required": true,
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to."
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
"httpMethod": "POST",
"response": {
"$ref": "Job"
},
"description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/get).",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"request": {
"$ref": "CancelJobRequest"
},
"id": "dataproc.projects.regions.jobs.cancel"
},
"testIamPermissions": {
"id": "dataproc.projects.regions.jobs.testIamPermissions",
"path": "v1beta2/{+resource}:testIamPermissions",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/jobs/[^/]+$"
}
},
"request": {
"$ref": "TestIamPermissionsRequest"
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"response": {
"$ref": "TestIamPermissionsResponse"
}
},
"delete": {
"parameters": {
"projectId": {
"required": true,
"location": "path",
"type": "string",
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to."
},
"region": {
"location": "path",
"description": "Required. The Dataproc region in which to handle the request.",
"type": "string",
"required": true
},
"jobId": {
"location": "path",
"required": true,
"description": "Required. The job ID.",
"type": "string"
}
},
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"response": {
"$ref": "Empty"
},
"description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.regions.jobs.delete",
"httpMethod": "DELETE"
},
"patch": {
"parameters": {
"region": {
"location": "path",
"required": true,
"description": "Required. The Dataproc region in which to handle the request.",
"type": "string"
},
"projectId": {
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
"required": true
},
"updateMask": {
"description": "Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. *Note:* Currently, labels is the only field that can be updated.",
"location": "query",
"type": "string",
"format": "google-fieldmask"
},
"jobId": {
"required": true,
"location": "path",
"description": "Required. The job ID.",
"type": "string"
}
},
"description": "Updates a job in a project.",
"request": {
"$ref": "Job"
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"id": "dataproc.projects.regions.jobs.patch",
"httpMethod": "PATCH",
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
},
"submit": {
"id": "dataproc.projects.regions.jobs.submit",
"response": {
"$ref": "Job"
},
"request": {
"$ref": "SubmitJobRequest"
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"region"
],
"description": "Submits a job to a cluster.",
"parameters": {
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
"type": "string",
"location": "path"
},
"region": {
"type": "string",
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit"
},
"list": {
"id": "dataproc.projects.regions.jobs.list",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"region": {
"type": "string",
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true
},
"jobStateMatcher": {
"enum": [
"ALL",
"ACTIVE",
"NON_ACTIVE"
],
"type": "string",
"description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.",
"location": "query",
"enumDescriptions": [
"Match all jobs, regardless of state.",
"Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING.",
"Only match jobs in terminal states: CANCELLED, DONE, or ERROR."
]
},
"pageToken": {
"location": "query",
"type": "string",
"description": "Optional. The page token, returned by a previous call, to request the next page of results."
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
"location": "path",
"type": "string"
},
"pageSize": {
"type": "integer",
"location": "query",
"format": "int32",
"description": "Optional. The number of results to return in each response."
},
"filter": {
"location": "query",
"description": "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 labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
"type": "string"
},
"clusterName": {
"description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
"location": "query",
"type": "string"
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
"httpMethod": "GET",
"description": "Lists regions/{region}/jobs in a project.",
"parameterOrder": [
"projectId",
"region"
],
"response": {
"$ref": "ListJobsResponse"
}
},
"getIamPolicy": {
"response": {
"$ref": "Policy"
},
"httpMethod": "GET",
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"parameters": {
"options.requestedPolicyVersion": {
"type": "integer",
"format": "int32",
"description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"location": "query"
},
"resource": {
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/jobs/[^/]+$",
"type": "string"
}
},
"id": "dataproc.projects.regions.jobs.getIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
"parameterOrder": [
"resource"
]
},
"setIamPolicy": {
"id": "dataproc.projects.regions.jobs.setIamPolicy",
"response": {
"$ref": "Policy"
},
"httpMethod": "POST",
"request": {
"$ref": "SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"parameterOrder": [
"resource"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"type": "string",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"pattern": "^projects/[^/]+/regions/[^/]+/jobs/[^/]+$",
"required": true
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:setIamPolicy",
"path": "v1beta2/{+resource}:setIamPolicy"
},
"submitAsOperation": {
"description": "Submits job to a cluster.",
"response": {
"$ref": "Operation"
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submitAsOperation",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"region": {
"type": "string",
"location": "path",
"required": true,
"description": "Required. The Dataproc region in which to handle the request."
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
"location": "path",
"type": "string"
}
},
"id": "dataproc.projects.regions.jobs.submitAsOperation",
"request": {
"$ref": "SubmitJobRequest"
},
"parameterOrder": [
"projectId",
"region"
],
"httpMethod": "POST",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submitAsOperation"
},
"get": {
"httpMethod": "GET",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"description": "Gets the resource representation for a job in a project.",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"parameters": {
"jobId": {
"type": "string",
"required": true,
"description": "Required. The job ID.",
"location": "path"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
"location": "path",
"type": "string"
},
"region": {
"required": true,
"location": "path",
"type": "string",
"description": "Required. The Dataproc region in which to handle the request."
}
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"id": "dataproc.projects.regions.jobs.get"
}
}
},
"autoscalingPolicies": {
"methods": {
"create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "AutoscalingPolicy"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"id": "dataproc.projects.regions.autoscalingPolicies.create",
"description": "Creates new autoscaling policy.",
"parameters": {
"parent": {
"location": "path",
"type": "string",
"description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name has the following format: projects/{project_id}/locations/{location}",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+$"
}
},
"request": {
"$ref": "AutoscalingPolicy"
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies",
"path": "v1beta2/{+parent}/autoscalingPolicies"
},
"list": {
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies",
"path": "v1beta2/{+parent}/autoscalingPolicies",
"description": "Lists autoscaling policies in the project.",
"response": {
"$ref": "ListAutoscalingPoliciesResponse"
},
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"description": "Optional. The page token, returned by a previous call, to request the next page of results."
},
"parent": {
"location": "path",
"description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+$",
"type": "string"
},
"pageSize": {
"type": "integer",
"location": "query",
"description": "Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.",
"format": "int32"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.regions.autoscalingPolicies.list"
},
"testIamPermissions": {
"httpMethod": "POST",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"request": {
"$ref": "TestIamPermissionsRequest"
},
"id": "dataproc.projects.regions.autoscalingPolicies.testIamPermissions",
"parameterOrder": [
"resource"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"type": "string",
"location": "path",
"required": true
}
},
"path": "v1beta2/{+resource}:testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"parameterOrder": [
"resource"
],
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy",
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"location": "query",
"format": "int32",
"type": "integer"
},
"resource": {
"type": "string",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"location": "path",
"required": true,
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field."
}
},
"path": "v1beta2/{+resource}:getIamPolicy",
"httpMethod": "GET",
"response": {
"$ref": "Policy"
},
"id": "dataproc.projects.regions.autoscalingPolicies.getIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"httpMethod": "PUT",
"parameters": {
"name": {
"description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"location": "path",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "AutoscalingPolicy"
},
"path": "v1beta2/{+name}",
"parameterOrder": [
"name"
],
"id": "dataproc.projects.regions.autoscalingPolicies.update",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "AutoscalingPolicy"
}
},
"get": {
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"parameters": {
"name": {
"required": true,
"description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"location": "path",
"type": "string"
}
},
"path": "v1beta2/{+name}",
"parameterOrder": [
"name"
],
"response": {
"$ref": "AutoscalingPolicy"
},
"description": "Retrieves autoscaling policy.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET",
"id": "dataproc.projects.regions.autoscalingPolicies.get"
},
"delete": {
"parameters": {
"name": {
"required": true,
"description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"location": "path",
"type": "string",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$"
}
},
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"id": "dataproc.projects.regions.autoscalingPolicies.delete",
"description": "Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "DELETE",
"path": "v1beta2/{+name}",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}"
},
"setIamPolicy": {
"id": "dataproc.projects.regions.autoscalingPolicies.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field."
}
},
"path": "v1beta2/{+resource}:setIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"httpMethod": "POST",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
}
}
}
}
}
},
"locations": {
"resources": {
"workflowTemplates": {
"methods": {
"get": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
],
"path": "v1beta2/{+name}",
"id": "dataproc.projects.locations.workflowTemplates.get",
"description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
"parameters": {
"name": {
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"location": "path",
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"required": true
},
"version": {
"location": "query",
"description": "Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.",
"format": "int32",
"type": "integer"
}
},
"response": {
"$ref": "WorkflowTemplate"
}
},
"update": {
"path": "v1beta2/{+name}",
"response": {
"$ref": "WorkflowTemplate"
},
"id": "dataproc.projects.locations.workflowTemplates.update",
"parameterOrder": [
"name"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
"request": {
"$ref": "WorkflowTemplate"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"location": "path",
"type": "string",
"description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}"
}
},
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version."
},
"instantiateInline": {
"description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.",
"path": "v1beta2/{+parent}/workflowTemplates:instantiateInline",
"id": "dataproc.projects.locations.workflowTemplates.instantiateInline",
"parameters": {
"requestId": {
"description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"type": "string",
"location": "query"
},
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string",
"location": "path"
},
"instanceId": {
"description": "Deprecated. Please use request_id field instead.",
"type": "string",
"location": "query"
}
},
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates:instantiateInline",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "WorkflowTemplate"
}
},
"setIamPolicy": {
"id": "dataproc.projects.locations.workflowTemplates.setIamPolicy",
"httpMethod": "POST",
"response": {
"$ref": "Policy"
},
"path": "v1beta2/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string",
"location": "path"
}
}
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"path": "v1beta2/{+parent}/workflowTemplates",
"response": {
"$ref": "WorkflowTemplate"
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
"request": {
"$ref": "WorkflowTemplate"
},
"id": "dataproc.projects.locations.workflowTemplates.create",
"description": "Creates new workflow template.",
"parameters": {
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string",
"location": "path"
}
}
},
"list": {
"httpMethod": "GET",
"parameters": {
"pageSize": {
"type": "integer",
"description": "Optional. The maximum number of results to return in each response.",
"location": "query",
"format": "int32"
},
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"required": true,
"type": "string"
},
"pageToken": {
"type": "string",
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"location": "query"
}
},
"path": "v1beta2/{+parent}/workflowTemplates",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
"id": "dataproc.projects.locations.workflowTemplates.list",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Lists workflows that match the specified filter in the request.",
"parameterOrder": [
"parent"
]
},
"instantiate": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.",
"httpMethod": "POST",
"parameters": {
"name": {
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"type": "string"
}
},
"id": "dataproc.projects.locations.workflowTemplates.instantiate",
"parameterOrder": [
"name"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
"request": {
"$ref": "InstantiateWorkflowTemplateRequest"
},
"path": "v1beta2/{+name}:instantiate",
"response": {
"$ref": "Operation"
}
},
"testIamPermissions": {
"request": {
"$ref": "TestIamPermissionsRequest"
},
"path": "v1beta2/{+resource}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.locations.workflowTemplates.testIamPermissions",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"parameterOrder": [
"resource"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"type": "string",
"required": true,
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field."
}
}
},
"delete": {
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/{+name}",
"description": "Deletes a workflow template. It does not cancel in-progress workflows.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
"parameterOrder": [
"name"
],
"id": "dataproc.projects.locations.workflowTemplates.delete",
"parameters": {
"version": {
"format": "int32",
"type": "integer",
"description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
"location": "query"
},
"name": {
"required": true,
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"type": "string"
}
},
"httpMethod": "DELETE"
},
"getIamPolicy": {
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:getIamPolicy",
"id": "dataproc.projects.locations.workflowTemplates.getIamPolicy",
"response": {
"$ref": "Policy"
},
"path": "v1beta2/{+resource}:getIamPolicy",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"resource": {
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path"
}
}
}
}
},
"autoscalingPolicies": {
"methods": {
"getIamPolicy": {
"parameters": {
"resource": {
"location": "path",
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"required": true
},
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
"location": "query",
"type": "integer",
"format": "int32"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.locations.autoscalingPolicies.getIamPolicy",
"parameterOrder": [
"resource"
],
"path": "v1beta2/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy",
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"httpMethod": "GET"
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.locations.autoscalingPolicies.get",
"parameterOrder": [
"name"
],
"response": {
"$ref": "AutoscalingPolicy"
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"path": "v1beta2/{+name}",
"parameters": {
"name": {
"description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"location": "path"
}
},
"httpMethod": "GET",
"description": "Retrieves autoscaling policy."
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies",
"description": "Lists autoscaling policies in the project.",
"path": "v1beta2/{+parent}/autoscalingPolicies",
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"id": "dataproc.projects.locations.autoscalingPolicies.list",
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"description": "Optional. The page token, returned by a previous call, to request the next page of results."
},
"pageSize": {
"location": "query",
"type": "integer",
"format": "int32",
"description": "Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100."
},
"parent": {
"description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"required": true,
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string"
}
},
"response": {
"$ref": "ListAutoscalingPoliciesResponse"
}
},
"delete": {
"response": {
"$ref": "Empty"
},
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"location": "path"
}
},
"path": "v1beta2/{+name}",
"parameterOrder": [
"name"
],
"description": "Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.",
"id": "dataproc.projects.locations.autoscalingPolicies.delete",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}"
},
"setIamPolicy": {
"id": "dataproc.projects.locations.autoscalingPolicies.setIamPolicy",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "Policy"
},
"httpMethod": "POST",
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"location": "path",
"type": "string",
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"required": true
}
},
"request": {
"$ref": "SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy",
"path": "v1beta2/{+resource}:setIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"id": "dataproc.projects.locations.autoscalingPolicies.create",
"response": {
"$ref": "AutoscalingPolicy"
},
"parameterOrder": [
"parent"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies",
"request": {
"$ref": "AutoscalingPolicy"
},
"path": "v1beta2/{+parent}/autoscalingPolicies",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST",
"description": "Creates new autoscaling policy.",
"parameters": {
"parent": {
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name has the following format: projects/{project_id}/locations/{location}",
"type": "string",
"location": "path"
}
}
},
"update": {
"parameters": {
"name": {
"type": "string",
"description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"location": "path"
}
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"description": "Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.",
"httpMethod": "PUT",
"request": {
"$ref": "AutoscalingPolicy"
},
"response": {
"$ref": "AutoscalingPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "dataproc.projects.locations.autoscalingPolicies.update",
"path": "v1beta2/{+name}",
"parameterOrder": [
"name"
]
},
"testIamPermissions": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"id": "dataproc.projects.locations.autoscalingPolicies.testIamPermissions",
"parameters": {
"resource": {
"required": true,
"type": "string",
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$"
}
},
"path": "v1beta2/{+resource}:testIamPermissions",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
}
}
}
}
}
}
}
}
},
"discoveryVersion": "v1",
"servicePath": ""
}