Class RolloutOptions (3.59.0)

public final class RolloutOptions extends GeneratedMessageV3 implements RolloutOptionsOrBuilder

Configuration for rolling deployments.

Protobuf type google.cloud.aiplatform.v1beta1.RolloutOptions

Static Fields

MAX_SURGE_PERCENTAGE_FIELD_NUMBER

public static final int MAX_SURGE_PERCENTAGE_FIELD_NUMBER
Field Value
Type Description
int

MAX_SURGE_REPLICAS_FIELD_NUMBER

public static final int MAX_SURGE_REPLICAS_FIELD_NUMBER
Field Value
Type Description
int

MAX_UNAVAILABLE_PERCENTAGE_FIELD_NUMBER

public static final int MAX_UNAVAILABLE_PERCENTAGE_FIELD_NUMBER
Field Value
Type Description
int

MAX_UNAVAILABLE_REPLICAS_FIELD_NUMBER

public static final int MAX_UNAVAILABLE_REPLICAS_FIELD_NUMBER
Field Value
Type Description
int

PREVIOUS_DEPLOYED_MODEL_FIELD_NUMBER

public static final int PREVIOUS_DEPLOYED_MODEL_FIELD_NUMBER
Field Value
Type Description
int

REVISION_NUMBER_FIELD_NUMBER

public static final int REVISION_NUMBER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RolloutOptions getDefaultInstance()
Returns
Type Description
RolloutOptions

getDescriptor()

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

newBuilder()

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

newBuilder(RolloutOptions prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RolloutOptions getDefaultInstanceForType()
Returns
Type Description
RolloutOptions

getMaxSurgeCase()

public RolloutOptions.MaxSurgeCase getMaxSurgeCase()
Returns
Type Description
RolloutOptions.MaxSurgeCase

getMaxSurgePercentage()

public int getMaxSurgePercentage()

Percentage of allowed additional replicas. For autoscaling deployments, this refers to the target replica count.

int32 max_surge_percentage = 6;

Returns
Type Description
int

The maxSurgePercentage.

getMaxSurgeReplicas()

public int getMaxSurgeReplicas()

Absolute count of allowed additional replicas.

int32 max_surge_replicas = 5;

Returns
Type Description
int

The maxSurgeReplicas.

getMaxUnavailableCase()

public RolloutOptions.MaxUnavailableCase getMaxUnavailableCase()
Returns
Type Description
RolloutOptions.MaxUnavailableCase

getMaxUnavailablePercentage()

public int getMaxUnavailablePercentage()

Percentage of replicas allowed to be unavailable. For autoscaling deployments, this refers to the target replica count.

int32 max_unavailable_percentage = 4;

Returns
Type Description
int

The maxUnavailablePercentage.

getMaxUnavailableReplicas()

public int getMaxUnavailableReplicas()

Absolute count of replicas allowed to be unavailable.

int32 max_unavailable_replicas = 3;

Returns
Type Description
int

The maxUnavailableReplicas.

getParserForType()

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

getPreviousDeployedModel()

public String getPreviousDeployedModel()

ID of the DeployedModel that this deployment should replace.

string previous_deployed_model = 1;

Returns
Type Description
String

The previousDeployedModel.

getPreviousDeployedModelBytes()

public ByteString getPreviousDeployedModelBytes()

ID of the DeployedModel that this deployment should replace.

string previous_deployed_model = 1;

Returns
Type Description
ByteString

The bytes for previousDeployedModel.

getRevisionNumber()

public int getRevisionNumber()

Output only. Read-only. Revision number determines the relative priority of DeployedModels in the same rollout. The DeployedModel with the largest revision number specifies the intended state of the deployment.

int32 revision_number = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The revisionNumber.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMaxSurgePercentage()

public boolean hasMaxSurgePercentage()

Percentage of allowed additional replicas. For autoscaling deployments, this refers to the target replica count.

int32 max_surge_percentage = 6;

Returns
Type Description
boolean

Whether the maxSurgePercentage field is set.

hasMaxSurgeReplicas()

public boolean hasMaxSurgeReplicas()

Absolute count of allowed additional replicas.

int32 max_surge_replicas = 5;

Returns
Type Description
boolean

Whether the maxSurgeReplicas field is set.

hasMaxUnavailablePercentage()

public boolean hasMaxUnavailablePercentage()

Percentage of replicas allowed to be unavailable. For autoscaling deployments, this refers to the target replica count.

int32 max_unavailable_percentage = 4;

Returns
Type Description
boolean

Whether the maxUnavailablePercentage field is set.

hasMaxUnavailableReplicas()

public boolean hasMaxUnavailableReplicas()

Absolute count of replicas allowed to be unavailable.

int32 max_unavailable_replicas = 3;

Returns
Type Description
boolean

Whether the maxUnavailableReplicas 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 RolloutOptions.Builder newBuilderForType()
Returns
Type Description
RolloutOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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