1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/compute/v1/compute.proto 18 19 package com.google.cloud.compute.v1; 20 21 public interface HTTPHealthCheckOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.HTTPHealthCheck) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest 31 * </pre> 32 * 33 * <code>optional string host = 3208616;</code> 34 * 35 * @return Whether the host field is set. 36 */ hasHost()37 boolean hasHost(); 38 /** 39 * 40 * 41 * <pre> 42 * The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest 43 * </pre> 44 * 45 * <code>optional string host = 3208616;</code> 46 * 47 * @return The host. 48 */ getHost()49 java.lang.String getHost(); 50 /** 51 * 52 * 53 * <pre> 54 * The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest 55 * </pre> 56 * 57 * <code>optional string host = 3208616;</code> 58 * 59 * @return The bytes for host. 60 */ getHostBytes()61 com.google.protobuf.ByteString getHostBytes(); 62 63 /** 64 * 65 * 66 * <pre> 67 * The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535. 68 * </pre> 69 * 70 * <code>optional int32 port = 3446913;</code> 71 * 72 * @return Whether the port field is set. 73 */ hasPort()74 boolean hasPort(); 75 /** 76 * 77 * 78 * <pre> 79 * The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535. 80 * </pre> 81 * 82 * <code>optional int32 port = 3446913;</code> 83 * 84 * @return The port. 85 */ getPort()86 int getPort(); 87 88 /** 89 * 90 * 91 * <pre> 92 * Not supported. 93 * </pre> 94 * 95 * <code>optional string port_name = 41534345;</code> 96 * 97 * @return Whether the portName field is set. 98 */ hasPortName()99 boolean hasPortName(); 100 /** 101 * 102 * 103 * <pre> 104 * Not supported. 105 * </pre> 106 * 107 * <code>optional string port_name = 41534345;</code> 108 * 109 * @return The portName. 110 */ getPortName()111 java.lang.String getPortName(); 112 /** 113 * 114 * 115 * <pre> 116 * Not supported. 117 * </pre> 118 * 119 * <code>optional string port_name = 41534345;</code> 120 * 121 * @return The bytes for portName. 122 */ getPortNameBytes()123 com.google.protobuf.ByteString getPortNameBytes(); 124 125 /** 126 * 127 * 128 * <pre> 129 * 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. Also supported in legacy HTTP health checks for 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. 130 * Check the PortSpecification enum for the list of possible values. 131 * </pre> 132 * 133 * <code>optional string port_specification = 51590597;</code> 134 * 135 * @return Whether the portSpecification field is set. 136 */ hasPortSpecification()137 boolean hasPortSpecification(); 138 /** 139 * 140 * 141 * <pre> 142 * 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. Also supported in legacy HTTP health checks for 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. 143 * Check the PortSpecification enum for the list of possible values. 144 * </pre> 145 * 146 * <code>optional string port_specification = 51590597;</code> 147 * 148 * @return The portSpecification. 149 */ getPortSpecification()150 java.lang.String getPortSpecification(); 151 /** 152 * 153 * 154 * <pre> 155 * 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. Also supported in legacy HTTP health checks for 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. 156 * Check the PortSpecification enum for the list of possible values. 157 * </pre> 158 * 159 * <code>optional string port_specification = 51590597;</code> 160 * 161 * @return The bytes for portSpecification. 162 */ getPortSpecificationBytes()163 com.google.protobuf.ByteString getPortSpecificationBytes(); 164 165 /** 166 * 167 * 168 * <pre> 169 * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 170 * Check the ProxyHeader enum for the list of possible values. 171 * </pre> 172 * 173 * <code>optional string proxy_header = 160374142;</code> 174 * 175 * @return Whether the proxyHeader field is set. 176 */ hasProxyHeader()177 boolean hasProxyHeader(); 178 /** 179 * 180 * 181 * <pre> 182 * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 183 * Check the ProxyHeader enum for the list of possible values. 184 * </pre> 185 * 186 * <code>optional string proxy_header = 160374142;</code> 187 * 188 * @return The proxyHeader. 189 */ getProxyHeader()190 java.lang.String getProxyHeader(); 191 /** 192 * 193 * 194 * <pre> 195 * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 196 * Check the ProxyHeader enum for the list of possible values. 197 * </pre> 198 * 199 * <code>optional string proxy_header = 160374142;</code> 200 * 201 * @return The bytes for proxyHeader. 202 */ getProxyHeaderBytes()203 com.google.protobuf.ByteString getProxyHeaderBytes(); 204 205 /** 206 * 207 * 208 * <pre> 209 * The request path of the HTTP health check request. The default value is /. 210 * </pre> 211 * 212 * <code>optional string request_path = 229403605;</code> 213 * 214 * @return Whether the requestPath field is set. 215 */ hasRequestPath()216 boolean hasRequestPath(); 217 /** 218 * 219 * 220 * <pre> 221 * The request path of the HTTP health check request. The default value is /. 222 * </pre> 223 * 224 * <code>optional string request_path = 229403605;</code> 225 * 226 * @return The requestPath. 227 */ getRequestPath()228 java.lang.String getRequestPath(); 229 /** 230 * 231 * 232 * <pre> 233 * The request path of the HTTP health check request. The default value is /. 234 * </pre> 235 * 236 * <code>optional string request_path = 229403605;</code> 237 * 238 * @return The bytes for requestPath. 239 */ getRequestPathBytes()240 com.google.protobuf.ByteString getRequestPathBytes(); 241 242 /** 243 * 244 * 245 * <pre> 246 * Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http 247 * </pre> 248 * 249 * <code>optional string response = 196547649;</code> 250 * 251 * @return Whether the response field is set. 252 */ hasResponse()253 boolean hasResponse(); 254 /** 255 * 256 * 257 * <pre> 258 * Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http 259 * </pre> 260 * 261 * <code>optional string response = 196547649;</code> 262 * 263 * @return The response. 264 */ getResponse()265 java.lang.String getResponse(); 266 /** 267 * 268 * 269 * <pre> 270 * Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http 271 * </pre> 272 * 273 * <code>optional string response = 196547649;</code> 274 * 275 * @return The bytes for response. 276 */ getResponseBytes()277 com.google.protobuf.ByteString getResponseBytes(); 278 } 279