Class TrafficSplit

  • All Implemented Interfaces:
    TrafficSplitOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class TrafficSplit
    extends com.google.protobuf.GeneratedMessageV3
    implements TrafficSplitOrBuilder
     Traffic routing configuration for versions within a single service. Traffic
     splits define how traffic directed to the service is assigned to versions.
     
    Protobuf type google.appengine.v1.TrafficSplit
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TrafficSplit.Builder
      Traffic routing configuration for versions within a single service.
      static class  TrafficSplit.ShardBy
      Available sharding mechanisms.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALLOCATIONS_FIELD_NUMBER  
      static int SHARD_BY_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getShardByValue

        public int getShardByValue()
         Mechanism used to determine which version a request is sent to.
         The traffic selection algorithm will
         be stable for either type until allocations are changed.
         
        .google.appengine.v1.TrafficSplit.ShardBy shard_by = 1;
        Specified by:
        getShardByValue in interface TrafficSplitOrBuilder
        Returns:
        The enum numeric value on the wire for shardBy.
      • getShardBy

        public TrafficSplit.ShardBy getShardBy()
         Mechanism used to determine which version a request is sent to.
         The traffic selection algorithm will
         be stable for either type until allocations are changed.
         
        .google.appengine.v1.TrafficSplit.ShardBy shard_by = 1;
        Specified by:
        getShardBy in interface TrafficSplitOrBuilder
        Returns:
        The shardBy.
      • getAllocationsCount

        public int getAllocationsCount()
        Description copied from interface: TrafficSplitOrBuilder
         Mapping from version IDs within the service to fractional
         (0.000, 1] allocations of traffic for that version. Each version can
         be specified only once, but some versions in the service may not
         have any traffic allocation. Services that have traffic allocated
         cannot be deleted until either the service is deleted or
         their traffic allocation is removed. Allocations must sum to 1.
         Up to two decimal place precision is supported for IP-based splits and
         up to three decimal places is supported for cookie-based splits.
         
        map<string, double> allocations = 2;
        Specified by:
        getAllocationsCount in interface TrafficSplitOrBuilder
      • containsAllocations

        public boolean containsAllocations​(String key)
         Mapping from version IDs within the service to fractional
         (0.000, 1] allocations of traffic for that version. Each version can
         be specified only once, but some versions in the service may not
         have any traffic allocation. Services that have traffic allocated
         cannot be deleted until either the service is deleted or
         their traffic allocation is removed. Allocations must sum to 1.
         Up to two decimal place precision is supported for IP-based splits and
         up to three decimal places is supported for cookie-based splits.
         
        map<string, double> allocations = 2;
        Specified by:
        containsAllocations in interface TrafficSplitOrBuilder
      • getAllocationsMap

        public Map<String,​Double> getAllocationsMap()
         Mapping from version IDs within the service to fractional
         (0.000, 1] allocations of traffic for that version. Each version can
         be specified only once, but some versions in the service may not
         have any traffic allocation. Services that have traffic allocated
         cannot be deleted until either the service is deleted or
         their traffic allocation is removed. Allocations must sum to 1.
         Up to two decimal place precision is supported for IP-based splits and
         up to three decimal places is supported for cookie-based splits.
         
        map<string, double> allocations = 2;
        Specified by:
        getAllocationsMap in interface TrafficSplitOrBuilder
      • getAllocationsOrDefault

        public double getAllocationsOrDefault​(String key,
                                              double defaultValue)
         Mapping from version IDs within the service to fractional
         (0.000, 1] allocations of traffic for that version. Each version can
         be specified only once, but some versions in the service may not
         have any traffic allocation. Services that have traffic allocated
         cannot be deleted until either the service is deleted or
         their traffic allocation is removed. Allocations must sum to 1.
         Up to two decimal place precision is supported for IP-based splits and
         up to three decimal places is supported for cookie-based splits.
         
        map<string, double> allocations = 2;
        Specified by:
        getAllocationsOrDefault in interface TrafficSplitOrBuilder
      • getAllocationsOrThrow

        public double getAllocationsOrThrow​(String key)
         Mapping from version IDs within the service to fractional
         (0.000, 1] allocations of traffic for that version. Each version can
         be specified only once, but some versions in the service may not
         have any traffic allocation. Services that have traffic allocated
         cannot be deleted until either the service is deleted or
         their traffic allocation is removed. Allocations must sum to 1.
         Up to two decimal place precision is supported for IP-based splits and
         up to three decimal places is supported for cookie-based splits.
         
        map<string, double> allocations = 2;
        Specified by:
        getAllocationsOrThrow in interface TrafficSplitOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static TrafficSplit parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TrafficSplit parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TrafficSplit parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TrafficSplit parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TrafficSplit parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TrafficSplit parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TrafficSplit parseFrom​(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException
        Throws:
        IOException
      • newBuilderForType

        public TrafficSplit.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public TrafficSplit.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected TrafficSplit.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static TrafficSplit getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<TrafficSplit> parser()
      • getParserForType

        public com.google.protobuf.Parser<TrafficSplit> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public TrafficSplit getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder