Class CustomCanaryDeployment.PhaseConfig.Builder (1.25.0)

public static final class CustomCanaryDeployment.PhaseConfig.Builder extends GeneratedMessageV3.Builder<CustomCanaryDeployment.PhaseConfig.Builder> implements CustomCanaryDeployment.PhaseConfigOrBuilder

PhaseConfig represents the configuration for a phase in the custom canary deployment.

Protobuf type google.cloud.deploy.v1.CustomCanaryDeployment.PhaseConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllProfiles(Iterable<String> values)

public CustomCanaryDeployment.PhaseConfig.Builder addAllProfiles(Iterable<String> values)

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Parameter
NameDescription
valuesIterable<String>

The profiles to add.

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

addProfiles(String value)

public CustomCanaryDeployment.PhaseConfig.Builder addProfiles(String value)

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Parameter
NameDescription
valueString

The profiles to add.

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

addProfilesBytes(ByteString value)

public CustomCanaryDeployment.PhaseConfig.Builder addProfilesBytes(ByteString value)

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Parameter
NameDescription
valueByteString

The bytes of the profiles to add.

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CustomCanaryDeployment.PhaseConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

build()

public CustomCanaryDeployment.PhaseConfig build()
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig

buildPartial()

public CustomCanaryDeployment.PhaseConfig buildPartial()
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig

clear()

public CustomCanaryDeployment.PhaseConfig.Builder clear()
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public CustomCanaryDeployment.PhaseConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CustomCanaryDeployment.PhaseConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

clearPercentage()

public CustomCanaryDeployment.PhaseConfig.Builder clearPercentage()

Required. Percentage deployment for the phase.

int32 percentage = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

clearPhaseId()

public CustomCanaryDeployment.PhaseConfig.Builder clearPhaseId()

Required. The ID to assign to the Rollout phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

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

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

clearPostdeploy()

public CustomCanaryDeployment.PhaseConfig.Builder clearPostdeploy()

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

.google.cloud.deploy.v1.Postdeploy postdeploy = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

clearPredeploy()

public CustomCanaryDeployment.PhaseConfig.Builder clearPredeploy()

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

.google.cloud.deploy.v1.Predeploy predeploy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

clearProfiles()

public CustomCanaryDeployment.PhaseConfig.Builder clearProfiles()

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

clearVerify()

public CustomCanaryDeployment.PhaseConfig.Builder clearVerify()

Whether to run verify tests after the deployment.

bool verify = 4;

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

clone()

public CustomCanaryDeployment.PhaseConfig.Builder clone()
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

getDefaultInstanceForType()

public CustomCanaryDeployment.PhaseConfig getDefaultInstanceForType()
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPercentage()

public int getPercentage()

Required. Percentage deployment for the phase.

int32 percentage = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The percentage.

getPhaseId()

public String getPhaseId()

Required. The ID to assign to the Rollout phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

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

Returns
TypeDescription
String

The phaseId.

getPhaseIdBytes()

public ByteString getPhaseIdBytes()

Required. The ID to assign to the Rollout phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

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

Returns
TypeDescription
ByteString

The bytes for phaseId.

getPostdeploy()

public Postdeploy getPostdeploy()

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

.google.cloud.deploy.v1.Postdeploy postdeploy = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Postdeploy

The postdeploy.

getPostdeployBuilder()

public Postdeploy.Builder getPostdeployBuilder()

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

.google.cloud.deploy.v1.Postdeploy postdeploy = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Postdeploy.Builder

getPostdeployOrBuilder()

public PostdeployOrBuilder getPostdeployOrBuilder()

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

.google.cloud.deploy.v1.Postdeploy postdeploy = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PostdeployOrBuilder

getPredeploy()

public Predeploy getPredeploy()

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

.google.cloud.deploy.v1.Predeploy predeploy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Predeploy

The predeploy.

getPredeployBuilder()

public Predeploy.Builder getPredeployBuilder()

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

.google.cloud.deploy.v1.Predeploy predeploy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Predeploy.Builder

getPredeployOrBuilder()

public PredeployOrBuilder getPredeployOrBuilder()

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

.google.cloud.deploy.v1.Predeploy predeploy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PredeployOrBuilder

