Package com.google.cloud.compute.v1

Enum BackendService.SessionAffinity

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<BackendService.SessionAffinity>
    Enclosing class:
    BackendService
    public static enum BackendService.SessionAffinity
extends Enum<BackendService.SessionAffinity>
implements com.google.protobuf.ProtocolMessageEnum
     Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
    Protobuf enum google.cloud.compute.v1.BackendService.SessionAffinity

    • Enum Constant Detail

      • UNDEFINED_SESSION_AFFINITY

        public static final BackendService.SessionAffinity UNDEFINED_SESSION_AFFINITY
         A value indicating that the enum field is not set.
        UNDEFINED_SESSION_AFFINITY = 0;

      • CLIENT_IP

        public static final BackendService.SessionAffinity CLIENT_IP
         2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.
        CLIENT_IP = 345665051;

      • CLIENT_IP_NO_DESTINATION

        public static final BackendService.SessionAffinity CLIENT_IP_NO_DESTINATION
         1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.
        CLIENT_IP_NO_DESTINATION = 106122516;

      • CLIENT_IP_PORT_PROTO

        public static final BackendService.SessionAffinity CLIENT_IP_PORT_PROTO
         5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
        CLIENT_IP_PORT_PROTO = 221722926;

      • CLIENT_IP_PROTO

        public static final BackendService.SessionAffinity CLIENT_IP_PROTO
         3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
        CLIENT_IP_PROTO = 25322148;

      • GENERATED_COOKIE

        public static final BackendService.SessionAffinity GENERATED_COOKIE
         Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
        GENERATED_COOKIE = 370321204;

      • HEADER_FIELD

        public static final BackendService.SessionAffinity HEADER_FIELD
         The hash is based on a user specified header field.
        HEADER_FIELD = 200737960;

      • NONE

        public static final BackendService.SessionAffinity NONE
         No session affinity. Connections from the same client IP may go to any instance in the pool.
        NONE = 2402104;

    • Field Detail

      • UNDEFINED_SESSION_AFFINITY_VALUE

        public static final int UNDEFINED_SESSION_AFFINITY_VALUE
         A value indicating that the enum field is not set.
        UNDEFINED_SESSION_AFFINITY = 0;
        See Also:
        Constant Field Values

      • CLIENT_IP_VALUE

        public static final int CLIENT_IP_VALUE
         2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.
        CLIENT_IP = 345665051;
        See Also:
        Constant Field Values

      • CLIENT_IP_NO_DESTINATION_VALUE

        public static final int CLIENT_IP_NO_DESTINATION_VALUE
         1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.
        CLIENT_IP_NO_DESTINATION = 106122516;
        See Also:
        Constant Field Values

      • CLIENT_IP_PORT_PROTO_VALUE

        public static final int CLIENT_IP_PORT_PROTO_VALUE
         5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
        CLIENT_IP_PORT_PROTO = 221722926;
        See Also:
        Constant Field Values

      • CLIENT_IP_PROTO_VALUE

        public static final int CLIENT_IP_PROTO_VALUE
         3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
        CLIENT_IP_PROTO = 25322148;
        See Also:
        Constant Field Values

      • GENERATED_COOKIE_VALUE

        public static final int GENERATED_COOKIE_VALUE
         Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
        GENERATED_COOKIE = 370321204;
        See Also:
        Constant Field Values

      • HEADER_FIELD_VALUE

        public static final int HEADER_FIELD_VALUE
         The hash is based on a user specified header field.
        HEADER_FIELD = 200737960;
        See Also:
        Constant Field Values

      • HTTP_COOKIE_VALUE

        public static final int HTTP_COOKIE_VALUE
         The hash is based on a user provided cookie.
        HTTP_COOKIE = 494981627;
        See Also:
        Constant Field Values

      • NONE_VALUE

        public static final int NONE_VALUE
         No session affinity. Connections from the same client IP may go to any instance in the pool.
        NONE = 2402104;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static BackendService.SessionAffinity[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (BackendService.SessionAffinity c : BackendService.SessionAffinity.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BackendService.SessionAffinity valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static BackendService.SessionAffinity valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static BackendService.SessionAffinity forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

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

      • valueOf

        public static BackendService.SessionAffinity valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null