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 CacheKeyPolicyOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.CacheKeyPolicy) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * If true, requests to different hosts will be cached separately. 31 * </pre> 32 * 33 * <code>optional bool include_host = 486867679;</code> 34 * 35 * @return Whether the includeHost field is set. 36 */ hasIncludeHost()37 boolean hasIncludeHost(); 38 /** 39 * 40 * 41 * <pre> 42 * If true, requests to different hosts will be cached separately. 43 * </pre> 44 * 45 * <code>optional bool include_host = 486867679;</code> 46 * 47 * @return The includeHost. 48 */ getIncludeHost()49 boolean getIncludeHost(); 50 51 /** 52 * 53 * 54 * <pre> 55 * Allows HTTP request headers (by name) to be used in the cache key. 56 * </pre> 57 * 58 * <code>repeated string include_http_headers = 2489606;</code> 59 * 60 * @return A list containing the includeHttpHeaders. 61 */ getIncludeHttpHeadersList()62 java.util.List<java.lang.String> getIncludeHttpHeadersList(); 63 /** 64 * 65 * 66 * <pre> 67 * Allows HTTP request headers (by name) to be used in the cache key. 68 * </pre> 69 * 70 * <code>repeated string include_http_headers = 2489606;</code> 71 * 72 * @return The count of includeHttpHeaders. 73 */ getIncludeHttpHeadersCount()74 int getIncludeHttpHeadersCount(); 75 /** 76 * 77 * 78 * <pre> 79 * Allows HTTP request headers (by name) to be used in the cache key. 80 * </pre> 81 * 82 * <code>repeated string include_http_headers = 2489606;</code> 83 * 84 * @param index The index of the element to return. 85 * @return The includeHttpHeaders at the given index. 86 */ getIncludeHttpHeaders(int index)87 java.lang.String getIncludeHttpHeaders(int index); 88 /** 89 * 90 * 91 * <pre> 92 * Allows HTTP request headers (by name) to be used in the cache key. 93 * </pre> 94 * 95 * <code>repeated string include_http_headers = 2489606;</code> 96 * 97 * @param index The index of the value to return. 98 * @return The bytes of the includeHttpHeaders at the given index. 99 */ getIncludeHttpHeadersBytes(int index)100 com.google.protobuf.ByteString getIncludeHttpHeadersBytes(int index); 101 102 /** 103 * 104 * 105 * <pre> 106 * Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates. 107 * </pre> 108 * 109 * <code>repeated string include_named_cookies = 87316530;</code> 110 * 111 * @return A list containing the includeNamedCookies. 112 */ getIncludeNamedCookiesList()113 java.util.List<java.lang.String> getIncludeNamedCookiesList(); 114 /** 115 * 116 * 117 * <pre> 118 * Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates. 119 * </pre> 120 * 121 * <code>repeated string include_named_cookies = 87316530;</code> 122 * 123 * @return The count of includeNamedCookies. 124 */ getIncludeNamedCookiesCount()125 int getIncludeNamedCookiesCount(); 126 /** 127 * 128 * 129 * <pre> 130 * Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates. 131 * </pre> 132 * 133 * <code>repeated string include_named_cookies = 87316530;</code> 134 * 135 * @param index The index of the element to return. 136 * @return The includeNamedCookies at the given index. 137 */ getIncludeNamedCookies(int index)138 java.lang.String getIncludeNamedCookies(int index); 139 /** 140 * 141 * 142 * <pre> 143 * Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates. 144 * </pre> 145 * 146 * <code>repeated string include_named_cookies = 87316530;</code> 147 * 148 * @param index The index of the value to return. 149 * @return The bytes of the includeNamedCookies at the given index. 150 */ getIncludeNamedCookiesBytes(int index)151 com.google.protobuf.ByteString getIncludeNamedCookiesBytes(int index); 152 153 /** 154 * 155 * 156 * <pre> 157 * If true, http and https requests will be cached separately. 158 * </pre> 159 * 160 * <code>optional bool include_protocol = 303507535;</code> 161 * 162 * @return Whether the includeProtocol field is set. 163 */ hasIncludeProtocol()164 boolean hasIncludeProtocol(); 165 /** 166 * 167 * 168 * <pre> 169 * If true, http and https requests will be cached separately. 170 * </pre> 171 * 172 * <code>optional bool include_protocol = 303507535;</code> 173 * 174 * @return The includeProtocol. 175 */ getIncludeProtocol()176 boolean getIncludeProtocol(); 177 178 /** 179 * 180 * 181 * <pre> 182 * If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. 183 * </pre> 184 * 185 * <code>optional bool include_query_string = 474036639;</code> 186 * 187 * @return Whether the includeQueryString field is set. 188 */ hasIncludeQueryString()189 boolean hasIncludeQueryString(); 190 /** 191 * 192 * 193 * <pre> 194 * If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. 195 * </pre> 196 * 197 * <code>optional bool include_query_string = 474036639;</code> 198 * 199 * @return The includeQueryString. 200 */ getIncludeQueryString()201 boolean getIncludeQueryString(); 202 203 /** 204 * 205 * 206 * <pre> 207 * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 208 * </pre> 209 * 210 * <code>repeated string query_string_blacklist = 354964742;</code> 211 * 212 * @return A list containing the queryStringBlacklist. 213 */ getQueryStringBlacklistList()214 java.util.List<java.lang.String> getQueryStringBlacklistList(); 215 /** 216 * 217 * 218 * <pre> 219 * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 220 * </pre> 221 * 222 * <code>repeated string query_string_blacklist = 354964742;</code> 223 * 224 * @return The count of queryStringBlacklist. 225 */ getQueryStringBlacklistCount()226 int getQueryStringBlacklistCount(); 227 /** 228 * 229 * 230 * <pre> 231 * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 232 * </pre> 233 * 234 * <code>repeated string query_string_blacklist = 354964742;</code> 235 * 236 * @param index The index of the element to return. 237 * @return The queryStringBlacklist at the given index. 238 */ getQueryStringBlacklist(int index)239 java.lang.String getQueryStringBlacklist(int index); 240 /** 241 * 242 * 243 * <pre> 244 * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 245 * </pre> 246 * 247 * <code>repeated string query_string_blacklist = 354964742;</code> 248 * 249 * @param index The index of the value to return. 250 * @return The bytes of the queryStringBlacklist at the given index. 251 */ getQueryStringBlacklistBytes(int index)252 com.google.protobuf.ByteString getQueryStringBlacklistBytes(int index); 253 254 /** 255 * 256 * 257 * <pre> 258 * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 259 * </pre> 260 * 261 * <code>repeated string query_string_whitelist = 52456496;</code> 262 * 263 * @return A list containing the queryStringWhitelist. 264 */ getQueryStringWhitelistList()265 java.util.List<java.lang.String> getQueryStringWhitelistList(); 266 /** 267 * 268 * 269 * <pre> 270 * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 271 * </pre> 272 * 273 * <code>repeated string query_string_whitelist = 52456496;</code> 274 * 275 * @return The count of queryStringWhitelist. 276 */ getQueryStringWhitelistCount()277 int getQueryStringWhitelistCount(); 278 /** 279 * 280 * 281 * <pre> 282 * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 283 * </pre> 284 * 285 * <code>repeated string query_string_whitelist = 52456496;</code> 286 * 287 * @param index The index of the element to return. 288 * @return The queryStringWhitelist at the given index. 289 */ getQueryStringWhitelist(int index)290 java.lang.String getQueryStringWhitelist(int index); 291 /** 292 * 293 * 294 * <pre> 295 * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 296 * </pre> 297 * 298 * <code>repeated string query_string_whitelist = 52456496;</code> 299 * 300 * @param index The index of the value to return. 301 * @return The bytes of the queryStringWhitelist at the given index. 302 */ getQueryStringWhitelistBytes(int index)303 com.google.protobuf.ByteString getQueryStringWhitelistBytes(int index); 304 } 305