Package com.google.cloud.compute.v1

Class BackendServiceFailoverPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.BackendServiceFailoverPolicy
All Implemented Interfaces:
BackendServiceFailoverPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class BackendServiceFailoverPolicy extends com.google.protobuf.GeneratedMessage implements BackendServiceFailoverPolicyOrBuilder
 For load balancers that have configurable
 failover:
 [Internal passthrough Network Load
 Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
 and [external passthrough
 Network Load
 Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
 On failover or failback, this field indicates whether connection draining
 will be honored. Google Cloud has a fixed connection draining timeout of
 10 minutes. A setting of true terminates existing TCP
 connections to the active pool during failover and failback, immediately
 draining traffic. A setting of false allows existing TCP
 connections to persist, even on VMs no longer in the active pool, for up
 to the duration of the connection draining timeout (10 minutes).
Protobuf type google.cloud.compute.v1.BackendServiceFailoverPolicy
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BackendServiceFailoverPolicy.Builder
    For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DISABLE_CONNECTION_DRAIN_ON_FAILOVER_FIELD_NUMBER
     
    static final int
    DROP_TRAFFIC_IF_UNHEALTHY_FIELD_NUMBER
     
    static final int
    FAILOVER_RATIO_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static BackendServiceFailoverPolicy
    getDefaultInstance()
     
    BackendServiceFailoverPolicy
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDisableConnectionDrainOnFailover()
    This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
    boolean
    getDropTrafficIfUnhealthy()
    If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.
    float
    getFailoverRatio()
    The value of the field must be in the range[0, 1].
    com.google.protobuf.Parser<BackendServiceFailoverPolicy>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasDisableConnectionDrainOnFailover()
    This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
    boolean
    hasDropTrafficIfUnhealthy()
    If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.
    boolean
    hasFailoverRatio()
    The value of the field must be in the range[0, 1].
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BackendServiceFailoverPolicy.Builder
    newBuilder()
     
    static BackendServiceFailoverPolicy.Builder
    newBuilder(BackendServiceFailoverPolicy prototype)
     
    BackendServiceFailoverPolicy.Builder
    newBuilderForType()
     
    protected BackendServiceFailoverPolicy.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static BackendServiceFailoverPolicy
    parseDelimitedFrom(InputStream input)
     
    static BackendServiceFailoverPolicy
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackendServiceFailoverPolicy
    parseFrom(byte[] data)
     
    static BackendServiceFailoverPolicy
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackendServiceFailoverPolicy
    parseFrom(com.google.protobuf.ByteString data)
     
    static BackendServiceFailoverPolicy
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackendServiceFailoverPolicy
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BackendServiceFailoverPolicy
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackendServiceFailoverPolicy
    parseFrom(InputStream input)
     
    static BackendServiceFailoverPolicy
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BackendServiceFailoverPolicy
    parseFrom(ByteBuffer data)
     
    static BackendServiceFailoverPolicy
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BackendServiceFailoverPolicy>
    parser()
     
    BackendServiceFailoverPolicy.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • DISABLE_CONNECTION_DRAIN_ON_FAILOVER_FIELD_NUMBER

      public static final int DISABLE_CONNECTION_DRAIN_ON_FAILOVER_FIELD_NUMBER
      See Also:

    • DROP_TRAFFIC_IF_UNHEALTHY_FIELD_NUMBER

      public static final int DROP_TRAFFIC_IF_UNHEALTHY_FIELD_NUMBER
      See Also:

    • FAILOVER_RATIO_FIELD_NUMBER

      public static final int FAILOVER_RATIO_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasDisableConnectionDrainOnFailover

      public boolean hasDisableConnectionDrainOnFailover()
       This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.

 The default is false.
      optional bool disable_connection_drain_on_failover = 182150753;
      Specified by:
      hasDisableConnectionDrainOnFailover in interface BackendServiceFailoverPolicyOrBuilder
      Returns:
      Whether the disableConnectionDrainOnFailover field is set.

    • getDisableConnectionDrainOnFailover

      public boolean getDisableConnectionDrainOnFailover()
       This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.

 The default is false.
      optional bool disable_connection_drain_on_failover = 182150753;
      Specified by:
      getDisableConnectionDrainOnFailover in interface BackendServiceFailoverPolicyOrBuilder
      Returns:
      The disableConnectionDrainOnFailover.

    • hasDropTrafficIfUnhealthy

      public boolean hasDropTrafficIfUnhealthy()
       If set to true, connections to the
 load balancer are dropped when all primary and all backup backend VMs are
 unhealthy.If set to false, connections are distributed
 among all primary VMs when all primary and all backup backend VMs are
 unhealthy.
 For load balancers that have configurable
 failover:
 [Internal passthrough
 Network Load
 Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
 and [external passthrough
 Network Load
 Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
 The default is false.
      optional bool drop_traffic_if_unhealthy = 112289428;
      Specified by:
      hasDropTrafficIfUnhealthy in interface BackendServiceFailoverPolicyOrBuilder
      Returns:
      Whether the dropTrafficIfUnhealthy field is set.

    • getDropTrafficIfUnhealthy

      public boolean getDropTrafficIfUnhealthy()
       If set to true, connections to the
 load balancer are dropped when all primary and all backup backend VMs are
 unhealthy.If set to false, connections are distributed
 among all primary VMs when all primary and all backup backend VMs are
 unhealthy.
 For load balancers that have configurable
 failover:
 [Internal passthrough
 Network Load
 Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
 and [external passthrough
 Network Load
 Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
 The default is false.
      optional bool drop_traffic_if_unhealthy = 112289428;
      Specified by:
      getDropTrafficIfUnhealthy in interface BackendServiceFailoverPolicyOrBuilder
      Returns:
      The dropTrafficIfUnhealthy.

    • hasFailoverRatio

      public boolean hasFailoverRatio()
       The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a
 failover when the number of healthy primary VMs equals zero.
 For all other values, the load balancer performs a failover when the
 total number of healthy primary VMs is less than this ratio.
 For load balancers that have configurable
 failover:
 [Internal TCP/UDP Load
 Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
 and [external TCP/UDP Load
 Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
      optional float failover_ratio = 212667006;
      Specified by:
      hasFailoverRatio in interface BackendServiceFailoverPolicyOrBuilder
      Returns:
      Whether the failoverRatio field is set.

    • getFailoverRatio

      public float getFailoverRatio()
       The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a
 failover when the number of healthy primary VMs equals zero.
 For all other values, the load balancer performs a failover when the
 total number of healthy primary VMs is less than this ratio.
 For load balancers that have configurable
 failover:
 [Internal TCP/UDP Load
 Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
 and [external TCP/UDP Load
 Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
      optional float failover_ratio = 212667006;
      Specified by:
      getFailoverRatio in interface BackendServiceFailoverPolicyOrBuilder
      Returns:
      The failoverRatio.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 BackendServiceFailoverPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static BackendServiceFailoverPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static BackendServiceFailoverPolicy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BackendServiceFailoverPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BackendServiceFailoverPolicy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BackendServiceFailoverPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BackendServiceFailoverPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BackendServiceFailoverPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static BackendServiceFailoverPolicy.Builder newBuilder()

    • newBuilder

      public static BackendServiceFailoverPolicy.Builder newBuilder(BackendServiceFailoverPolicy prototype)

    • toBuilder

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

    • newBuilderForType

      protected BackendServiceFailoverPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BackendServiceFailoverPolicy getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BackendServiceFailoverPolicy> parser()

    • getParserForType

      public com.google.protobuf.Parser<BackendServiceFailoverPolicy> 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.GeneratedMessage

    • getDefaultInstanceForType

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