Cloud Composer v1 API - Class CheckUpgradeRequest (2.9.0) 

public sealed class CheckUpgradeRequest : IMessage<CheckUpgradeRequest>, IEquatable<CheckUpgradeRequest>, IDeepCloneable<CheckUpgradeRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Composer v1 API class CheckUpgradeRequest.

Request to check whether image upgrade will succeed.

Inheritance

object > CheckUpgradeRequest

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

Google.Cloud.Orchestration.Airflow.Service.V1.dll

Constructors

CheckUpgradeRequest()

public CheckUpgradeRequest()

CheckUpgradeRequest(CheckUpgradeRequest)

public CheckUpgradeRequest(CheckUpgradeRequest other)
Parameter
Name Description
other CheckUpgradeRequest

Properties

Environment

public string Environment { get; set; }

Required. The resource name of the environment to check upgrade for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Property Value
Type Description
string

ImageVersion

public string ImageVersion { get; set; }

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.

Property Value
Type Description
string