Class CheckUpgradeRequest (1.47.0)

public final class CheckUpgradeRequest extends GeneratedMessageV3 implements CheckUpgradeRequestOrBuilder

Request to check whether image upgrade will succeed.

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

Static Fields

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_VERSION_FIELD_NUMBER

public static final int IMAGE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CheckUpgradeRequest getDefaultInstance()
Returns
Type Description
CheckUpgradeRequest

getDescriptor()

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

newBuilder()

public static CheckUpgradeRequest.Builder newBuilder()
Returns
Type Description
CheckUpgradeRequest.Builder

newBuilder(CheckUpgradeRequest prototype)

public static CheckUpgradeRequest.Builder newBuilder(CheckUpgradeRequest prototype)
Parameter
Name Description
prototype CheckUpgradeRequest
Returns
Type Description
CheckUpgradeRequest.Builder

parseDelimitedFrom(InputStream input)

public static CheckUpgradeRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckUpgradeRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CheckUpgradeRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CheckUpgradeRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CheckUpgradeRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CheckUpgradeRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CheckUpgradeRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckUpgradeRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CheckUpgradeRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckUpgradeRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CheckUpgradeRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CheckUpgradeRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckUpgradeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CheckUpgradeRequest> parser()
Returns
Type Description
Parser<CheckUpgradeRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CheckUpgradeRequest getDefaultInstanceForType()
Returns
Type Description
CheckUpgradeRequest

getEnvironment()

public String getEnvironment()

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

string environment = 1;

Returns
Type Description
String

The environment.

getEnvironmentBytes()

public ByteString getEnvironmentBytes()

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

string environment = 1;

Returns
Type Description
ByteString

The bytes for environment.

getImageVersion()

public String getImageVersion()

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;

Returns
Type Description
String

The imageVersion.

getImageVersionBytes()

public ByteString getImageVersionBytes()

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;

Returns
Type Description
ByteString

The bytes for imageVersion.

getParserForType()

public Parser<CheckUpgradeRequest> getParserForType()
Returns
Type Description
Parser<CheckUpgradeRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CheckUpgradeRequest.Builder newBuilderForType()
Returns
Type Description
CheckUpgradeRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CheckUpgradeRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CheckUpgradeRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CheckUpgradeRequest.Builder toBuilder()
Returns
Type Description
CheckUpgradeRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException