Class: Fastly::RequestSettingsApi
- Inherits:
-
Object
- Object
- Fastly::RequestSettingsApi
- Defined in:
- lib/fastly/api/request_settings_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_request_settings(opts = {}) ⇒ InlineResponse200
Delete a Request Settings object Removes the specified Request Settings object.
-
#delete_request_settings_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Delete a Request Settings object Removes the specified Request Settings object.
-
#get_request_settings(opts = {}) ⇒ RequestSettingsResponse
Get a Request Settings object Gets the specified Request Settings object.
-
#get_request_settings_with_http_info(opts = {}) ⇒ Array<(RequestSettingsResponse, Integer, Hash)>
Get a Request Settings object Gets the specified Request Settings object.
-
#initialize(api_client = ApiClient.default) ⇒ RequestSettingsApi
constructor
A new instance of RequestSettingsApi.
-
#list_request_settings(opts = {}) ⇒ Array<RequestSettingsResponse>
List Request Settings objects Returns a list of all Request Settings objects for the given service and version.
-
#list_request_settings_with_http_info(opts = {}) ⇒ Array<(Array<RequestSettingsResponse>, Integer, Hash)>
List Request Settings objects Returns a list of all Request Settings objects for the given service and version.
-
#update_request_settings(opts = {}) ⇒ RequestSettingsResponse
Update a Request Settings object Updates the specified Request Settings object.
-
#update_request_settings_with_http_info(opts = {}) ⇒ Array<(RequestSettingsResponse, Integer, Hash)>
Update a Request Settings object Updates the specified Request Settings object.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ RequestSettingsApi
Returns a new instance of RequestSettingsApi.
17 18 19 |
# File 'lib/fastly/api/request_settings_api.rb', line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
15 16 17 |
# File 'lib/fastly/api/request_settings_api.rb', line 15 def api_client @api_client end |
Instance Method Details
#delete_request_settings(opts = {}) ⇒ InlineResponse200
Delete a Request Settings object Removes the specified Request Settings object.
26 27 28 29 |
# File 'lib/fastly/api/request_settings_api.rb', line 26 def delete_request_settings(opts = {}) data, _status_code, _headers = delete_request_settings_with_http_info(opts) data end |
#delete_request_settings_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Delete a Request Settings object Removes the specified Request Settings object.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 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 |
# File 'lib/fastly/api/request_settings_api.rb', line 37 def delete_request_settings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RequestSettingsApi.delete_request_settings ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] request_settings_name = opts[:'request_settings_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 RequestSettingsApi.delete_request_settings" 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 RequestSettingsApi.delete_request_settings" end # verify the required parameter 'request_settings_name' is set if @api_client.config.client_side_validation && request_settings_name.nil? fail ArgumentError, "Missing the required parameter 'request_settings_name' when calling RequestSettingsApi.delete_request_settings" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/request_settings/{request_settings_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'request_settings_name' + '}', CGI.escape(request_settings_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 => :"RequestSettingsApi.delete_request_settings", :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: RequestSettingsApi#delete_request_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_request_settings(opts = {}) ⇒ RequestSettingsResponse
Get a Request Settings object Gets the specified Request Settings object.
103 104 105 106 |
# File 'lib/fastly/api/request_settings_api.rb', line 103 def get_request_settings(opts = {}) data, _status_code, _headers = get_request_settings_with_http_info(opts) data end |
#get_request_settings_with_http_info(opts = {}) ⇒ Array<(RequestSettingsResponse, Integer, Hash)>
Get a Request Settings object Gets the specified Request Settings object.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/fastly/api/request_settings_api.rb', line 114 def get_request_settings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RequestSettingsApi.get_request_settings ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] request_settings_name = opts[:'request_settings_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 RequestSettingsApi.get_request_settings" 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 RequestSettingsApi.get_request_settings" end # verify the required parameter 'request_settings_name' is set if @api_client.config.client_side_validation && request_settings_name.nil? fail ArgumentError, "Missing the required parameter 'request_settings_name' when calling RequestSettingsApi.get_request_settings" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/request_settings/{request_settings_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'request_settings_name' + '}', CGI.escape(request_settings_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] || 'RequestSettingsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"RequestSettingsApi.get_request_settings", :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: RequestSettingsApi#get_request_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_request_settings(opts = {}) ⇒ Array<RequestSettingsResponse>
List Request Settings objects Returns a list of all Request Settings objects for the given service and version.
179 180 181 182 |
# File 'lib/fastly/api/request_settings_api.rb', line 179 def list_request_settings(opts = {}) data, _status_code, _headers = list_request_settings_with_http_info(opts) data end |
#list_request_settings_with_http_info(opts = {}) ⇒ Array<(Array<RequestSettingsResponse>, Integer, Hash)>
List Request Settings objects Returns a list of all Request Settings objects for the given service and version.
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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/fastly/api/request_settings_api.rb', line 189 def list_request_settings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RequestSettingsApi.list_request_settings ...' 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 RequestSettingsApi.list_request_settings" 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 RequestSettingsApi.list_request_settings" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/request_settings'.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<RequestSettingsResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"RequestSettingsApi.list_request_settings", :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: RequestSettingsApi#list_request_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_request_settings(opts = {}) ⇒ RequestSettingsResponse
Update a Request Settings object Updates the specified Request Settings object.
262 263 264 265 |
# File 'lib/fastly/api/request_settings_api.rb', line 262 def update_request_settings(opts = {}) data, _status_code, _headers = update_request_settings_with_http_info(opts) data end |
#update_request_settings_with_http_info(opts = {}) ⇒ Array<(RequestSettingsResponse, Integer, Hash)>
Update a Request Settings object Updates the specified Request Settings object.
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 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 362 363 364 365 366 367 368 |
# File 'lib/fastly/api/request_settings_api.rb', line 285 def update_request_settings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RequestSettingsApi.update_request_settings ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] request_settings_name = opts[:'request_settings_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 RequestSettingsApi.update_request_settings" 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 RequestSettingsApi.update_request_settings" end # verify the required parameter 'request_settings_name' is set if @api_client.config.client_side_validation && request_settings_name.nil? fail ArgumentError, "Missing the required parameter 'request_settings_name' when calling RequestSettingsApi.update_request_settings" end allowable_values = ["lookup", "pass"] 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 = ["clear", "leave", "append", "append_all", "overwrite"] if @api_client.config.client_side_validation && opts[:'xff'] && !allowable_values.include?(opts[:'xff']) fail ArgumentError, "invalid value for \"xff\", must be one of #{allowable_values}" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/request_settings/{request_settings_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'request_settings_name' + '}', CGI.escape(request_settings_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['bypass_busy_wait'] = opts[:'bypass_busy_wait'] if !opts[:'bypass_busy_wait'].nil? form_params['default_host'] = opts[:'default_host'] if !opts[:'default_host'].nil? form_params['force_miss'] = opts[:'force_miss'] if !opts[:'force_miss'].nil? form_params['force_ssl'] = opts[:'force_ssl'] if !opts[:'force_ssl'].nil? form_params['geo_headers'] = opts[:'geo_headers'] if !opts[:'geo_headers'].nil? form_params['hash_keys'] = opts[:'hash_keys'] if !opts[:'hash_keys'].nil? form_params['max_stale_age'] = opts[:'max_stale_age'] if !opts[:'max_stale_age'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? form_params['request_condition'] = opts[:'request_condition'] if !opts[:'request_condition'].nil? form_params['timer_support'] = opts[:'timer_support'] if !opts[:'timer_support'].nil? form_params['xff'] = opts[:'xff'] if !opts[:'xff'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'RequestSettingsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"RequestSettingsApi.update_request_settings", :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: RequestSettingsApi#update_request_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |