Skip to content

Commit

Permalink
feat(composer): update the API
Browse files Browse the repository at this point in the history
#### composer:v1beta1

The following keys were added:
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.description
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.flatPath
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.httpMethod
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.id
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.parameterOrder
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.parameters.name.description
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.parameters.name.location
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.parameters.name.pattern
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.parameters.name.required
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.parameters.name.type
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.path
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.request.$ref
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.response.$ref
- resources.projects.resources.locations.resources.environments.methods.restartWebServer.scopes
- resources.projects.resources.locations.resources.imageVersions.methods.list.parameters.includePastReleases.description
- resources.projects.resources.locations.resources.imageVersions.methods.list.parameters.includePastReleases.location
- resources.projects.resources.locations.resources.imageVersions.methods.list.parameters.includePastReleases.type
- schemas.Date.description
- schemas.Date.id
- schemas.Date.properties.day.description
- schemas.Date.properties.day.format
- schemas.Date.properties.day.type
- schemas.Date.properties.month.description
- schemas.Date.properties.month.format
- schemas.Date.properties.month.type
- schemas.Date.properties.year.description
- schemas.Date.properties.year.format
- schemas.Date.properties.year.type
- schemas.Date.type
- schemas.EncryptionConfig.description
- schemas.EncryptionConfig.id
- schemas.EncryptionConfig.properties.kmsKeyName.description
- schemas.EncryptionConfig.properties.kmsKeyName.type
- schemas.EncryptionConfig.type
- schemas.EnvironmentConfig.properties.encryptionConfig.$ref
- schemas.EnvironmentConfig.properties.encryptionConfig.description
- schemas.ImageVersion.properties.creationDisabled.description
- schemas.ImageVersion.properties.creationDisabled.type
- schemas.ImageVersion.properties.releaseDate.$ref
- schemas.ImageVersion.properties.releaseDate.description
- schemas.ImageVersion.properties.upgradeDisabled.description
- schemas.ImageVersion.properties.upgradeDisabled.type
- schemas.RestartWebServerRequest.description
- schemas.RestartWebServerRequest.id
- schemas.RestartWebServerRequest.type

#### composer:v1

The following keys were added:
- resources.projects.resources.locations.resources.imageVersions.methods.list.parameters.includePastReleases.description
- resources.projects.resources.locations.resources.imageVersions.methods.list.parameters.includePastReleases.location
- resources.projects.resources.locations.resources.imageVersions.methods.list.parameters.includePastReleases.type
- schemas.AllowedIpRange.description
- schemas.AllowedIpRange.id
- schemas.AllowedIpRange.properties.description.description
- schemas.AllowedIpRange.properties.description.type
- schemas.AllowedIpRange.properties.value.description
- schemas.AllowedIpRange.properties.value.type
- schemas.AllowedIpRange.type
- schemas.Date.description
- schemas.Date.id
- schemas.Date.properties.day.description
- schemas.Date.properties.day.format
- schemas.Date.properties.day.type
- schemas.Date.properties.month.description
- schemas.Date.properties.month.format
- schemas.Date.properties.month.type
- schemas.Date.properties.year.description
- schemas.Date.properties.year.format
- schemas.Date.properties.year.type
- schemas.Date.type
- schemas.EnvironmentConfig.properties.webServerNetworkAccessControl.$ref
- schemas.EnvironmentConfig.properties.webServerNetworkAccessControl.description
- schemas.ImageVersion.properties.creationDisabled.description
- schemas.ImageVersion.properties.creationDisabled.type
- schemas.ImageVersion.properties.releaseDate.$ref
- schemas.ImageVersion.properties.releaseDate.description
- schemas.ImageVersion.properties.upgradeDisabled.description
- schemas.ImageVersion.properties.upgradeDisabled.type
- schemas.WebServerNetworkAccessControl.description
- schemas.WebServerNetworkAccessControl.id
- schemas.WebServerNetworkAccessControl.properties.allowedIpRanges.description
- schemas.WebServerNetworkAccessControl.properties.allowedIpRanges.items.$ref
- schemas.WebServerNetworkAccessControl.properties.allowedIpRanges.type
- schemas.WebServerNetworkAccessControl.type

The following keys were changed:
- resources.projects.resources.locations.resources.environments.methods.patch.parameters.updateMask.description
  • Loading branch information
yoshi-automation authored and sofisl committed Dec 5, 2020
1 parent b6bc76f commit 2827aed
Show file tree
Hide file tree
Showing 4 changed files with 430 additions and 5 deletions.
76 changes: 74 additions & 2 deletions discovery/composer-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@
"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: *Mask* *Purpose* 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. 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. It is an error to provide both this mask and a mask specifying one or more individual environment variables. ",
"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: *Mask* *Purpose* 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. 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. It is an error to provide both this mask and a mask specifying one or more individual environment variables. ",
"format": "google-fieldmask",
"location": "query",
"type": "string"
Expand Down Expand Up @@ -272,6 +272,11 @@
"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",
Expand Down Expand Up @@ -401,9 +406,46 @@
}
}
},
"revision": "20201002",
"revision": "20201202",
"rootUrl": "https://composer.googleapis.com/",
"schemas": {
"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"
},
"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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `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); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
Expand Down Expand Up @@ -498,6 +540,10 @@
"softwareConfig": {
"$ref": "SoftwareConfig",
"description": "The configuration settings for software inside the environment."
},
"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."
}
},
"type": "object"
Expand Down Expand Up @@ -533,6 +579,10 @@
"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"
Expand All @@ -541,12 +591,20 @@
"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"
Expand Down Expand Up @@ -861,6 +919,20 @@
}
},
"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"
}
},
"servicePath": "",
Expand Down
Loading

0 comments on commit 2827aed

Please sign in to comment.