Class Canary.Builder (1.44.0)

public static final class Canary.Builder extends GeneratedMessageV3.Builder<Canary.Builder> implements CanaryOrBuilder

Canary represents the canary deployment strategy.

Protobuf type google.cloud.deploy.v1.Canary

Implements

CanaryOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Canary.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Canary.Builder
Overrides

build()

public Canary build()
Returns
Type Description
Canary

buildPartial()

public Canary buildPartial()
Returns
Type Description
Canary

clear()

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

clearCanaryDeployment()

public Canary.Builder clearCanaryDeployment()

Configures the progressive based deployment for a Target.

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

Returns
Type Description
Canary.Builder

clearCustomCanaryDeployment()

public Canary.Builder clearCustomCanaryDeployment()

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
Canary.Builder

clearField(Descriptors.FieldDescriptor field)

public Canary.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Canary.Builder
Overrides

clearMode()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public Canary.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Canary.Builder
Overrides

clearRuntimeConfig()

public Canary.Builder clearRuntimeConfig()

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
Canary.Builder

clone()

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

getCanaryDeploymentBuilder()

public CanaryDeployment.Builder getCanaryDeploymentBuilder()

Configures the progressive based deployment for a Target.

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

Returns
Type Description
CanaryDeployment.Builder

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.

getCustomCanaryDeploymentBuilder()

public CustomCanaryDeployment.Builder getCustomCanaryDeploymentBuilder()

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.Builder

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

getDescriptorForType()

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

getModeCase()

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

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.

getRuntimeConfigBuilder()

public RuntimeConfig.Builder getRuntimeConfigBuilder()

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.Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCanaryDeployment(CanaryDeployment value)

public Canary.Builder mergeCanaryDeployment(CanaryDeployment value)

Configures the progressive based deployment for a Target.

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

Parameter
Name Description
value CanaryDeployment
Returns
Type Description
Canary.Builder

mergeCustomCanaryDeployment(CustomCanaryDeployment value)

public Canary.Builder mergeCustomCanaryDeployment(CustomCanaryDeployment value)

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;

Parameter
Name Description
value CustomCanaryDeployment
Returns
Type Description
Canary.Builder

mergeFrom(Canary other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRuntimeConfig(RuntimeConfig value)

public Canary.Builder mergeRuntimeConfig(RuntimeConfig value)

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];

Parameter
Name Description
value RuntimeConfig
Returns
Type Description
Canary.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Canary.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Canary.Builder
Overrides

setCanaryDeployment(CanaryDeployment value)

public Canary.Builder setCanaryDeployment(CanaryDeployment value)

Configures the progressive based deployment for a Target.

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

Parameter
Name Description
value CanaryDeployment
Returns
Type Description
Canary.Builder

setCanaryDeployment(CanaryDeployment.Builder builderForValue)

public Canary.Builder setCanaryDeployment(CanaryDeployment.Builder builderForValue)

Configures the progressive based deployment for a Target.

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

Parameter
Name Description
builderForValue CanaryDeployment.Builder
Returns
Type Description
Canary.Builder

setCustomCanaryDeployment(CustomCanaryDeployment value)

public Canary.Builder setCustomCanaryDeployment(CustomCanaryDeployment value)

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;

Parameter
Name Description
value CustomCanaryDeployment
Returns
Type Description
Canary.Builder

setCustomCanaryDeployment(CustomCanaryDeployment.Builder builderForValue)

public Canary.Builder setCustomCanaryDeployment(CustomCanaryDeployment.Builder builderForValue)

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;

Parameter
Name Description
builderForValue CustomCanaryDeployment.Builder
Returns
Type Description
Canary.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Canary.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Canary.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Canary.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Canary.Builder
Overrides

setRuntimeConfig(RuntimeConfig value)

public Canary.Builder setRuntimeConfig(RuntimeConfig value)

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];

Parameter
Name Description
value RuntimeConfig
Returns
Type Description
Canary.Builder

setRuntimeConfig(RuntimeConfig.Builder builderForValue)

public Canary.Builder setRuntimeConfig(RuntimeConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue RuntimeConfig.Builder
Returns
Type Description
Canary.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Canary.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Canary.Builder
Overrides