Class Canary (1.45.0) 

public final class Canary extends GeneratedMessageV3 implements CanaryOrBuilder

Canary represents the canary deployment strategy.

Protobuf type google.cloud.deploy.v1.Canary

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Canary

Implements

CanaryOrBuilder

Static Fields

CANARY_DEPLOYMENT_FIELD_NUMBER

public static final int CANARY_DEPLOYMENT_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_CANARY_DEPLOYMENT_FIELD_NUMBER

public static final int CUSTOM_CANARY_DEPLOYMENT_FIELD_NUMBER
Field Value
Type Description
int

RUNTIME_CONFIG_FIELD_NUMBER

public static final int RUNTIME_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Canary getDefaultInstance()
Returns
Type Description
Canary

getDescriptor()

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

newBuilder()

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

newBuilder(Canary prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCanaryDeployment()

public CanaryDeployment getCanaryDeployment()

Configures the progressive based deployment for a Target.

.google.cloud.deploy.v1.CanaryDeployment canary_deployment = 2;

Returns
Type Description
CanaryDeployment

The canaryDeployment.

getCanaryDeploymentOrBuilder()

public CanaryDeploymentOrBuilder getCanaryDeploymentOrBuilder()

Configures the progressive based deployment for a Target.

.google.cloud.deploy.v1.CanaryDeployment canary_deployment = 2;

Returns
Type Description
CanaryDeploymentOrBuilder

getCustomCanaryDeployment()

public CustomCanaryDeployment getCustomCanaryDeployment()

Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.

.google.cloud.deploy.v1.CustomCanaryDeployment custom_canary_deployment = 3;

Returns
Type Description
CustomCanaryDeployment

The customCanaryDeployment.

getCustomCanaryDeploymentOrBuilder()

public CustomCanaryDeploymentOrBuilder getCustomCanaryDeploymentOrBuilder()

Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.

.google.cloud.deploy.v1.CustomCanaryDeployment custom_canary_deployment = 3;

Returns
Type Description
CustomCanaryDeploymentOrBuilder

getDefaultInstanceForType()

public Canary getDefaultInstanceForType()
Returns
Type Description
Canary

getModeCase()

public Canary.ModeCase getModeCase()
Returns
Type Description
Canary.ModeCase

getParserForType()

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

getRuntimeConfig()

public RuntimeConfig getRuntimeConfig()

Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.

.google.cloud.deploy.v1.RuntimeConfig runtime_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RuntimeConfig

The runtimeConfig.

getRuntimeConfigOrBuilder()

public RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.

.google.cloud.deploy.v1.RuntimeConfig runtime_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RuntimeConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCanaryDeployment()

public boolean hasCanaryDeployment()

Configures the progressive based deployment for a Target.

.google.cloud.deploy.v1.CanaryDeployment canary_deployment = 2;

Returns
Type Description
boolean

Whether the canaryDeployment field is set.

hasCustomCanaryDeployment()

public boolean hasCustomCanaryDeployment()

Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.

.google.cloud.deploy.v1.CustomCanaryDeployment custom_canary_deployment = 3;

Returns
Type Description
boolean

Whether the customCanaryDeployment field is set.

hasRuntimeConfig()

public boolean hasRuntimeConfig()

Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.

.google.cloud.deploy.v1.RuntimeConfig runtime_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the runtimeConfig field is set.

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 Canary.Builder newBuilderForType()
Returns
Type Description
Canary.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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