Class CheckUpgradeRequest.Builder (1.85.0) 

public static final class CheckUpgradeRequest.Builder extends GeneratedMessage.Builder<CheckUpgradeRequest.Builder> implements CheckUpgradeRequestOrBuilder

Request to check whether image upgrade will succeed.

Protobuf type google.cloud.orchestration.airflow.service.v1.CheckUpgradeRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CheckUpgradeRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public CheckUpgradeRequest build()
Returns
Type Description
CheckUpgradeRequest

buildPartial()

public CheckUpgradeRequest buildPartial()
Returns
Type Description
CheckUpgradeRequest

clear()

public CheckUpgradeRequest.Builder clear()
Returns
Type Description
CheckUpgradeRequest.Builder
Overrides

clearEnvironment()

public CheckUpgradeRequest.Builder clearEnvironment()

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

string environment = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CheckUpgradeRequest.Builder

This builder for chaining.

clearImageVersion()

public CheckUpgradeRequest.Builder clearImageVersion()

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.

string image_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CheckUpgradeRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public CheckUpgradeRequest getDefaultInstanceForType()
Returns
Type Description
CheckUpgradeRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnvironment()

public String getEnvironment()

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

string environment = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The environment.

getEnvironmentBytes()

public ByteString getEnvironmentBytes()

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

string environment = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for environment.

getImageVersion()

public String 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.

string image_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The imageVersion.

getImageVersionBytes()

public ByteString getImageVersionBytes()

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.

string image_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for imageVersion.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CheckUpgradeRequest other)

public CheckUpgradeRequest.Builder mergeFrom(CheckUpgradeRequest other)
Parameter
Name Description
other CheckUpgradeRequest
Returns
Type Description
CheckUpgradeRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CheckUpgradeRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckUpgradeRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CheckUpgradeRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CheckUpgradeRequest.Builder
Overrides

setEnvironment(String value)

public CheckUpgradeRequest.Builder setEnvironment(String value)

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

string environment = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The environment to set.
Returns
Type Description
CheckUpgradeRequest.Builder

This builder for chaining.

setEnvironmentBytes(ByteString value)

public CheckUpgradeRequest.Builder setEnvironmentBytes(ByteString value)

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

string environment = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for environment to set.
Returns
Type Description
CheckUpgradeRequest.Builder

This builder for chaining.

setImageVersion(String value)

public CheckUpgradeRequest.Builder setImageVersion(String value)

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.

string image_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The imageVersion to set.
Returns
Type Description
CheckUpgradeRequest.Builder

This builder for chaining.

setImageVersionBytes(ByteString value)

public CheckUpgradeRequest.Builder setImageVersionBytes(ByteString value)

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.

string image_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for imageVersion to set.
Returns
Type Description
CheckUpgradeRequest.Builder

This builder for chaining.