Class RolloutControl (0.2.0)

public final class RolloutControl extends GeneratedMessageV3 implements RolloutControlOrBuilder

RolloutControl provides a way to request a change to the execution of a Rollout by pausing or canceling it.

Protobuf type google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutControl

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
Type Description
int

RUN_PARAMS_FIELD_NUMBER

public static final int RUN_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RolloutControl getDefaultInstance()
Returns
Type Description
RolloutControl

getDescriptor()

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

newBuilder()

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

newBuilder(RolloutControl prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAction()

public RolloutAction getAction()

Required. Action to be performed on the Rollout. The default behavior is to run the rollout until it naturally reaches a terminal state.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutAction action = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RolloutAction

The action.

getActionParamsCase()

public RolloutControl.ActionParamsCase getActionParamsCase()
Returns
Type Description
RolloutControl.ActionParamsCase

getActionValue()

public int getActionValue()

Required. Action to be performed on the Rollout. The default behavior is to run the rollout until it naturally reaches a terminal state.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutAction action = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for action.

getDefaultInstanceForType()

public RolloutControl getDefaultInstanceForType()
Returns
Type Description
RolloutControl

getParserForType()

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

getRunParams()

public RolloutControl.RunRolloutActionParams getRunParams()

Optional. Parameters for the RUN action. It is an error to specify this if the RolloutAction is not set to RUN. By default, the rollout will retry failed operations when resumed.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutControl.RunRolloutActionParams run_params = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RolloutControl.RunRolloutActionParams

The runParams.

getRunParamsOrBuilder()

public RolloutControl.RunRolloutActionParamsOrBuilder getRunParamsOrBuilder()

Optional. Parameters for the RUN action. It is an error to specify this if the RolloutAction is not set to RUN. By default, the rollout will retry failed operations when resumed.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutControl.RunRolloutActionParams run_params = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RolloutControl.RunRolloutActionParamsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasRunParams()

public boolean hasRunParams()

Optional. Parameters for the RUN action. It is an error to specify this if the RolloutAction is not set to RUN. By default, the rollout will retry failed operations when resumed.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutControl.RunRolloutActionParams run_params = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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