Class: Fastly::HeaderApi
- Inherits:
-
Object
- Object
- Fastly::HeaderApi
- Defined in:
- lib/fastly/api/header_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_header_object(opts = {}) ⇒ HeaderResponse
Create a Header object Creates a new Header object.
-
#create_header_object_with_http_info(opts = {}) ⇒ Array<(HeaderResponse, Integer, Hash)>
Create a Header object Creates a new Header object.
-
#delete_header_object(opts = {}) ⇒ InlineResponse200
Delete a Header object Deletes a Header object by name.
-
#delete_header_object_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Delete a Header object Deletes a Header object by name.
-
#get_header_object(opts = {}) ⇒ HeaderResponse
Get a Header object Retrieves a Header object by name.
-
#get_header_object_with_http_info(opts = {}) ⇒ Array<(HeaderResponse, Integer, Hash)>
Get a Header object Retrieves a Header object by name.
-
#initialize(api_client = ApiClient.default) ⇒ HeaderApi
constructor
A new instance of HeaderApi.
-
#list_header_objects(opts = {}) ⇒ Array<HeaderResponse>
List Header objects Retrieves all Header objects for a particular Version of a Service.
-
#list_header_objects_with_http_info(opts = {}) ⇒ Array<(Array<HeaderResponse>, Integer, Hash)>
List Header objects Retrieves all Header objects for a particular Version of a Service.
-
#update_header_object(opts = {}) ⇒ HeaderResponse
Update a Header object Modifies an existing Header object by name.
-
#update_header_object_with_http_info(opts = {}) ⇒ Array<(HeaderResponse, Integer, Hash)>
Update a Header object Modifies an existing Header object by name.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
15 16 17 |
# File 'lib/fastly/api/header_api.rb', line 15 def api_client @api_client end |
Instance Method Details
#create_header_object(opts = {}) ⇒ HeaderResponse
Create a Header object Creates a new Header object.
37 38 39 40 |
# File 'lib/fastly/api/header_api.rb', line 37 def create_header_object(opts = {}) data, _status_code, _headers = create_header_object_with_http_info(opts) data end |
#create_header_object_with_http_info(opts = {}) ⇒ Array<(HeaderResponse, Integer, Hash)>
Create a Header object Creates a new Header object.
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/fastly/api/header_api.rb', line 59 def create_header_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeaderApi.create_header_object ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling HeaderApi.create_header_object" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling HeaderApi.create_header_object" end allowable_values = ["set", "append", "delete", "regex", "regex_repeat"] if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action']) fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}" end allowable_values = ["request", "cache", "response"] if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type']) fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/header'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} form_params['action'] = opts[:'action'] if !opts[:'action'].nil? form_params['cache_condition'] = opts[:'cache_condition'] if !opts[:'cache_condition'].nil? form_params['dst'] = opts[:'dst'] if !opts[:'dst'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? form_params['regex'] = opts[:'regex'] if !opts[:'regex'].nil? form_params['request_condition'] = opts[:'request_condition'] if !opts[:'request_condition'].nil? form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil? form_params['src'] = opts[:'src'] if !opts[:'src'].nil? form_params['substitution'] = opts[:'substitution'] if !opts[:'substitution'].nil? form_params['type'] = opts[:'type'] if !opts[:'type'].nil? form_params['ignore_if_set'] = opts[:'ignore_if_set'] if !opts[:'ignore_if_set'].nil? form_params['priority'] = opts[:'priority'] if !opts[:'priority'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'HeaderResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"HeaderApi.create_header_object", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: HeaderApi#create_header_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_header_object(opts = {}) ⇒ InlineResponse200
Delete a Header object Deletes a Header object by name.
145 146 147 148 |
# File 'lib/fastly/api/header_api.rb', line 145 def delete_header_object(opts = {}) data, _status_code, _headers = delete_header_object_with_http_info(opts) data end |
#delete_header_object_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Delete a Header object Deletes a Header object by name.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/fastly/api/header_api.rb', line 156 def delete_header_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeaderApi.delete_header_object ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] header_name = opts[:'header_name'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling HeaderApi.delete_header_object" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling HeaderApi.delete_header_object" end # verify the required parameter 'header_name' is set if @api_client.config.client_side_validation && header_name.nil? fail ArgumentError, "Missing the required parameter 'header_name' when calling HeaderApi.delete_header_object" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/header/{header_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'header_name' + '}', CGI.escape(header_name.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InlineResponse200' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"HeaderApi.delete_header_object", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: HeaderApi#delete_header_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_header_object(opts = {}) ⇒ HeaderResponse
Get a Header object Retrieves a Header object by name.
222 223 224 225 |
# File 'lib/fastly/api/header_api.rb', line 222 def get_header_object(opts = {}) data, _status_code, _headers = get_header_object_with_http_info(opts) data end |
#get_header_object_with_http_info(opts = {}) ⇒ Array<(HeaderResponse, Integer, Hash)>
Get a Header object Retrieves a Header object by name.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/fastly/api/header_api.rb', line 233 def get_header_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeaderApi.get_header_object ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] header_name = opts[:'header_name'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling HeaderApi.get_header_object" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling HeaderApi.get_header_object" end # verify the required parameter 'header_name' is set if @api_client.config.client_side_validation && header_name.nil? fail ArgumentError, "Missing the required parameter 'header_name' when calling HeaderApi.get_header_object" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/header/{header_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'header_name' + '}', CGI.escape(header_name.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'HeaderResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"HeaderApi.get_header_object", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: HeaderApi#get_header_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_header_objects(opts = {}) ⇒ Array<HeaderResponse>
List Header objects Retrieves all Header objects for a particular Version of a Service.
298 299 300 301 |
# File 'lib/fastly/api/header_api.rb', line 298 def list_header_objects(opts = {}) data, _status_code, _headers = list_header_objects_with_http_info(opts) data end |
#list_header_objects_with_http_info(opts = {}) ⇒ Array<(Array<HeaderResponse>, Integer, Hash)>
List Header objects Retrieves all Header objects for a particular Version of a Service.
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/fastly/api/header_api.rb', line 308 def list_header_objects_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeaderApi.list_header_objects ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling HeaderApi.list_header_objects" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling HeaderApi.list_header_objects" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/header'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<HeaderResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"HeaderApi.list_header_objects", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: HeaderApi#list_header_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_header_object(opts = {}) ⇒ HeaderResponse
Update a Header object Modifies an existing Header object by name.
381 382 383 384 |
# File 'lib/fastly/api/header_api.rb', line 381 def update_header_object(opts = {}) data, _status_code, _headers = update_header_object_with_http_info(opts) data end |
#update_header_object_with_http_info(opts = {}) ⇒ Array<(HeaderResponse, Integer, Hash)>
Update a Header object Modifies an existing Header object by name.
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 |
# File 'lib/fastly/api/header_api.rb', line 404 def update_header_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeaderApi.update_header_object ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] header_name = opts[:'header_name'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling HeaderApi.update_header_object" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling HeaderApi.update_header_object" end # verify the required parameter 'header_name' is set if @api_client.config.client_side_validation && header_name.nil? fail ArgumentError, "Missing the required parameter 'header_name' when calling HeaderApi.update_header_object" end allowable_values = ["set", "append", "delete", "regex", "regex_repeat"] if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action']) fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}" end allowable_values = ["request", "cache", "response"] if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type']) fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/header/{header_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'header_name' + '}', CGI.escape(header_name.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} form_params['action'] = opts[:'action'] if !opts[:'action'].nil? form_params['cache_condition'] = opts[:'cache_condition'] if !opts[:'cache_condition'].nil? form_params['dst'] = opts[:'dst'] if !opts[:'dst'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? form_params['regex'] = opts[:'regex'] if !opts[:'regex'].nil? form_params['request_condition'] = opts[:'request_condition'] if !opts[:'request_condition'].nil? form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil? form_params['src'] = opts[:'src'] if !opts[:'src'].nil? form_params['substitution'] = opts[:'substitution'] if !opts[:'substitution'].nil? form_params['type'] = opts[:'type'] if !opts[:'type'].nil? form_params['ignore_if_set'] = opts[:'ignore_if_set'] if !opts[:'ignore_if_set'].nil? form_params['priority'] = opts[:'priority'] if !opts[:'priority'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'HeaderResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"HeaderApi.update_header_object", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: HeaderApi#update_header_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |