Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class CheckUpgradeRequest.
Request to check whether image upgrade will succeed.
Generated from protobuf message google.cloud.orchestration.airflow.service.v1.CheckUpgradeRequest
Namespace
Google \ Cloud \ Orchestration \ Airflow \ Service \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ environment
string
Required. The resource name of the environment to check upgrade for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
↳ image_version
string
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, 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 and versioning overview.
getEnvironment
Required. The resource name of the environment to check upgrade for, in the
form:
"projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Returns
Type
Description
string
setEnvironment
Required. The resource name of the environment to check upgrade for, in the
form:
"projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getImageVersion
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, 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 and versioning
overview.
Returns
Type
Description
string
setImageVersion
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, 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 and versioning
overview.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Orchestration Airflow V1 Client - Class CheckUpgradeRequest (2.1.8)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.8 (latest)](/php/docs/reference/cloud-orchestration-airflow/latest/V1.CheckUpgradeRequest)\n- [2.1.7](/php/docs/reference/cloud-orchestration-airflow/2.1.7/V1.CheckUpgradeRequest)\n- [2.0.1](/php/docs/reference/cloud-orchestration-airflow/2.0.1/V1.CheckUpgradeRequest)\n- [1.6.4](/php/docs/reference/cloud-orchestration-airflow/1.6.4/V1.CheckUpgradeRequest)\n- [1.5.0](/php/docs/reference/cloud-orchestration-airflow/1.5.0/V1.CheckUpgradeRequest)\n- [1.4.2](/php/docs/reference/cloud-orchestration-airflow/1.4.2/V1.CheckUpgradeRequest)\n- [1.3.0](/php/docs/reference/cloud-orchestration-airflow/1.3.0/V1.CheckUpgradeRequest)\n- [1.2.0](/php/docs/reference/cloud-orchestration-airflow/1.2.0/V1.CheckUpgradeRequest)\n- [1.1.0](/php/docs/reference/cloud-orchestration-airflow/1.1.0/V1.CheckUpgradeRequest)\n- [1.0.4](/php/docs/reference/cloud-orchestration-airflow/1.0.4/V1.CheckUpgradeRequest) \nReference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class CheckUpgradeRequest.\n\nRequest to check whether image upgrade will succeed.\n\nGenerated from protobuf message `google.cloud.orchestration.airflow.service.v1.CheckUpgradeRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Orchestration \\\\ Airflow \\\\ Service \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEnvironment\n\nRequired. The resource name of the environment to check upgrade for, in the\nform:\n\"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"\n\n### setEnvironment\n\nRequired. The resource name of the environment to check upgrade for, in the\nform:\n\"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"\n\n### getImageVersion\n\nOptional. The version of the software running in the environment.\n\nThis encapsulates both the version of Cloud Composer functionality and the\nversion of Apache Airflow. It must match the regular expression\n`composer-([0-9]+(\\.[0-9]+\\.[0-9]+(-preview\\.[0-9]+)?)?|latest)-airflow-([0-9]+(\\.[0-9]+(\\.[0-9]+)?)?)`.\nWhen used as input, the server also checks if the provided version is\nsupported and denies the request for an unsupported version.\nThe Cloud Composer portion of the image version is a full\n[semantic version](https://semver.org), or an alias in the form of major\nversion number or `latest`. When an alias is provided, the server replaces\nit with the current Cloud Composer version that satisfies the alias.\nThe Apache Airflow portion of the image version is a full semantic version\nthat points to one of the supported Apache Airflow versions, or an alias in\nthe form of only major or major.minor versions specified. When an alias is\nprovided, the server replaces it with the latest Apache Airflow version\nthat satisfies the alias and is supported in the given Cloud Composer\nversion.\nIn all cases, the resolved image version is stored in the same field.\nSee also [version\nlist](/composer/docs/concepts/versioning/composer-versions) and [versioning\noverview](/composer/docs/concepts/versioning/composer-versioning-overview).\n\n### setImageVersion\n\nOptional. The version of the software running in the environment.\n\nThis encapsulates both the version of Cloud Composer functionality and the\nversion of Apache Airflow. It must match the regular expression\n`composer-([0-9]+(\\.[0-9]+\\.[0-9]+(-preview\\.[0-9]+)?)?|latest)-airflow-([0-9]+(\\.[0-9]+(\\.[0-9]+)?)?)`.\nWhen used as input, the server also checks if the provided version is\nsupported and denies the request for an unsupported version.\nThe Cloud Composer portion of the image version is a full\n[semantic version](https://semver.org), or an alias in the form of major\nversion number or `latest`. When an alias is provided, the server replaces\nit with the current Cloud Composer version that satisfies the alias.\nThe Apache Airflow portion of the image version is a full semantic version\nthat points to one of the supported Apache Airflow versions, or an alias in\nthe form of only major or major.minor versions specified. When an alias is\nprovided, the server replaces it with the latest Apache Airflow version\nthat satisfies the alias and is supported in the given Cloud Composer\nversion.\nIn all cases, the resolved image version is stored in the same field.\nSee also [version\nlist](/composer/docs/concepts/versioning/composer-versions) and [versioning\noverview](/composer/docs/concepts/versioning/composer-versioning-overview)."]]