Class CustomCanaryDeployment.PhaseConfig (1.47.0)

public static final class CustomCanaryDeployment.PhaseConfig extends GeneratedMessageV3 implements CustomCanaryDeployment.PhaseConfigOrBuilder

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

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CustomCanaryDeployment.PhaseConfig

Static Fields

PERCENTAGE_FIELD_NUMBER

public static final int PERCENTAGE_FIELD_NUMBER
Field Value
Type Description
int

PHASE_ID_FIELD_NUMBER

public static final int PHASE_ID_FIELD_NUMBER
Field Value
Type Description
int

POSTDEPLOY_FIELD_NUMBER

public static final int POSTDEPLOY_FIELD_NUMBER
Field Value
Type Description
int

PREDEPLOY_FIELD_NUMBER

public static final int PREDEPLOY_FIELD_NUMBER
Field Value
Type Description
int

PROFILES_FIELD_NUMBER

public static final int PROFILES_FIELD_NUMBER
Field Value
Type Description
int

VERIFY_FIELD_NUMBER

public static final int VERIFY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomCanaryDeployment.PhaseConfig getDefaultInstance()
Returns
Type Description
CustomCanaryDeployment.PhaseConfig

getDescriptor()

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

newBuilder()

public static CustomCanaryDeployment.PhaseConfig.Builder newBuilder()
Returns
Type Description
CustomCanaryDeployment.PhaseConfig.Builder

newBuilder(CustomCanaryDeployment.PhaseConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static CustomCanaryDeployment.PhaseConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomCanaryDeployment.PhaseConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static CustomCanaryDeployment.PhaseConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomCanaryDeployment.PhaseConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static CustomCanaryDeployment.PhaseConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomCanaryDeployment.PhaseConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static CustomCanaryDeployment.PhaseConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomCanaryDeployment.PhaseConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static CustomCanaryDeployment.PhaseConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomCanaryDeployment.PhaseConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CustomCanaryDeployment.PhaseConfig> parser()
Returns
Type Description
Parser<PhaseConfig>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CustomCanaryDeployment.PhaseConfig getDefaultInstanceForType()
Returns
Type Description
CustomCanaryDeployment.PhaseConfig

getParserForType()

public Parser<CustomCanaryDeployment.PhaseConfig> getParserForType()
Returns
Type Description
Parser<PhaseConfig>
Overrides

getPercentage()

public int getPercentage()

Required. Percentage deployment for the phase.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for phaseId.

getPostdeploy()

public Postdeploy getPostdeploy()

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

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

Returns
Type Description
Postdeploy

The postdeploy.

getPostdeployOrBuilder()

public PostdeployOrBuilder getPostdeployOrBuilder()

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

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

Returns
Type Description
PostdeployOrBuilder

getPredeploy()

public Predeploy getPredeploy()

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

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

Returns
Type Description
Predeploy

The predeploy.

getPredeployOrBuilder()

public PredeployOrBuilder getPredeployOrBuilder()

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

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

Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the profiles.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVerify()

public boolean getVerify()

Whether to run verify tests after the deployment.

bool verify = 4;

Returns
Type Description
boolean

The verify.

hasPostdeploy()

public boolean hasPostdeploy()

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

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

Returns
Type Description
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, there will be no predeploy job for this phase.

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

Returns
Type Description
boolean

Whether the predeploy 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 CustomCanaryDeployment.PhaseConfig.Builder newBuilderForType()
Returns
Type Description
CustomCanaryDeployment.PhaseConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public CustomCanaryDeployment.PhaseConfig.Builder toBuilder()
Returns
Type Description
CustomCanaryDeployment.PhaseConfig.Builder

writeTo(CodedOutputStream output)

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