File size: 98,233 Bytes

4cef980

{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://composer.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Composer",
"description": "Manages Apache Airflow environments on Google Cloud Platform.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/composer/",
"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"
},
"id": "composer:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://composer.mtls.googleapis.com/",
"name": "composer",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"environments": {
"methods": {
"checkUpgrade": {
"description": "Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:checkUpgrade",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.checkUpgrade",
"parameterOrder": [
"environment"
],
"parameters": {
"environment": {
"description": "Required. The resource name of the environment to check upgrade for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+environment}:checkUpgrade",
"request": {
"$ref": "CheckUpgradeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Create a new environment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent must be of the form \"projects/{projectId}/locations/{locationId}\".",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/environments",
"request": {
"$ref": "Environment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"databaseFailover": {
"description": "Triggers database failover (only for highly resilient environments).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:databaseFailover",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.databaseFailover",
"parameterOrder": [
"environment"
],
"parameters": {
"environment": {
"description": "Target environment: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+environment}:databaseFailover",
"request": {
"$ref": "DatabaseFailoverRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete an environment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
"httpMethod": "DELETE",
"id": "composer.projects.locations.environments.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The environment to delete, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"executeAirflowCommand": {
"description": "Executes Airflow CLI command.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.executeAirflowCommand",
"parameterOrder": [
"environment"
],
"parameters": {
"environment": {
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+environment}:executeAirflowCommand",
"request": {
"$ref": "ExecuteAirflowCommandRequest"
},
"response": {
"$ref": "ExecuteAirflowCommandResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"fetchDatabaseProperties": {
"description": "Fetches database properties.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:fetchDatabaseProperties",
"httpMethod": "GET",
"id": "composer.projects.locations.environments.fetchDatabaseProperties",
"parameterOrder": [
"environment"
],
"parameters": {
"environment": {
"description": "Required. The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+environment}:fetchDatabaseProperties",
"response": {
"$ref": "FetchDatabasePropertiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Get an existing environment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
"httpMethod": "GET",
"id": "composer.projects.locations.environments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the environment to get, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Environment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List environments.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments",
"httpMethod": "GET",
"id": "composer.projects.locations.environments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of environments to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "List environments in the given project and location, in the form: \"projects/{projectId}/locations/{locationId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/environments",
"response": {
"$ref": "ListEnvironmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"loadSnapshot": {
"description": "Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:loadSnapshot",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.loadSnapshot",
"parameterOrder": [
"environment"
],
"parameters": {
"environment": {
"description": "The resource name of the target environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+environment}:loadSnapshot",
"request": {
"$ref": "LoadSnapshotRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update an environment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
"httpMethod": "PATCH",
"id": "composer.projects.locations.environments.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The relative resource name of the environment to update, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values: \"config.softwareConfig.pypiPackages.scikit-learn\" and \"config.softwareConfig.pypiPackages.numpy\". The included patch environment would specify the scikit-learn version as follows: { \"config\":{ \"softwareConfig\":{ \"pypiPackages\":{ \"scikit-learn\":\"==0.19.0\" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels \"label1\" and \"label2\" while clearing \"label3\" (assuming it already exists), one can provide the paths \"labels.label1\", \"labels.label2\", and \"labels.label3\" and populate the patch environment as follows: { \"labels\":{ \"label1\":\"new-label1-value\" \"label2\":\"new-label2-value\" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path \"config.softwareConfig.pypiPackages\", and the patch environment would be the following: { \"config\":{ \"softwareConfig\":{ \"pypiPackages\":{ \"botocore\":\"==1.7.14\" } } } } **Note:** Only the following fields can be updated: * `config.softwareConfig.pypiPackages` * Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. * `config.softwareConfig.pypiPackages.`packagename * Update the custom PyPI package *packagename*, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the `config.softwareConfig.pypiPackages` mask. * `labels` * Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. * `labels.`labelName * Set the label named *labelName*, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the `labels` mask. * `config.nodeCount` * Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerNetworkAccessControl` * Replace the environment's current `WebServerNetworkAccessControl`. * `config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. * `config.softwareConfig.airflowConfigOverrides.`section-name * Override the Apache Airflow config property *name* in the section named *section*, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the `config.softwareConfig.airflowConfigOverrides` mask. * `config.softwareConfig.envVariables` * Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. * `config.softwareConfig.schedulerCount` * Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the `config.softwareConfig.schedulerCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerConfig.machineType` * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Environment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"pollAirflowCommand": {
"description": "Polls Airflow CLI command execution and fetches logs.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:pollAirflowCommand",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.pollAirflowCommand",
"parameterOrder": [
"environment"
],
"parameters": {
"environment": {
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+environment}:pollAirflowCommand",
"request": {
"$ref": "PollAirflowCommandRequest"
},
"response": {
"$ref": "PollAirflowCommandResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"saveSnapshot": {
"description": "Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:saveSnapshot",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.saveSnapshot",
"parameterOrder": [
"environment"
],
"parameters": {
"environment": {
"description": "The resource name of the source environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+environment}:saveSnapshot",
"request": {
"$ref": "SaveSnapshotRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"stopAirflowCommand": {
"description": "Stops Airflow CLI command execution.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:stopAirflowCommand",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.stopAirflowCommand",
"parameterOrder": [
"environment"
],
"parameters": {
"environment": {
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+environment}:stopAirflowCommand",
"request": {
"$ref": "StopAirflowCommandRequest"
},
"response": {
"$ref": "StopAirflowCommandResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"userWorkloadsConfigMaps": {
"methods": {
"create": {
"description": "Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.userWorkloadsConfigMaps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The environment name to create a ConfigMap for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userWorkloadsConfigMaps",
"request": {
"$ref": "UserWorkloadsConfigMap"
},
"response": {
"$ref": "UserWorkloadsConfigMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapsId}",
"httpMethod": "DELETE",
"id": "composer.projects.locations.environments.userWorkloadsConfigMaps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The ConfigMap to delete, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsConfigMaps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapsId}",
"httpMethod": "GET",
"id": "composer.projects.locations.environments.userWorkloadsConfigMaps.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the ConfigMap to get, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsConfigMaps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "UserWorkloadsConfigMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps",
"httpMethod": "GET",
"id": "composer.projects.locations.environments.userWorkloadsConfigMaps.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of ConfigMaps to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. List ConfigMaps in the given environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userWorkloadsConfigMaps",
"response": {
"$ref": "ListUserWorkloadsConfigMapsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapsId}",
"httpMethod": "PUT",
"id": "composer.projects.locations.environments.userWorkloadsConfigMaps.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the ConfigMap, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsConfigMaps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "UserWorkloadsConfigMap"
},
"response": {
"$ref": "UserWorkloadsConfigMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"userWorkloadsSecrets": {
"methods": {
"create": {
"description": "Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets",
"httpMethod": "POST",
"id": "composer.projects.locations.environments.userWorkloadsSecrets.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The environment name to create a Secret for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userWorkloadsSecrets",
"request": {
"$ref": "UserWorkloadsSecret"
},
"response": {
"$ref": "UserWorkloadsSecret"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets/{userWorkloadsSecretsId}",
"httpMethod": "DELETE",
"id": "composer.projects.locations.environments.userWorkloadsSecrets.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The Secret to delete, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsSecrets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an existing user workloads Secret. Values of the \"data\" field in the response are cleared. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets/{userWorkloadsSecretsId}",
"httpMethod": "GET",
"id": "composer.projects.locations.environments.userWorkloadsSecrets.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Secret to get, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsSecrets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "UserWorkloadsSecret"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets",
"httpMethod": "GET",
"id": "composer.projects.locations.environments.userWorkloadsSecrets.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of Secrets to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. List Secrets in the given environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userWorkloadsSecrets",
"response": {
"$ref": "ListUserWorkloadsSecretsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets/{userWorkloadsSecretsId}",
"httpMethod": "PUT",
"id": "composer.projects.locations.environments.userWorkloadsSecrets.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the Secret, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsSecrets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "UserWorkloadsSecret"
},
"response": {
"$ref": "UserWorkloadsSecret"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"workloads": {
"methods": {
"list": {
"description": "Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/workloads",
"httpMethod": "GET",
"id": "composer.projects.locations.environments.workloads.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using \"OR\" operator, e.g.: \"type=SCHEDULER OR type=CELERY_WORKER\". If not specified, all items are returned.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of environments to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The environment name to get workloads for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/workloads",
"response": {
"$ref": "ListWorkloadsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"imageVersions": {
"methods": {
"list": {
"description": "List ImageVersions for provided location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/imageVersions",
"httpMethod": "GET",
"id": "composer.projects.locations.imageVersions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"includePastReleases": {
"description": "Whether or not image versions from old releases should be included.",
"location": "query",
"type": "boolean"
},
"pageSize": {
"description": "The maximum number of image_versions to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "List ImageVersions in the given project and location, in the form: \"projects/{projectId}/locations/{locationId}\"",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/imageVersions",
"response": {
"$ref": "ListImageVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"delete": {
"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`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "composer.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "composer.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "composer.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20240703",
"rootUrl": "https://composer.googleapis.com/",
"schemas": {
"AirflowMetadataRetentionPolicyConfig": {
"description": "The policy for airflow metadata database retention.",
"id": "AirflowMetadataRetentionPolicyConfig",
"properties": {
"retentionDays": {
"description": "Optional. How many days data should be retained for.",
"format": "int32",
"type": "integer"
},
"retentionMode": {
"description": "Optional. Retention can be either enabled or disabled.",
"enum": [
"RETENTION_MODE_UNSPECIFIED",
"RETENTION_MODE_ENABLED",
"RETENTION_MODE_DISABLED"
],
"enumDescriptions": [
"Default mode doesn't change environment parameters.",
"Retention policy is enabled.",
"Retention policy is disabled."
],
"type": "string"
}
},
"type": "object"
},
"AllowedIpRange": {
"description": "Allowed IP range with user-provided description.",
"id": "AllowedIpRange",
"properties": {
"description": {
"description": "Optional. User-provided description. It must contain at most 300 characters.",
"type": "string"
},
"value": {
"description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. IP range prefixes should be properly truncated. For example, `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` should be truncated to `2001:db8::/32`.",
"type": "string"
}
},
"type": "object"
},
"CheckUpgradeRequest": {
"description": "Request to check whether image upgrade will succeed.",
"id": "CheckUpgradeRequest",
"properties": {
"imageVersion": {
"description": "Optional. The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\\.[0-9]+\\.[0-9]+(-preview\\.[0-9]+)?)?|latest)-airflow-([0-9]+(\\.[0-9]+(\\.[0-9]+)?)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview).",
"type": "string"
}
},
"type": "object"
},
"CheckUpgradeResponse": {
"description": "Message containing information about the result of an upgrade check operation.",
"id": "CheckUpgradeResponse",
"properties": {
"buildLogUri": {
"description": "Output only. Url for a docker build log of an upgraded image.",
"readOnly": true,
"type": "string"
},
"containsPypiModulesConflict": {
"description": "Output only. Whether build has succeeded or failed on modules conflicts.",
"enum": [
"CONFLICT_RESULT_UNSPECIFIED",
"CONFLICT",
"NO_CONFLICT"
],
"enumDescriptions": [
"It is unknown whether build had conflicts or not.",
"There were python packages conflicts.",
"There were no python packages conflicts."
],
"readOnly": true,
"type": "string"
},
"imageVersion": {
"description": "Composer image for which the build was happening.",
"type": "string"
},
"pypiConflictBuildLogExtract": {
"description": "Output only. Extract from a docker image build log containing information about pypi modules conflicts.",
"readOnly": true,
"type": "string"
},
"pypiDependencies": {
"additionalProperties": {
"type": "string"
},
"description": "Pypi dependencies specified in the environment configuration, at the time when the build was triggered.",
"type": "object"
}
},
"type": "object"
},
"CidrBlock": {
"description": "CIDR block with an optional name.",
"id": "CidrBlock",
"properties": {
"cidrBlock": {
"description": "CIDR block that must be specified in CIDR notation.",
"type": "string"
},
"displayName": {
"description": "User-defined name that identifies the CIDR block.",
"type": "string"
}
},
"type": "object"
},
"CloudDataLineageIntegration": {
"description": "Configuration for Cloud Data Lineage integration.",
"id": "CloudDataLineageIntegration",
"properties": {
"enabled": {
"description": "Optional. Whether or not Cloud Data Lineage integration is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"ComposerWorkload": {
"description": "Information about a single workload.",
"id": "ComposerWorkload",
"properties": {
"name": {
"description": "Name of a workload.",
"type": "string"
},
"status": {
"$ref": "ComposerWorkloadStatus",
"description": "Output only. Status of a workload.",
"readOnly": true
},
"type": {
"description": "Type of a workload.",
"enum": [
"COMPOSER_WORKLOAD_TYPE_UNSPECIFIED",
"CELERY_WORKER",
"KUBERNETES_WORKER",
"KUBERNETES_OPERATOR_POD",
"SCHEDULER",
"DAG_PROCESSOR",
"TRIGGERER",
"WEB_SERVER",
"REDIS"
],
"enumDescriptions": [
"Not able to determine the type of the workload.",
"Celery worker.",
"Kubernetes worker.",
"Workload created by Kubernetes Pod Operator.",
"Airflow scheduler.",
"Airflow Dag processor.",
"Airflow triggerer.",
"Airflow web server UI.",
"Redis."
],
"type": "string"
}
},
"type": "object"
},
"ComposerWorkloadStatus": {
"description": "Workload status.",
"id": "ComposerWorkloadStatus",
"properties": {
"detailedStatusMessage": {
"description": "Output only. Detailed message of the status.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Workload state.",
"enum": [
"COMPOSER_WORKLOAD_STATE_UNSPECIFIED",
"PENDING",
"OK",
"WARNING",
"ERROR",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"Not able to determine the status of the workload.",
"Workload is in pending state and has not yet started.",
"Workload is running fine.",
"Workload is running but there are some non-critical problems.",
"Workload is not running due to an error.",
"Workload has finished execution with success.",
"Workload has finished execution with failure."
],
"readOnly": true,
"type": "string"
},
"statusMessage": {
"description": "Output only. Text to provide more descriptive status.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"DagProcessorResource": {
"description": "Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"id": "DagProcessorResource",
"properties": {
"count": {
"description": "Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created.",
"format": "int32",
"type": "integer"
},
"cpu": {
"description": "Optional. CPU request and limit for a single Airflow DAG processor replica.",
"format": "float",
"type": "number"
},
"memoryGb": {
"description": "Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.",
"format": "float",
"type": "number"
},
"storageGb": {
"description": "Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"DataRetentionConfig": {
"description": "The configuration setting for Airflow database data retention mechanism.",
"id": "DataRetentionConfig",
"properties": {
"airflowMetadataRetentionConfig": {
"$ref": "AirflowMetadataRetentionPolicyConfig",
"description": "Optional. The retention policy for airflow metadata database."
},
"taskLogsRetentionConfig": {
"$ref": "TaskLogsRetentionConfig",
"description": "Optional. The configuration settings for task logs retention"
}
},
"type": "object"
},
"DatabaseConfig": {
"description": "The configuration of Cloud SQL instance that is used by the Apache Airflow software.",
"id": "DatabaseConfig",
"properties": {
"machineType": {
"description": "Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"type": "string"
},
"zone": {
"description": "Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*.",
"type": "string"
}
},
"type": "object"
},
"DatabaseFailoverRequest": {
"description": "Request to trigger database failover (only for highly resilient environments).",
"id": "DatabaseFailoverRequest",
"properties": {},
"type": "object"
},
"DatabaseFailoverResponse": {
"description": "Response for DatabaseFailoverRequest.",
"id": "DatabaseFailoverResponse",
"properties": {},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"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); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"EncryptionConfig": {
"description": "The encryption options for the Cloud Composer environment and its dependencies.Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"id": "EncryptionConfig",
"properties": {
"kmsKeyName": {
"description": "Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.",
"type": "string"
}
},
"type": "object"
},
"Environment": {
"description": "An environment for running orchestration tasks.",
"id": "Environment",
"properties": {
"config": {
"$ref": "EnvironmentConfig",
"description": "Configuration parameters for this environment."
},
"createTime": {
"description": "Output only. The time at which this environment was created.",
"format": "google-datetime",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62} * Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.",
"type": "object"
},
"name": {
"description": "The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.",
"type": "string"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"state": {
"description": "The current state of the environment.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"RUNNING",
"UPDATING",
"DELETING",
"ERROR"
],
"enumDescriptions": [
"The state of the environment is unknown.",
"The environment is in the process of being created.",
"The environment is currently running and healthy. It is ready for use.",
"The environment is being updated. It remains usable but cannot receive additional update requests or be deleted at this time.",
"The environment is undergoing deletion. It cannot be used.",
"The environment has encountered an error and cannot be used."
],
"type": "string"
},
"storageConfig": {
"$ref": "StorageConfig",
"description": "Optional. Storage configuration for this environment."
},
"updateTime": {
"description": "Output only. The time at which this environment was last modified.",
"format": "google-datetime",
"type": "string"
},
"uuid": {
"description": "Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.",
"type": "string"
}
},
"type": "object"
},
"EnvironmentConfig": {
"description": "Configuration information for an environment.",
"id": "EnvironmentConfig",
"properties": {
"airflowByoidUri": {
"description": "Output only. The 'bring your own identity' variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see [Access environments with workforce identity federation](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)).",
"readOnly": true,
"type": "string"
},
"airflowUri": {
"description": "Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)).",
"type": "string"
},
"dagGcsPrefix": {
"description": "Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using \"/\"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.",
"type": "string"
},
"dataRetentionConfig": {
"$ref": "DataRetentionConfig",
"description": "Optional. The configuration setting for Airflow database data retention mechanism."
},
"databaseConfig": {
"$ref": "DatabaseConfig",
"description": "Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software."
},
"encryptionConfig": {
"$ref": "EncryptionConfig",
"description": "Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated."
},
"environmentSize": {
"description": "Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.",
"enum": [
"ENVIRONMENT_SIZE_UNSPECIFIED",
"ENVIRONMENT_SIZE_SMALL",
"ENVIRONMENT_SIZE_MEDIUM",
"ENVIRONMENT_SIZE_LARGE"
],
"enumDescriptions": [
"The size of the environment is unspecified.",
"The environment size is small.",
"The environment size is medium.",
"The environment size is large."
],
"type": "string"
},
"gkeCluster": {
"description": "Output only. The Kubernetes Engine cluster used to run this environment.",
"type": "string"
},
"maintenanceWindow": {
"$ref": "MaintenanceWindow",
"description": "Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week."
},
"masterAuthorizedNetworksConfig": {
"$ref": "MasterAuthorizedNetworksConfig",
"description": "Optional. The configuration options for GKE cluster master authorized networks. By default master authorized networks feature is: - in case of private environment: enabled with no external networks allowlisted. - in case of public environment: disabled."
},
"nodeConfig": {
"$ref": "NodeConfig",
"description": "The configuration used for the Kubernetes Engine cluster."
},
"nodeCount": {
"description": "The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"format": "int32",
"type": "integer"
},
"privateEnvironmentConfig": {
"$ref": "PrivateEnvironmentConfig",
"description": "The configuration used for the Private IP Cloud Composer environment."
},
"recoveryConfig": {
"$ref": "RecoveryConfig",
"description": "Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer."
},
"resilienceMode": {
"description": "Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.",
"enum": [
"RESILIENCE_MODE_UNSPECIFIED",
"HIGH_RESILIENCE"
],
"enumDescriptions": [
"Default mode doesn't change environment parameters.",
"Enabled High Resilience mode, including Cloud SQL HA."
],
"type": "string"
},
"softwareConfig": {
"$ref": "SoftwareConfig",
"description": "The configuration settings for software inside the environment."
},
"webServerConfig": {
"$ref": "WebServerConfig",
"description": "Optional. The configuration settings for the Airflow web server App Engine instance."
},
"webServerNetworkAccessControl": {
"$ref": "WebServerNetworkAccessControl",
"description": "Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied."
},
"workloadsConfig": {
"$ref": "WorkloadsConfig",
"description": "Optional. The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web server and workers workloads. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer."
}
},
"type": "object"
},
"ExecuteAirflowCommandRequest": {
"description": "Execute Airflow Command request.",
"id": "ExecuteAirflowCommandRequest",
"properties": {
"command": {
"description": "Airflow command.",
"type": "string"
},
"parameters": {
"description": "Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `[\"my-dag-id\"]`, key-value parameters like `[\"--foo=bar\"]` or `[\"--foo\",\"bar\"]`, or other flags like `[\"-f\"]`.",
"items": {
"type": "string"
},
"type": "array"
},
"subcommand": {
"description": "Airflow subcommand.",
"type": "string"
}
},
"type": "object"
},
"ExecuteAirflowCommandResponse": {
"description": "Response to ExecuteAirflowCommandRequest.",
"id": "ExecuteAirflowCommandResponse",
"properties": {
"error": {
"description": "Error message. Empty if there was no error.",
"type": "string"
},
"executionId": {
"description": "The unique ID of the command execution for polling.",
"type": "string"
},
"pod": {
"description": "The name of the pod where the command is executed.",
"type": "string"
},
"podNamespace": {
"description": "The namespace of the pod where the command is executed.",
"type": "string"
}
},
"type": "object"
},
"ExitInfo": {
"description": "Information about how a command ended.",
"id": "ExitInfo",
"properties": {
"error": {
"description": "Error message. Empty if there was no error.",
"type": "string"
},
"exitCode": {
"description": "The exit code from the command execution.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"FetchDatabasePropertiesResponse": {
"description": "Response for FetchDatabasePropertiesRequest.",
"id": "FetchDatabasePropertiesResponse",
"properties": {
"isFailoverReplicaAvailable": {
"description": "The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true.",
"type": "boolean"
},
"primaryGceZone": {
"description": "The Compute Engine zone that the instance is currently serving from.",
"type": "string"
},
"secondaryGceZone": {
"description": "The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.",
"type": "string"
}
},
"type": "object"
},
"IPAllocationPolicy": {
"description": "Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.",
"id": "IPAllocationPolicy",
"properties": {
"clusterIpv4CidrBlock": {
"description": "Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.",
"type": "string"
},
"clusterSecondaryRangeName": {
"description": "Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true.",
"type": "string"
},
"servicesIpv4CidrBlock": {
"description": "Optional. The IP address range of the services IP addresses in this GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.",
"type": "string"
},
"servicesSecondaryRangeName": {
"description": "Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true.",
"type": "string"
},
"useIpAliases": {
"description": "Optional. Whether or not to enable Alias IPs in the GKE cluster. If `true`, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. Environments in newer versions always use VPC-native GKE clusters.",
"type": "boolean"
}
},
"type": "object"
},
"ImageVersion": {
"description": "ImageVersion information",
"id": "ImageVersion",
"properties": {
"creationDisabled": {
"description": "Whether it is impossible to create an environment with the image version.",
"type": "boolean"
},
"imageVersionId": {
"description": "The string identifier of the ImageVersion, in the form: \"composer-x.y.z-airflow-a.b.c\"",
"type": "string"
},
"isDefault": {
"description": "Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified.",
"type": "boolean"
},
"releaseDate": {
"$ref": "Date",
"description": "The date of the version release."
},
"supportedPythonVersions": {
"description": "supported python versions",
"items": {
"type": "string"
},
"type": "array"
},
"upgradeDisabled": {
"description": "Whether it is impossible to upgrade an environment running with the image version.",
"type": "boolean"
}
},
"type": "object"
},
"Line": {
"description": "Contains information about a single line from logs.",
"id": "Line",
"properties": {
"content": {
"description": "Text content of the log line.",
"type": "string"
},
"lineNumber": {
"description": "Number of the line.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ListEnvironmentsResponse": {
"description": "The environments in a project and location.",
"id": "ListEnvironmentsResponse",
"properties": {
"environments": {
"description": "The list of environments returned by a ListEnvironmentsRequest.",
"items": {
"$ref": "Environment"
},
"type": "array"
},
"nextPageToken": {
"description": "The page token used to query for the next page if one exists.",
"type": "string"
}
},
"type": "object"
},
"ListImageVersionsResponse": {
"description": "The ImageVersions in a project and location.",
"id": "ListImageVersionsResponse",
"properties": {
"imageVersions": {
"description": "The list of supported ImageVersions in a location.",
"items": {
"$ref": "ImageVersion"
},
"type": "array"
},
"nextPageToken": {
"description": "The page token used to query for the next page if one exists.",
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"ListUserWorkloadsConfigMapsResponse": {
"description": "The user workloads ConfigMaps for a given environment.",
"id": "ListUserWorkloadsConfigMapsResponse",
"properties": {
"nextPageToken": {
"description": "The page token used to query for the next page if one exists.",
"type": "string"
},
"userWorkloadsConfigMaps": {
"description": "The list of ConfigMaps returned by a ListUserWorkloadsConfigMapsRequest.",
"items": {
"$ref": "UserWorkloadsConfigMap"
},
"type": "array"
}
},
"type": "object"
},
"ListUserWorkloadsSecretsResponse": {
"description": "The user workloads Secrets for a given environment.",
"id": "ListUserWorkloadsSecretsResponse",
"properties": {
"nextPageToken": {
"description": "The page token used to query for the next page if one exists.",
"type": "string"
},
"userWorkloadsSecrets": {
"description": "The list of Secrets returned by a ListUserWorkloadsSecretsRequest.",
"items": {
"$ref": "UserWorkloadsSecret"
},
"type": "array"
}
},
"type": "object"
},
"ListWorkloadsResponse": {
"description": "Response to ListWorkloadsRequest.",
"id": "ListWorkloadsResponse",
"properties": {
"nextPageToken": {
"description": "The page token used to query for the next page if one exists.",
"type": "string"
},
"workloads": {
"description": "The list of environment workloads.",
"items": {
"$ref": "ComposerWorkload"
},
"type": "array"
}
},
"type": "object"
},
"LoadSnapshotRequest": {
"description": "Request to load a snapshot into a Cloud Composer environment.",
"id": "LoadSnapshotRequest",
"properties": {
"skipAirflowOverridesSetting": {
"description": "Whether or not to skip setting Airflow overrides when loading the environment's state.",
"type": "boolean"
},
"skipEnvironmentVariablesSetting": {
"description": "Whether or not to skip setting environment variables when loading the environment's state.",
"type": "boolean"
},
"skipGcsDataCopying": {
"description": "Whether or not to skip copying Cloud Storage data when loading the environment's state.",
"type": "boolean"
},
"skipPypiPackagesInstallation": {
"description": "Whether or not to skip installing Pypi packages when loading the environment's state.",
"type": "boolean"
},
"snapshotPath": {
"description": "A Cloud Storage path to a snapshot to load, e.g.: \"gs://my-bucket/snapshots/project_location_environment_timestamp\".",
"type": "string"
}
},
"type": "object"
},
"LoadSnapshotResponse": {
"description": "Response to LoadSnapshotRequest.",
"id": "LoadSnapshotResponse",
"properties": {},
"type": "object"
},
"MaintenanceWindow": {
"description": "The configuration settings for Cloud Composer maintenance window. The following example: ``` { \"startTime\":\"2019-08-01T01:00:00Z\" \"endTime\":\"2019-08-01T07:00:00Z\" \"recurrence\":\"FREQ=WEEKLY;BYDAY=TU,WE\" } ``` would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday.",
"id": "MaintenanceWindow",
"properties": {
"endTime": {
"description": "Required. Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to `start_time`.",
"format": "google-datetime",
"type": "string"
},
"recurrence": {
"description": "Required. Maintenance window recurrence. Format is a subset of [RFC-5545](https://tools.ietf.org/html/rfc5545) `RRULE`. The only allowed values for `FREQ` field are `FREQ=DAILY` and `FREQ=WEEKLY;BYDAY=...` Example values: `FREQ=WEEKLY;BYDAY=TU,WE`, `FREQ=DAILY`.",
"type": "string"
},
"startTime": {
"description": "Required. Start time of the first recurrence of the maintenance window.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"MasterAuthorizedNetworksConfig": {
"description": "Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.",
"id": "MasterAuthorizedNetworksConfig",
"properties": {
"cidrBlocks": {
"description": "Up to 50 external networks that could access Kubernetes master through HTTPS.",
"items": {
"$ref": "CidrBlock"
},
"type": "array"
},
"enabled": {
"description": "Whether or not master authorized networks feature is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"NetworkingConfig": {
"description": "Configuration options for networking connections in the Composer 2 environment.",
"id": "NetworkingConfig",
"properties": {
"connectionType": {
"description": "Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.",
"enum": [
"CONNECTION_TYPE_UNSPECIFIED",
"VPC_PEERING",
"PRIVATE_SERVICE_CONNECT"
],
"enumDescriptions": [
"No specific connection type was requested, so the environment uses the default value corresponding to the rest of its configuration.",
"Requests the use of VPC peerings for connecting the Customer and Tenant projects.",
"Requests the use of Private Service Connect for connecting the Customer and Tenant projects."
],
"type": "string"
}
},
"type": "object"
},
"NodeConfig": {
"description": "The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.",
"id": "NodeConfig",
"properties": {
"composerInternalIpv4CidrBlock": {
"description": "Optional. The IP range in CIDR notation to use internally by Cloud Composer. IP addresses are not reserved - and the same range can be used by multiple Cloud Composer environments. In case of overlap, IPs from this range will not be accessible in the user's VPC network. Cannot be updated. If not specified, the default value of '100.64.128.0/20' is used. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"type": "string"
},
"composerNetworkAttachment": {
"description": "Optional. Network Attachment that Cloud Composer environment is connected to, which provides connectivity with a user's VPC network. Takes precedence over network and subnetwork settings. If not provided, but network and subnetwork are defined during environment, it will be provisioned. If not provided and network and subnetwork are also empty, then connectivity to user's VPC network is disabled. Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"type": "string"
},
"diskSizeGb": {
"description": "Optional. The disk size in GB used for node VMs. Minimum size is 30GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"format": "int32",
"type": "integer"
},
"enableIpMasqAgent": {
"description": "Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent",
"type": "boolean"
},
"ipAllocationPolicy": {
"$ref": "IPAllocationPolicy",
"description": "Optional. The configuration for controlling how IPs are allocated in the GKE cluster."
},
"location": {
"description": "Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which to deploy the VMs used to run the Apache Airflow software, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: \"projects/{projectId}/zones/{zoneId}\". This `location` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong to this `location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (`location` or `nodeConfig.machineType`) is specified, the location information from the specified field will be propagated to the unspecified field. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"type": "string"
},
"machineType": {
"description": "Optional. The Compute Engine [machine type](/compute/docs/machine-types) used for cluster instances, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: \"projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}\". The `machineType` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.location` are specified, this `machineType` must belong to the `nodeConfig.location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and `nodeConfig.location` is specified, the location information from the specified field will be propagated to the unspecified field. The `machineTypeId` must not be a [shared-core machine type](/compute/docs/machine-types#sharedcore). If this field is unspecified, the `machineTypeId` defaults to \"n1-standard-1\". This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"type": "string"
},
"network": {
"description": "Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: \"projects/{projectId}/global/networks/{networkId}\". If unspecified, the \"default\" network ID in the environment's project is used. If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided. For [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see `nodeConfig.subnetwork`.",
"type": "string"
},
"oauthScopes": {
"description": "Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to [\"https://www.googleapis.com/auth/cloud-platform\"]. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"items": {
"type": "string"
},
"type": "array"
},
"serviceAccount": {
"description": "Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the \"default\" Compute Engine service account is used. Cannot be updated.",
"type": "string"
},
"subnetwork": {
"description": "Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: \"projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}\" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location.",
"type": "string"
},
"tags": {
"description": "Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"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"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"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"
},
"name": {
"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}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. 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`.",
"type": "object"
}
},
"type": "object"
},
"OperationMetadata": {
"description": "Metadata describing an operation.",
"id": "OperationMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was submitted to the server.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing.",
"format": "google-datetime",
"type": "string"
},
"operationType": {
"description": "Output only. The type of operation being performed.",
"enum": [
"TYPE_UNSPECIFIED",
"CREATE",
"DELETE",
"UPDATE",
"CHECK",
"SAVE_SNAPSHOT",
"LOAD_SNAPSHOT",
"DATABASE_FAILOVER"
],
"enumDescriptions": [
"Unused.",
"A resource creation operation.",
"A resource deletion operation.",
"A resource update operation.",
"A resource check operation.",
"Saves snapshot of the resource operation.",
"Loads snapshot of the resource operation.",
"Triggers failover of environment's Cloud SQL instance (only for highly resilient environments)."
],
"type": "string"
},
"resource": {
"description": "Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name).",
"type": "string"
},
"resourceUuid": {
"description": "Output only. The UUID of the resource being operated on.",
"type": "string"
},
"state": {
"description": "Output only. The current operation state.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"RUNNING",
"SUCCEEDED",
"SUCCESSFUL",
"FAILED"
],
"enumDescriptions": [
"Unused.",
"The operation has been created but is not yet started.",
"The operation is underway.",
"The operation completed successfully.",
"",
"The operation is no longer running but did not succeed."
],
"type": "string"
}
},
"type": "object"
},
"PollAirflowCommandRequest": {
"description": "Poll Airflow Command request.",
"id": "PollAirflowCommandRequest",
"properties": {
"executionId": {
"description": "The unique ID of the command execution.",
"type": "string"
},
"nextLineNumber": {
"description": "Line number from which new logs should be fetched.",
"format": "int32",
"type": "integer"
},
"pod": {
"description": "The name of the pod where the command is executed.",
"type": "string"
},
"podNamespace": {
"description": "The namespace of the pod where the command is executed.",
"type": "string"
}
},
"type": "object"
},
"PollAirflowCommandResponse": {
"description": "Response to PollAirflowCommandRequest.",
"id": "PollAirflowCommandResponse",
"properties": {
"exitInfo": {
"$ref": "ExitInfo",
"description": "The result exit status of the command."
},
"output": {
"description": "Output from the command execution. It may not contain the full output and the caller may need to poll for more lines.",
"items": {
"$ref": "Line"
},
"type": "array"
},
"outputEnd": {
"description": "Whether the command execution has finished and there is no more output.",
"type": "boolean"
}
},
"type": "object"
},
"PrivateClusterConfig": {
"description": "Configuration options for the private GKE cluster in a Cloud Composer environment.",
"id": "PrivateClusterConfig",
"properties": {
"enablePrivateEndpoint": {
"description": "Optional. If `true`, access to the public endpoint of the GKE cluster is denied.",
"type": "boolean"
},
"masterIpv4CidrBlock": {
"description": "Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.",
"type": "string"
},
"masterIpv4ReservedRange": {
"description": "Output only. The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the GKE cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PrivateEnvironmentConfig": {
"description": "The configuration information for configuring a Private IP Cloud Composer environment.",
"id": "PrivateEnvironmentConfig",
"properties": {
"cloudComposerConnectionSubnetwork": {
"description": "Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork.",
"type": "string"
},
"cloudComposerNetworkIpv4CidrBlock": {
"description": "Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.",
"type": "string"
},
"cloudComposerNetworkIpv4ReservedRange": {
"description": "Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.",
"readOnly": true,
"type": "string"
},
"cloudSqlIpv4CidrBlock": {
"description": "Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`.",
"type": "string"
},
"enablePrivateBuildsOnly": {
"description": "Optional. If `true`, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if either `NodeConfig.network` and `NodeConfig.subnetwork` fields or `NodeConfig.composer_network_attachment` field are specified). If `false`, the builds also have access to the internet. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"type": "boolean"
},
"enablePrivateEnvironment": {
"description": "Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"type": "boolean"
},
"enablePrivatelyUsedPublicIps": {
"description": "Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for `IPAllocationPolicy.cluster_ipv4_cidr_block` and `IPAllocationPolicy.service_ipv4_cidr_block`.",
"type": "boolean"
},
"networkingConfig": {
"$ref": "NetworkingConfig",
"description": "Optional. Configuration for the network connections configuration in the environment."
},
"privateClusterConfig": {
"$ref": "PrivateClusterConfig",
"description": "Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment."
},
"webServerIpv4CidrBlock": {
"description": "Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and `cloud_sql_ipv4_cidr_block`. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"type": "string"
},
"webServerIpv4ReservedRange": {
"description": "Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RecoveryConfig": {
"description": "The Recovery settings of an environment.",
"id": "RecoveryConfig",
"properties": {
"scheduledSnapshotsConfig": {
"$ref": "ScheduledSnapshotsConfig",
"description": "Optional. The configuration for scheduled snapshot creation mechanism."
}
},
"type": "object"
},
"SaveSnapshotRequest": {
"description": "Request to create a snapshot of a Cloud Composer environment.",
"id": "SaveSnapshotRequest",
"properties": {
"snapshotLocation": {
"description": "Location in a Cloud Storage where the snapshot is going to be stored, e.g.: \"gs://my-bucket/snapshots\".",
"type": "string"
}
},
"type": "object"
},
"SaveSnapshotResponse": {
"description": "Response to SaveSnapshotRequest.",
"id": "SaveSnapshotResponse",
"properties": {
"snapshotPath": {
"description": "The fully-resolved Cloud Storage path of the created snapshot, e.g.: \"gs://my-bucket/snapshots/project_location_environment_timestamp\". This field is populated only if the snapshot creation was successful.",
"type": "string"
}
},
"type": "object"
},
"ScheduledSnapshotsConfig": {
"description": "The configuration for scheduled snapshot creation mechanism.",
"id": "ScheduledSnapshotsConfig",
"properties": {
"enabled": {
"description": "Optional. Whether scheduled snapshots creation is enabled.",
"type": "boolean"
},
"snapshotCreationSchedule": {
"description": "Optional. The cron expression representing the time when snapshots creation mechanism runs. This field is subject to additional validation around frequency of execution.",
"type": "string"
},
"snapshotLocation": {
"description": "Optional. The Cloud Storage location for storing automatically created snapshots.",
"type": "string"
},
"timeZone": {
"description": "Optional. Time zone that sets the context to interpret snapshot_creation_schedule.",
"type": "string"
}
},
"type": "object"
},
"SchedulerResource": {
"description": "Configuration for resources used by Airflow schedulers.",
"id": "SchedulerResource",
"properties": {
"count": {
"description": "Optional. The number of schedulers.",
"format": "int32",
"type": "integer"
},
"cpu": {
"description": "Optional. CPU request and limit for a single Airflow scheduler replica.",
"format": "float",
"type": "number"
},
"memoryGb": {
"description": "Optional. Memory (GB) request and limit for a single Airflow scheduler replica.",
"format": "float",
"type": "number"
},
"storageGb": {
"description": "Optional. Storage (GB) request and limit for a single Airflow scheduler replica.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"SoftwareConfig": {
"description": "Specifies the selection and configuration of software inside the environment.",
"id": "SoftwareConfig",
"properties": {
"airflowConfigOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example \"core-dags_are_paused_at_creation\". Section names must not contain hyphens (\"-\"), opening square brackets (\"[\"), or closing square brackets (\"]\"). The property name must not be empty and must not contain an equals sign (\"=\") or semicolon (\";\"). Section and property names must not contain a period (\".\"). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.",
"type": "object"
},
"cloudDataLineageIntegration": {
"$ref": "CloudDataLineageIntegration",
"description": "Optional. The configuration for Cloud Data Lineage integration."
},
"envVariables": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`",
"type": "object"
},
"imageVersion": {
"description": "The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\\.[0-9]+\\.[0-9]+(-preview\\.[0-9]+)?)?|latest)-airflow-([0-9]+(\\.[0-9]+(\\.[0-9]+)?)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview).",
"type": "string"
},
"pypiPackages": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as \"numpy\" and values are the lowercase extras and version specifier such as \"==1.12.0\", \"[devel,gcp_api]\", or \"[devel]>=1.8.2, <1.9.2\". To specify a package without pinning it to a version specifier, use the empty string as the value.",
"type": "object"
},
"pythonVersion": {
"description": "Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '3'. Cannot be updated. This field is only supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. Environments in newer versions always use Python major version 3.",
"type": "string"
},
"schedulerCount": {
"description": "Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*.",
"format": "int32",
"type": "integer"
},
"webServerPluginsMode": {
"description": "Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to `PLUGINS_ENABLED`. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.",
"enum": [
"WEB_SERVER_PLUGINS_MODE_UNSPECIFIED",
"PLUGINS_DISABLED",
"PLUGINS_ENABLED"
],
"enumDescriptions": [
"Default mode.",
"Web server plugins are not supported.",
"Web server plugins are supported."
],
"type": "string"
}
},
"type": "object"
},
"Status": {
"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",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"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": "array"
},
"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"
}
},
"type": "object"
},
"StopAirflowCommandRequest": {
"description": "Stop Airflow Command request.",
"id": "StopAirflowCommandRequest",
"properties": {
"executionId": {
"description": "The unique ID of the command execution.",
"type": "string"
},
"force": {
"description": "If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.",
"type": "boolean"
},
"pod": {
"description": "The name of the pod where the command is executed.",
"type": "string"
},
"podNamespace": {
"description": "The namespace of the pod where the command is executed.",
"type": "string"
}
},
"type": "object"
},
"StopAirflowCommandResponse": {
"description": "Response to StopAirflowCommandRequest.",
"id": "StopAirflowCommandResponse",
"properties": {
"isDone": {
"description": "Whether the execution is still running.",
"type": "boolean"
},
"output": {
"description": "Output message from stopping execution request.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"StorageConfig": {
"description": "The configuration for data storage in the environment.",
"id": "StorageConfig",
"properties": {
"bucket": {
"description": "Optional. The name of the Cloud Storage bucket used by the environment. No `gs://` prefix.",
"type": "string"
}
},
"type": "object"
},
"TaskLogsRetentionConfig": {
"description": "The configuration setting for Task Logs.",
"id": "TaskLogsRetentionConfig",
"properties": {
"storageMode": {
"description": "Optional. The mode of storage for Airflow workers task logs.",
"enum": [
"TASK_LOGS_STORAGE_MODE_UNSPECIFIED",
"CLOUD_LOGGING_AND_CLOUD_STORAGE",
"CLOUD_LOGGING_ONLY"
],
"enumDescriptions": [
"This configuration is not specified by the user.",
"Store task logs in Cloud Logging and in the environment's Cloud Storage bucket.",
"Store task logs in Cloud Logging only."
],
"type": "string"
}
},
"type": "object"
},
"TriggererResource": {
"description": "Configuration for resources used by Airflow triggerers.",
"id": "TriggererResource",
"properties": {
"count": {
"description": "Optional. The number of triggerers.",
"format": "int32",
"type": "integer"
},
"cpu": {
"description": "Optional. CPU request and limit for a single Airflow triggerer replica.",
"format": "float",
"type": "number"
},
"memoryGb": {
"description": "Optional. Memory (GB) request and limit for a single Airflow triggerer replica.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"UserWorkloadsConfigMap": {
"description": "User workloads ConfigMap used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.",
"id": "UserWorkloadsConfigMap",
"properties": {
"data": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The \"data\" field of Kubernetes ConfigMap, organized in key-value pairs. For details see: https://kubernetes.io/docs/concepts/configuration/configmap/",
"type": "object"
},
"name": {
"description": "Identifier. The resource name of the ConfigMap, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}\"",
"type": "string"
}
},
"type": "object"
},
"UserWorkloadsSecret": {
"description": "User workloads Secret used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.",
"id": "UserWorkloadsSecret",
"properties": {
"data": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The \"data\" field of Kubernetes Secret, organized in key-value pairs, which can contain sensitive values such as a password, a token, or a key. The values for all keys have to be base64-encoded strings. For details see: https://kubernetes.io/docs/concepts/configuration/secret/",
"type": "object"
},
"name": {
"description": "Identifier. The resource name of the Secret, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}\"",
"type": "string"
}
},
"type": "object"
},
"WebServerConfig": {
"description": "The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*",
"id": "WebServerConfig",
"properties": {
"machineType": {
"description": "Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.",
"type": "string"
}
},
"type": "object"
},
"WebServerNetworkAccessControl": {
"description": "Network-level access control policy for the Airflow web server.",
"id": "WebServerNetworkAccessControl",
"properties": {
"allowedIpRanges": {
"description": "A collection of allowed IP ranges with descriptions.",
"items": {
"$ref": "AllowedIpRange"
},
"type": "array"
}
},
"type": "object"
},
"WebServerResource": {
"description": "Configuration for resources used by Airflow web server.",
"id": "WebServerResource",
"properties": {
"cpu": {
"description": "Optional. CPU request and limit for Airflow web server.",
"format": "float",
"type": "number"
},
"memoryGb": {
"description": "Optional. Memory (GB) request and limit for Airflow web server.",
"format": "float",
"type": "number"
},
"storageGb": {
"description": "Optional. Storage (GB) request and limit for Airflow web server.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"WorkerResource": {
"description": "Configuration for resources used by Airflow workers.",
"id": "WorkerResource",
"properties": {
"cpu": {
"description": "Optional. CPU request and limit for a single Airflow worker replica.",
"format": "float",
"type": "number"
},
"maxCount": {
"description": "Optional. Maximum number of workers for autoscaling.",
"format": "int32",
"type": "integer"
},
"memoryGb": {
"description": "Optional. Memory (GB) request and limit for a single Airflow worker replica.",
"format": "float",
"type": "number"
},
"minCount": {
"description": "Optional. Minimum number of workers for autoscaling.",
"format": "int32",
"type": "integer"
},
"storageGb": {
"description": "Optional. Storage (GB) request and limit for a single Airflow worker replica.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"WorkloadsConfig": {
"description": "The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.",
"id": "WorkloadsConfig",
"properties": {
"dagProcessor": {
"$ref": "DagProcessorResource",
"description": "Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer."
},
"scheduler": {
"$ref": "SchedulerResource",
"description": "Optional. Resources used by Airflow schedulers."
},
"triggerer": {
"$ref": "TriggererResource",
"description": "Optional. Resources used by Airflow triggerers."
},
"webServer": {
"$ref": "WebServerResource",
"description": "Optional. Resources used by Airflow web server."
},
"worker": {
"$ref": "WorkerResource",
"description": "Optional. Resources used by Airflow workers."
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Composer API",
"version": "v1",
"version_module": true
}