Package com.google.cloud.compute.v1

Enum GRPCHealthCheck.PortSpecification

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<GRPCHealthCheck.PortSpecification>
    Enclosing class:
    GRPCHealthCheck
    public static enum GRPCHealthCheck.PortSpecification
extends Enum<GRPCHealthCheck.PortSpecification>
implements com.google.protobuf.ProtocolMessageEnum
     Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.
    Protobuf enum google.cloud.compute.v1.GRPCHealthCheck.PortSpecification

    • Enum Constant Detail

      • UNDEFINED_PORT_SPECIFICATION

        public static final GRPCHealthCheck.PortSpecification UNDEFINED_PORT_SPECIFICATION
         A value indicating that the enum field is not set.
        UNDEFINED_PORT_SPECIFICATION = 0;

      • USE_FIXED_PORT

        public static final GRPCHealthCheck.PortSpecification USE_FIXED_PORT
         The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
        USE_FIXED_PORT = 190235748;

      • USE_SERVING_PORT

        public static final GRPCHealthCheck.PortSpecification USE_SERVING_PORT
         For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.
        USE_SERVING_PORT = 362637516;

    • Field Detail

      • UNDEFINED_PORT_SPECIFICATION_VALUE

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

      • USE_FIXED_PORT_VALUE

        public static final int USE_FIXED_PORT_VALUE
         The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
        USE_FIXED_PORT = 190235748;
        See Also:
        Constant Field Values

      • USE_NAMED_PORT_VALUE

        public static final int USE_NAMED_PORT_VALUE
         Not supported.
        USE_NAMED_PORT = 349300671;
        See Also:
        Constant Field Values

      • USE_SERVING_PORT_VALUE

        public static final int USE_SERVING_PORT_VALUE
         For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.
        USE_SERVING_PORT = 362637516;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static GRPCHealthCheck.PortSpecification[] 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 (GRPCHealthCheck.PortSpecification c : GRPCHealthCheck.PortSpecification.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static GRPCHealthCheck.PortSpecification 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 GRPCHealthCheck.PortSpecification 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 GRPCHealthCheck.PortSpecification 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 GRPCHealthCheck.PortSpecification 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