Package com.google.cloud.compute.v1

Interface GRPCHealthCheckOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GRPCHealthCheck, GRPCHealthCheck.Builder
@Generated public interface GRPCHealthCheckOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getGrpcServiceName()
    The gRPC service name for the health check.
    com.google.protobuf.ByteString
    getGrpcServiceNameBytes()
    The gRPC service name for the health check.
    int
    getPort()
    The TCP port number to which the health check prober sends packets.
    String
    getPortName()
    Not supported.
    com.google.protobuf.ByteString
    getPortNameBytes()
    Not supported.
    String
    getPortSpecification()
    Specifies how a port is selected for health checking.
    com.google.protobuf.ByteString
    getPortSpecificationBytes()
    Specifies how a port is selected for health checking.
    boolean
    hasGrpcServiceName()
    The gRPC service name for the health check.
    boolean
    hasPort()
    The TCP port number to which the health check prober sends packets.
    boolean
    hasPortName()
    Not supported.
    boolean
    hasPortSpecification()
    Specifies how a port is selected for health checking.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasGrpcServiceName

      boolean hasGrpcServiceName()
       The gRPC service name for the health check. This field is optional. The
 value of grpc_service_name has the following meanings by convention:

 - Empty service_name means the overall status of all services at the
 backend.

 - Non-empty service_name means the health of that gRPC service, as defined
 by the owner of the service.

 The grpc_service_name can only be ASCII.
      optional string grpc_service_name = 136533078;
      Returns:
      Whether the grpcServiceName field is set.

    • getGrpcServiceName

      String getGrpcServiceName()
       The gRPC service name for the health check. This field is optional. The
 value of grpc_service_name has the following meanings by convention:

 - Empty service_name means the overall status of all services at the
 backend.

 - Non-empty service_name means the health of that gRPC service, as defined
 by the owner of the service.

 The grpc_service_name can only be ASCII.
      optional string grpc_service_name = 136533078;
      Returns:
      The grpcServiceName.

    • getGrpcServiceNameBytes

      com.google.protobuf.ByteString getGrpcServiceNameBytes()
       The gRPC service name for the health check. This field is optional. The
 value of grpc_service_name has the following meanings by convention:

 - Empty service_name means the overall status of all services at the
 backend.

 - Non-empty service_name means the health of that gRPC service, as defined
 by the owner of the service.

 The grpc_service_name can only be ASCII.
      optional string grpc_service_name = 136533078;
      Returns:
      The bytes for grpcServiceName.

    • hasPort

      boolean hasPort()
       The TCP port number to which the health check prober sends packets. Valid
 values are 1 through 65535.
      optional int32 port = 3446913;
      Returns:
      Whether the port field is set.

    • getPort

      int getPort()
       The TCP port number to which the health check prober sends packets. Valid
 values are 1 through 65535.
      optional int32 port = 3446913;
      Returns:
      The port.

    • hasPortName

      boolean hasPortName()
       Not supported.
      optional string port_name = 41534345;
      Returns:
      Whether the portName field is set.

    • getPortName

      String getPortName()
       Not supported.
      optional string port_name = 41534345;
      Returns:
      The portName.

    • getPortNameBytes

      com.google.protobuf.ByteString getPortNameBytes()
       Not supported.
      optional string port_name = 41534345;
      Returns:
      The bytes for portName.

    • hasPortSpecification

      boolean hasPortSpecification()
       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 theport field  in the health check. Supported by backend services
 for passthrough 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 passthrough 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.
 Check the PortSpecification enum for the list of possible values.
      optional string port_specification = 51590597;
      Returns:
      Whether the portSpecification field is set.

    • getPortSpecification

      String getPortSpecification()
       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 theport field  in the health check. Supported by backend services
 for passthrough 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 passthrough 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.
 Check the PortSpecification enum for the list of possible values.
      optional string port_specification = 51590597;
      Returns:
      The portSpecification.

    • getPortSpecificationBytes

      com.google.protobuf.ByteString getPortSpecificationBytes()
       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 theport field  in the health check. Supported by backend services
 for passthrough 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 passthrough 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.
 Check the PortSpecification enum for the list of possible values.
      optional string port_specification = 51590597;
      Returns:
      The bytes for portSpecification.