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 PathMatcherOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.PathMatcher) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction. 31 * </pre> 32 * 33 * <code>optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466; 34 * </code> 35 * 36 * @return Whether the defaultRouteAction field is set. 37 */ hasDefaultRouteAction()38 boolean hasDefaultRouteAction(); 39 /** 40 * 41 * 42 * <pre> 43 * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction. 44 * </pre> 45 * 46 * <code>optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466; 47 * </code> 48 * 49 * @return The defaultRouteAction. 50 */ getDefaultRouteAction()51 com.google.cloud.compute.v1.HttpRouteAction getDefaultRouteAction(); 52 /** 53 * 54 * 55 * <pre> 56 * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction. 57 * </pre> 58 * 59 * <code>optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466; 60 * </code> 61 */ getDefaultRouteActionOrBuilder()62 com.google.cloud.compute.v1.HttpRouteActionOrBuilder getDefaultRouteActionOrBuilder(); 63 64 /** 65 * 66 * 67 * <pre> 68 * The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use 69 * </pre> 70 * 71 * <code>optional string default_service = 370242231;</code> 72 * 73 * @return Whether the defaultService field is set. 74 */ hasDefaultService()75 boolean hasDefaultService(); 76 /** 77 * 78 * 79 * <pre> 80 * The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use 81 * </pre> 82 * 83 * <code>optional string default_service = 370242231;</code> 84 * 85 * @return The defaultService. 86 */ getDefaultService()87 java.lang.String getDefaultService(); 88 /** 89 * 90 * 91 * <pre> 92 * The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use 93 * </pre> 94 * 95 * <code>optional string default_service = 370242231;</code> 96 * 97 * @return The bytes for defaultService. 98 */ getDefaultServiceBytes()99 com.google.protobuf.ByteString getDefaultServiceBytes(); 100 101 /** 102 * 103 * 104 * <pre> 105 * When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. 106 * </pre> 107 * 108 * <code>optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338; 109 * </code> 110 * 111 * @return Whether the defaultUrlRedirect field is set. 112 */ hasDefaultUrlRedirect()113 boolean hasDefaultUrlRedirect(); 114 /** 115 * 116 * 117 * <pre> 118 * When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. 119 * </pre> 120 * 121 * <code>optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338; 122 * </code> 123 * 124 * @return The defaultUrlRedirect. 125 */ getDefaultUrlRedirect()126 com.google.cloud.compute.v1.HttpRedirectAction getDefaultUrlRedirect(); 127 /** 128 * 129 * 130 * <pre> 131 * When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. 132 * </pre> 133 * 134 * <code>optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338; 135 * </code> 136 */ getDefaultUrlRedirectOrBuilder()137 com.google.cloud.compute.v1.HttpRedirectActionOrBuilder getDefaultUrlRedirectOrBuilder(); 138 139 /** 140 * 141 * 142 * <pre> 143 * An optional description of this resource. Provide this property when you create the resource. 144 * </pre> 145 * 146 * <code>optional string description = 422937596;</code> 147 * 148 * @return Whether the description field is set. 149 */ hasDescription()150 boolean hasDescription(); 151 /** 152 * 153 * 154 * <pre> 155 * An optional description of this resource. Provide this property when you create the resource. 156 * </pre> 157 * 158 * <code>optional string description = 422937596;</code> 159 * 160 * @return The description. 161 */ getDescription()162 java.lang.String getDescription(); 163 /** 164 * 165 * 166 * <pre> 167 * An optional description of this resource. Provide this property when you create the resource. 168 * </pre> 169 * 170 * <code>optional string description = 422937596;</code> 171 * 172 * @return The bytes for description. 173 */ getDescriptionBytes()174 com.google.protobuf.ByteString getDescriptionBytes(); 175 176 /** 177 * 178 * 179 * <pre> 180 * Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 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. 181 * </pre> 182 * 183 * <code>optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;</code> 184 * 185 * @return Whether the headerAction field is set. 186 */ hasHeaderAction()187 boolean hasHeaderAction(); 188 /** 189 * 190 * 191 * <pre> 192 * Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 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. 193 * </pre> 194 * 195 * <code>optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;</code> 196 * 197 * @return The headerAction. 198 */ getHeaderAction()199 com.google.cloud.compute.v1.HttpHeaderAction getHeaderAction(); 200 /** 201 * 202 * 203 * <pre> 204 * Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap 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. 205 * </pre> 206 * 207 * <code>optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;</code> 208 */ getHeaderActionOrBuilder()209 com.google.cloud.compute.v1.HttpHeaderActionOrBuilder getHeaderActionOrBuilder(); 210 211 /** 212 * 213 * 214 * <pre> 215 * The name to which this PathMatcher is referred by the HostRule. 216 * </pre> 217 * 218 * <code>optional string name = 3373707;</code> 219 * 220 * @return Whether the name field is set. 221 */ hasName()222 boolean hasName(); 223 /** 224 * 225 * 226 * <pre> 227 * The name to which this PathMatcher is referred by the HostRule. 228 * </pre> 229 * 230 * <code>optional string name = 3373707;</code> 231 * 232 * @return The name. 233 */ getName()234 java.lang.String getName(); 235 /** 236 * 237 * 238 * <pre> 239 * The name to which this PathMatcher is referred by the HostRule. 240 * </pre> 241 * 242 * <code>optional string name = 3373707;</code> 243 * 244 * @return The bytes for name. 245 */ getNameBytes()246 com.google.protobuf.ByteString getNameBytes(); 247 248 /** 249 * 250 * 251 * <pre> 252 * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. 253 * </pre> 254 * 255 * <code>repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;</code> 256 */ getPathRulesList()257 java.util.List<com.google.cloud.compute.v1.PathRule> getPathRulesList(); 258 /** 259 * 260 * 261 * <pre> 262 * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. 263 * </pre> 264 * 265 * <code>repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;</code> 266 */ getPathRules(int index)267 com.google.cloud.compute.v1.PathRule getPathRules(int index); 268 /** 269 * 270 * 271 * <pre> 272 * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. 273 * </pre> 274 * 275 * <code>repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;</code> 276 */ getPathRulesCount()277 int getPathRulesCount(); 278 /** 279 * 280 * 281 * <pre> 282 * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. 283 * </pre> 284 * 285 * <code>repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;</code> 286 */ 287 java.util.List<? extends com.google.cloud.compute.v1.PathRuleOrBuilder> getPathRulesOrBuilderList()288 getPathRulesOrBuilderList(); 289 /** 290 * 291 * 292 * <pre> 293 * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. 294 * </pre> 295 * 296 * <code>repeated .google.cloud.compute.v1.PathRule path_rules = 104439901;</code> 297 */ getPathRulesOrBuilder(int index)298 com.google.cloud.compute.v1.PathRuleOrBuilder getPathRulesOrBuilder(int index); 299 300 /** 301 * 302 * 303 * <pre> 304 * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. 305 * </pre> 306 * 307 * <code>repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;</code> 308 */ getRouteRulesList()309 java.util.List<com.google.cloud.compute.v1.HttpRouteRule> getRouteRulesList(); 310 /** 311 * 312 * 313 * <pre> 314 * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. 315 * </pre> 316 * 317 * <code>repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;</code> 318 */ getRouteRules(int index)319 com.google.cloud.compute.v1.HttpRouteRule getRouteRules(int index); 320 /** 321 * 322 * 323 * <pre> 324 * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. 325 * </pre> 326 * 327 * <code>repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;</code> 328 */ getRouteRulesCount()329 int getRouteRulesCount(); 330 /** 331 * 332 * 333 * <pre> 334 * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. 335 * </pre> 336 * 337 * <code>repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;</code> 338 */ 339 java.util.List<? extends com.google.cloud.compute.v1.HttpRouteRuleOrBuilder> getRouteRulesOrBuilderList()340 getRouteRulesOrBuilderList(); 341 /** 342 * 343 * 344 * <pre> 345 * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. 346 * </pre> 347 * 348 * <code>repeated .google.cloud.compute.v1.HttpRouteRule route_rules = 376292225;</code> 349 */ getRouteRulesOrBuilder(int index)350 com.google.cloud.compute.v1.HttpRouteRuleOrBuilder getRouteRulesOrBuilder(int index); 351 } 352