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 HttpRouteRuleOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.HttpRouteRule) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. 31 * </pre> 32 * 33 * <code>optional string description = 422937596;</code> 34 * 35 * @return Whether the description field is set. 36 */ hasDescription()37 boolean hasDescription(); 38 /** 39 * 40 * 41 * <pre> 42 * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. 43 * </pre> 44 * 45 * <code>optional string description = 422937596;</code> 46 * 47 * @return The description. 48 */ getDescription()49 java.lang.String getDescription(); 50 /** 51 * 52 * 53 * <pre> 54 * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. 55 * </pre> 56 * 57 * <code>optional string description = 422937596;</code> 58 * 59 * @return The bytes for description. 60 */ getDescriptionBytes()61 com.google.protobuf.ByteString getDescriptionBytes(); 62 63 /** 64 * 65 * 66 * <pre> 67 * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. 68 * </pre> 69 * 70 * <code>optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;</code> 71 * 72 * @return Whether the headerAction field is set. 73 */ hasHeaderAction()74 boolean hasHeaderAction(); 75 /** 76 * 77 * 78 * <pre> 79 * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. 80 * </pre> 81 * 82 * <code>optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;</code> 83 * 84 * @return The headerAction. 85 */ getHeaderAction()86 com.google.cloud.compute.v1.HttpHeaderAction getHeaderAction(); 87 /** 88 * 89 * 90 * <pre> 91 * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. 92 * </pre> 93 * 94 * <code>optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;</code> 95 */ getHeaderActionOrBuilder()96 com.google.cloud.compute.v1.HttpHeaderActionOrBuilder getHeaderActionOrBuilder(); 97 98 /** 99 * 100 * 101 * <pre> 102 * The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule. 103 * </pre> 104 * 105 * <code>repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;</code> 106 */ getMatchRulesList()107 java.util.List<com.google.cloud.compute.v1.HttpRouteRuleMatch> getMatchRulesList(); 108 /** 109 * 110 * 111 * <pre> 112 * The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule. 113 * </pre> 114 * 115 * <code>repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;</code> 116 */ getMatchRules(int index)117 com.google.cloud.compute.v1.HttpRouteRuleMatch getMatchRules(int index); 118 /** 119 * 120 * 121 * <pre> 122 * The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule. 123 * </pre> 124 * 125 * <code>repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;</code> 126 */ getMatchRulesCount()127 int getMatchRulesCount(); 128 /** 129 * 130 * 131 * <pre> 132 * The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule. 133 * </pre> 134 * 135 * <code>repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;</code> 136 */ 137 java.util.List<? extends com.google.cloud.compute.v1.HttpRouteRuleMatchOrBuilder> getMatchRulesOrBuilderList()138 getMatchRulesOrBuilderList(); 139 /** 140 * 141 * 142 * <pre> 143 * The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule. 144 * </pre> 145 * 146 * <code>repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;</code> 147 */ getMatchRulesOrBuilder(int index)148 com.google.cloud.compute.v1.HttpRouteRuleMatchOrBuilder getMatchRulesOrBuilder(int index); 149 150 /** 151 * 152 * 153 * <pre> 154 * For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules. 155 * </pre> 156 * 157 * <code>optional int32 priority = 445151652;</code> 158 * 159 * @return Whether the priority field is set. 160 */ hasPriority()161 boolean hasPriority(); 162 /** 163 * 164 * 165 * <pre> 166 * For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules. 167 * </pre> 168 * 169 * <code>optional int32 priority = 445151652;</code> 170 * 171 * @return The priority. 172 */ getPriority()173 int getPriority(); 174 175 /** 176 * 177 * 178 * <pre> 179 * In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction. 180 * </pre> 181 * 182 * <code>optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;</code> 183 * 184 * @return Whether the routeAction field is set. 185 */ hasRouteAction()186 boolean hasRouteAction(); 187 /** 188 * 189 * 190 * <pre> 191 * In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction. 192 * </pre> 193 * 194 * <code>optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;</code> 195 * 196 * @return The routeAction. 197 */ getRouteAction()198 com.google.cloud.compute.v1.HttpRouteAction getRouteAction(); 199 /** 200 * 201 * 202 * <pre> 203 * In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction. 204 * </pre> 205 * 206 * <code>optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;</code> 207 */ getRouteActionOrBuilder()208 com.google.cloud.compute.v1.HttpRouteActionOrBuilder getRouteActionOrBuilder(); 209 210 /** 211 * 212 * 213 * <pre> 214 * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 215 * </pre> 216 * 217 * <code>optional string service = 373540533;</code> 218 * 219 * @return Whether the service field is set. 220 */ hasService()221 boolean hasService(); 222 /** 223 * 224 * 225 * <pre> 226 * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 227 * </pre> 228 * 229 * <code>optional string service = 373540533;</code> 230 * 231 * @return The service. 232 */ getService()233 java.lang.String getService(); 234 /** 235 * 236 * 237 * <pre> 238 * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. 239 * </pre> 240 * 241 * <code>optional string service = 373540533;</code> 242 * 243 * @return The bytes for service. 244 */ getServiceBytes()245 com.google.protobuf.ByteString getServiceBytes(); 246 247 /** 248 * 249 * 250 * <pre> 251 * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. 252 * </pre> 253 * 254 * <code>optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;</code> 255 * 256 * @return Whether the urlRedirect field is set. 257 */ hasUrlRedirect()258 boolean hasUrlRedirect(); 259 /** 260 * 261 * 262 * <pre> 263 * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. 264 * </pre> 265 * 266 * <code>optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;</code> 267 * 268 * @return The urlRedirect. 269 */ getUrlRedirect()270 com.google.cloud.compute.v1.HttpRedirectAction getUrlRedirect(); 271 /** 272 * 273 * 274 * <pre> 275 * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. 276 * </pre> 277 * 278 * <code>optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;</code> 279 */ getUrlRedirectOrBuilder()280 com.google.cloud.compute.v1.HttpRedirectActionOrBuilder getUrlRedirectOrBuilder(); 281 } 282