Class Rollout.TrafficPercentStrategy (3.43.0) 

public static final class Rollout.TrafficPercentStrategy extends GeneratedMessageV3 implements Rollout.TrafficPercentStrategyOrBuilder

Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version.

One example of how to gradually rollout a new service configuration using this strategy: Day 1

 Rollout {
   id: "example.googleapis.com/rollout_20160206"
   traffic_percent_strategy {
     percentages: {
       "example.googleapis.com/20160201": 70.00
       "example.googleapis.com/20160206": 30.00
     }
   }
 }

Day 2

 Rollout {
   id: "example.googleapis.com/rollout_20160207"
   traffic_percent_strategy: {
     percentages: {
       "example.googleapis.com/20160206": 100.00
     }
   }
 }

Protobuf type google.api.servicemanagement.v1.Rollout.TrafficPercentStrategy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Rollout.TrafficPercentStrategy

Static Fields

PERCENTAGES_FIELD_NUMBER

public static final int PERCENTAGES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Rollout.TrafficPercentStrategy getDefaultInstance()
Returns
Type Description
Rollout.TrafficPercentStrategy

getDescriptor()

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

newBuilder()

public static Rollout.TrafficPercentStrategy.Builder newBuilder()
Returns
Type Description
Rollout.TrafficPercentStrategy.Builder

newBuilder(Rollout.TrafficPercentStrategy prototype)

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

parseDelimitedFrom(InputStream input)

public static Rollout.TrafficPercentStrategy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rollout.TrafficPercentStrategy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Rollout.TrafficPercentStrategy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Rollout.TrafficPercentStrategy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Rollout.TrafficPercentStrategy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Rollout.TrafficPercentStrategy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Rollout.TrafficPercentStrategy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rollout.TrafficPercentStrategy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Rollout.TrafficPercentStrategy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Rollout.TrafficPercentStrategy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Rollout.TrafficPercentStrategy> parser()
Returns
Type Description
Parser<TrafficPercentStrategy>

Methods

containsPercentages(String key)

public boolean containsPercentages(String key)

Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.

map<string, double> percentages = 1;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public Rollout.TrafficPercentStrategy getDefaultInstanceForType()
Returns
Type Description
Rollout.TrafficPercentStrategy

getParserForType()

public Parser<Rollout.TrafficPercentStrategy> getParserForType()
Returns
Type Description
Parser<TrafficPercentStrategy>
Overrides

getPercentages() (deprecated)

public Map<String,Double> getPercentages()

Use #getPercentagesMap() instead.

Returns
Type Description
Map<String,java.lang.Double>

getPercentagesCount()

public int getPercentagesCount()

Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.

map<string, double> percentages = 1;

Returns
Type Description
int

getPercentagesMap()

public Map<String,Double> getPercentagesMap()

Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.

map<string, double> percentages = 1;

Returns
Type Description
Map<String,java.lang.Double>

getPercentagesOrDefault(String key, double defaultValue)

public double getPercentagesOrDefault(String key, double defaultValue)

Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.

map<string, double> percentages = 1;

Parameters
Name Description
key String
defaultValue double
Returns
Type Description
double

getPercentagesOrThrow(String key)

public double getPercentagesOrThrow(String key)

Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.

map<string, double> percentages = 1;

Parameter
Name Description
key String
Returns
Type Description
double

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Rollout.TrafficPercentStrategy.Builder newBuilderForType()
Returns
Type Description
Rollout.TrafficPercentStrategy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Rollout.TrafficPercentStrategy.Builder toBuilder()
Returns
Type Description
Rollout.TrafficPercentStrategy.Builder

writeTo(CodedOutputStream output)

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