getProfiles(int index)

public String getProfiles(int index)

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The profiles at the given index.

getProfilesBytes(int index)

public ByteString getProfilesBytes(int index)

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the profiles at the given index.

getProfilesCount()

public int getProfilesCount()

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Returns
TypeDescription
int

The count of profiles.

getProfilesList()

public ProtocolStringList getProfilesList()

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the profiles.

getVerify()

public boolean getVerify()

Whether to run verify tests after the deployment.

bool verify = 4;

Returns
TypeDescription
boolean

The verify.

hasPostdeploy()

public boolean hasPostdeploy()

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

.google.cloud.deploy.v1.Postdeploy postdeploy = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the postdeploy field is set.

hasPredeploy()

public boolean hasPredeploy()

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

.google.cloud.deploy.v1.Predeploy predeploy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the predeploy field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CustomCanaryDeployment.PhaseConfig other)

public CustomCanaryDeployment.PhaseConfig.Builder mergeFrom(CustomCanaryDeployment.PhaseConfig other)
Parameter
NameDescription
otherCustomCanaryDeployment.PhaseConfig
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CustomCanaryDeployment.PhaseConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CustomCanaryDeployment.PhaseConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

mergePostdeploy(Postdeploy value)

public CustomCanaryDeployment.PhaseConfig.Builder mergePostdeploy(Postdeploy value)

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

.google.cloud.deploy.v1.Postdeploy postdeploy = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePostdeploy
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

mergePredeploy(Predeploy value)

public CustomCanaryDeployment.PhaseConfig.Builder mergePredeploy(Predeploy value)

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

.google.cloud.deploy.v1.Predeploy predeploy = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePredeploy
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CustomCanaryDeployment.PhaseConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public CustomCanaryDeployment.PhaseConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

setPercentage(int value)

public CustomCanaryDeployment.PhaseConfig.Builder setPercentage(int value)

Required. Percentage deployment for the phase.

int32 percentage = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueint

The percentage to set.

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

setPhaseId(String value)

public CustomCanaryDeployment.PhaseConfig.Builder setPhaseId(String value)

Required. The ID to assign to the Rollout phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

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

Parameter
NameDescription
valueString

The phaseId to set.

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

setPhaseIdBytes(ByteString value)

public CustomCanaryDeployment.PhaseConfig.Builder setPhaseIdBytes(ByteString value)

Required. The ID to assign to the Rollout phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

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

Parameter
NameDescription
valueByteString

The bytes for phaseId to set.

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

setPostdeploy(Postdeploy value)

public CustomCanaryDeployment.PhaseConfig.Builder setPostdeploy(Postdeploy value)

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

.google.cloud.deploy.v1.Postdeploy postdeploy = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePostdeploy
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

setPostdeploy(Postdeploy.Builder builderForValue)

public CustomCanaryDeployment.PhaseConfig.Builder setPostdeploy(Postdeploy.Builder builderForValue)

Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.

.google.cloud.deploy.v1.Postdeploy postdeploy = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValuePostdeploy.Builder
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

setPredeploy(Predeploy value)

public CustomCanaryDeployment.PhaseConfig.Builder setPredeploy(Predeploy value)

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

.google.cloud.deploy.v1.Predeploy predeploy = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePredeploy
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

setPredeploy(Predeploy.Builder builderForValue)

public CustomCanaryDeployment.PhaseConfig.Builder setPredeploy(Predeploy.Builder builderForValue)

Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.

.google.cloud.deploy.v1.Predeploy predeploy = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValuePredeploy.Builder
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

setProfiles(int index, String value)

public CustomCanaryDeployment.PhaseConfig.Builder setProfiles(int index, String value)

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

repeated string profiles = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The profiles to set.

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.

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

public CustomCanaryDeployment.PhaseConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CustomCanaryDeployment.PhaseConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder
Overrides

setVerify(boolean value)

public CustomCanaryDeployment.PhaseConfig.Builder setVerify(boolean value)

Whether to run verify tests after the deployment.

bool verify = 4;

Parameter
NameDescription
valueboolean

The verify to set.

Returns
TypeDescription
CustomCanaryDeployment.PhaseConfig.Builder

This builder for chaining.