Class Rollout (3.37.0)

public final class Rollout extends GeneratedMessageV3 implements RolloutOrBuilder

A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config.

Protobuf type google.api.servicemanagement.v1.Rollout

Implements

RolloutOrBuilder

Static Fields

CREATED_BY_FIELD_NUMBER

public static final int CREATED_BY_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DELETE_SERVICE_STRATEGY_FIELD_NUMBER

public static final int DELETE_SERVICE_STRATEGY_FIELD_NUMBER
Field Value
TypeDescription
int

ROLLOUT_ID_FIELD_NUMBER

public static final int ROLLOUT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_NAME_FIELD_NUMBER

public static final int SERVICE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

TRAFFIC_PERCENT_STRATEGY_FIELD_NUMBER

public static final int TRAFFIC_PERCENT_STRATEGY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Rollout getDefaultInstance()
Returns
TypeDescription
Rollout

getDescriptor()

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

newBuilder()

public static Rollout.Builder newBuilder()
Returns
TypeDescription
Rollout.Builder

newBuilder(Rollout prototype)

public static Rollout.Builder newBuilder(Rollout prototype)
Parameter
NameDescription
prototypeRollout
Returns
TypeDescription
Rollout.Builder

parseDelimitedFrom(InputStream input)

public static Rollout parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rollout parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Rollout parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rollout parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rollout parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rollout parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rollout parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rollout parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Rollout parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rollout parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Rollout parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rollout parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Rollout> parser()
Returns
TypeDescription
Parser<Rollout>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Creation time of the rollout. Readonly.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Creation time of the rollout. Readonly.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getCreatedBy()

public String getCreatedBy()

The user who created the Rollout. Readonly.

string created_by = 3;

Returns
TypeDescription
String

The createdBy.

getCreatedByBytes()

public ByteString getCreatedByBytes()

The user who created the Rollout. Readonly.

string created_by = 3;

Returns
TypeDescription
ByteString

The bytes for createdBy.

getDefaultInstanceForType()

public Rollout getDefaultInstanceForType()
Returns
TypeDescription
Rollout

getDeleteServiceStrategy()

public Rollout.DeleteServiceStrategy getDeleteServiceStrategy()

The strategy associated with a rollout to delete a ManagedService. Readonly.

.google.api.servicemanagement.v1.Rollout.DeleteServiceStrategy delete_service_strategy = 200;

Returns
TypeDescription
Rollout.DeleteServiceStrategy

The deleteServiceStrategy.

getDeleteServiceStrategyOrBuilder()

public Rollout.DeleteServiceStrategyOrBuilder getDeleteServiceStrategyOrBuilder()

The strategy associated with a rollout to delete a ManagedService. Readonly.

.google.api.servicemanagement.v1.Rollout.DeleteServiceStrategy delete_service_strategy = 200;

Returns
TypeDescription
Rollout.DeleteServiceStrategyOrBuilder

getParserForType()

public Parser<Rollout> getParserForType()
Returns
TypeDescription
Parser<Rollout>
Overrides

getRolloutId()

public String getRolloutId()

Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed.

If not specified by client, the server will generate one. The generated id will have the form of <date><revision number>, where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'

string rollout_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The rolloutId.

getRolloutIdBytes()

public ByteString getRolloutIdBytes()

Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed.

If not specified by client, the server will generate one. The generated id will have the form of <date><revision number>, where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'

string rollout_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for rolloutId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceName()

public String getServiceName()

The name of the service associated with this Rollout.

string service_name = 8;

Returns
TypeDescription
String

The serviceName.

getServiceNameBytes()

public ByteString getServiceNameBytes()

The name of the service associated with this Rollout.

string service_name = 8;

Returns
TypeDescription
ByteString

The bytes for serviceName.

getStatus()

public Rollout.RolloutStatus getStatus()

The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.

.google.api.servicemanagement.v1.Rollout.RolloutStatus status = 4;

Returns
TypeDescription
Rollout.RolloutStatus

The status.

getStatusValue()

public int getStatusValue()

The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.

.google.api.servicemanagement.v1.Rollout.RolloutStatus status = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for status.

getStrategyCase()

public Rollout.StrategyCase getStrategyCase()
Returns
TypeDescription
Rollout.StrategyCase

getTrafficPercentStrategy()

public Rollout.TrafficPercentStrategy getTrafficPercentStrategy()

Google Service Control selects service configurations based on traffic percentage.

.google.api.servicemanagement.v1.Rollout.TrafficPercentStrategy traffic_percent_strategy = 5;

Returns
TypeDescription
Rollout.TrafficPercentStrategy

The trafficPercentStrategy.

getTrafficPercentStrategyOrBuilder()

public Rollout.TrafficPercentStrategyOrBuilder getTrafficPercentStrategyOrBuilder()

Google Service Control selects service configurations based on traffic percentage.

.google.api.servicemanagement.v1.Rollout.TrafficPercentStrategy traffic_percent_strategy = 5;

Returns
TypeDescription
Rollout.TrafficPercentStrategyOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Creation time of the rollout. Readonly.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDeleteServiceStrategy()

public boolean hasDeleteServiceStrategy()

The strategy associated with a rollout to delete a ManagedService. Readonly.

.google.api.servicemanagement.v1.Rollout.DeleteServiceStrategy delete_service_strategy = 200;

Returns
TypeDescription
boolean

Whether the deleteServiceStrategy field is set.

hasTrafficPercentStrategy()

public boolean hasTrafficPercentStrategy()

Google Service Control selects service configurations based on traffic percentage.

.google.api.servicemanagement.v1.Rollout.TrafficPercentStrategy traffic_percent_strategy = 5;

Returns
TypeDescription
boolean

Whether the trafficPercentStrategy field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Rollout.Builder newBuilderForType()
Returns
TypeDescription
Rollout.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rollout.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Rollout.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Rollout.Builder toBuilder()
Returns
TypeDescription
Rollout.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException