Class: Fastly::AclEntryApi
- Inherits:
-
Object
- Object
- Fastly::AclEntryApi
- Defined in:
- lib/fastly/api/acl_entry_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#bulk_update_acl_entries(opts = {}) ⇒ InlineResponse200
Update multiple ACL entries Update multiple ACL entries on the same ACL.
-
#bulk_update_acl_entries_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Update multiple ACL entries Update multiple ACL entries on the same ACL.
-
#create_acl_entry(opts = {}) ⇒ AclEntryResponse
Create an ACL entry Add an ACL entry to an ACL.
-
#create_acl_entry_with_http_info(opts = {}) ⇒ Array<(AclEntryResponse, Integer, Hash)>
Create an ACL entry Add an ACL entry to an ACL.
-
#delete_acl_entry(opts = {}) ⇒ InlineResponse200
Delete an ACL entry Delete an ACL entry from a specified ACL.
-
#delete_acl_entry_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Delete an ACL entry Delete an ACL entry from a specified ACL.
-
#get_acl_entry(opts = {}) ⇒ AclEntryResponse
Describe an ACL entry Retrieve a single ACL entry.
-
#get_acl_entry_with_http_info(opts = {}) ⇒ Array<(AclEntryResponse, Integer, Hash)>
Describe an ACL entry Retrieve a single ACL entry.
-
#initialize(api_client = ApiClient.default) ⇒ AclEntryApi
constructor
A new instance of AclEntryApi.
-
#list_acl_entries(opts = {}) ⇒ Array<AclEntryResponse>
List ACL entries List ACL entries for a specified ACL.
-
#list_acl_entries_with_http_info(opts = {}) ⇒ Array<(Array<AclEntryResponse>, Integer, Hash)>
List ACL entries List ACL entries for a specified ACL.
-
#update_acl_entry(opts = {}) ⇒ AclEntryResponse
Update an ACL entry Update an ACL entry for a specified ACL.
-
#update_acl_entry_with_http_info(opts = {}) ⇒ Array<(AclEntryResponse, Integer, Hash)>
Update an ACL entry Update an ACL entry for a specified ACL.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AclEntryApi
Returns a new instance of AclEntryApi.
17 18 19 |
# File 'lib/fastly/api/acl_entry_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/acl_entry_api.rb', line 15 def api_client @api_client end |
Instance Method Details
#bulk_update_acl_entries(opts = {}) ⇒ InlineResponse200
Update multiple ACL entries Update multiple ACL entries on the same ACL. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 entries. [Contact support](support.fastly.com/) to discuss raising this limit.
26 27 28 29 |
# File 'lib/fastly/api/acl_entry_api.rb', line 26 def bulk_update_acl_entries(opts = {}) data, _status_code, _headers = bulk_update_acl_entries_with_http_info(opts) data end |
#bulk_update_acl_entries_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Update multiple ACL entries Update multiple ACL entries on the same ACL. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 entries. [Contact support](support.fastly.com/) to discuss raising this limit.
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/acl_entry_api.rb', line 37 def bulk_update_acl_entries_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclEntryApi.bulk_update_acl_entries ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] acl_id = opts[:'acl_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 AclEntryApi.bulk_update_acl_entries" end # verify the required parameter 'acl_id' is set if @api_client.config.client_side_validation && acl_id.nil? fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.bulk_update_acl_entries" end # resource path local_var_path = '/service/{service_id}/acl/{acl_id}/entries'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_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/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'bulk_update_acl_entries_request']) # return_type return_type = opts[:debug_return_type] || 'InlineResponse200' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"AclEntryApi.bulk_update_acl_entries", :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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AclEntryApi#bulk_update_acl_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_acl_entry(opts = {}) ⇒ AclEntryResponse
Create an ACL entry Add an ACL entry to an ACL.
103 104 105 106 |
# File 'lib/fastly/api/acl_entry_api.rb', line 103 def create_acl_entry(opts = {}) data, _status_code, _headers = create_acl_entry_with_http_info(opts) data end |
#create_acl_entry_with_http_info(opts = {}) ⇒ Array<(AclEntryResponse, Integer, Hash)>
Create an ACL entry Add an ACL entry to an ACL.
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/acl_entry_api.rb', line 114 def create_acl_entry_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclEntryApi.create_acl_entry ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] acl_id = opts[:'acl_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 AclEntryApi.create_acl_entry" end # verify the required parameter 'acl_id' is set if @api_client.config.client_side_validation && acl_id.nil? fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.create_acl_entry" end # resource path local_var_path = '/service/{service_id}/acl/{acl_id}/entry'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_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/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'acl_entry']) # return_type return_type = opts[:debug_return_type] || 'AclEntryResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"AclEntryApi.create_acl_entry", :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: AclEntryApi#create_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_acl_entry(opts = {}) ⇒ InlineResponse200
Delete an ACL entry Delete an ACL entry from a specified ACL.
180 181 182 183 |
# File 'lib/fastly/api/acl_entry_api.rb', line 180 def delete_acl_entry(opts = {}) data, _status_code, _headers = delete_acl_entry_with_http_info(opts) data end |
#delete_acl_entry_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Delete an ACL entry Delete an ACL entry from a specified ACL.
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 243 244 245 246 247 248 249 |
# File 'lib/fastly/api/acl_entry_api.rb', line 191 def delete_acl_entry_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclEntryApi.delete_acl_entry ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] acl_id = opts[:'acl_id'] acl_entry_id = opts[:'acl_entry_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 AclEntryApi.delete_acl_entry" end # verify the required parameter 'acl_id' is set if @api_client.config.client_side_validation && acl_id.nil? fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.delete_acl_entry" end # verify the required parameter 'acl_entry_id' is set if @api_client.config.client_side_validation && acl_entry_id.nil? fail ArgumentError, "Missing the required parameter 'acl_entry_id' when calling AclEntryApi.delete_acl_entry" end # resource path local_var_path = '/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)).sub('{' + 'acl_entry_id' + '}', CGI.escape(acl_entry_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] || 'InlineResponse200' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"AclEntryApi.delete_acl_entry", :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: AclEntryApi#delete_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_acl_entry(opts = {}) ⇒ AclEntryResponse
Describe an ACL entry Retrieve a single ACL entry.
257 258 259 260 |
# File 'lib/fastly/api/acl_entry_api.rb', line 257 def get_acl_entry(opts = {}) data, _status_code, _headers = get_acl_entry_with_http_info(opts) data end |
#get_acl_entry_with_http_info(opts = {}) ⇒ Array<(AclEntryResponse, Integer, Hash)>
Describe an ACL entry Retrieve a single ACL entry.
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 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 |
# File 'lib/fastly/api/acl_entry_api.rb', line 268 def get_acl_entry_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclEntryApi.get_acl_entry ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] acl_id = opts[:'acl_id'] acl_entry_id = opts[:'acl_entry_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 AclEntryApi.get_acl_entry" end # verify the required parameter 'acl_id' is set if @api_client.config.client_side_validation && acl_id.nil? fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.get_acl_entry" end # verify the required parameter 'acl_entry_id' is set if @api_client.config.client_side_validation && acl_entry_id.nil? fail ArgumentError, "Missing the required parameter 'acl_entry_id' when calling AclEntryApi.get_acl_entry" end # resource path local_var_path = '/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)).sub('{' + 'acl_entry_id' + '}', CGI.escape(acl_entry_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] || 'AclEntryResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"AclEntryApi.get_acl_entry", :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: AclEntryApi#get_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_acl_entries(opts = {}) ⇒ Array<AclEntryResponse>
List ACL entries List ACL entries for a specified ACL.
337 338 339 340 |
# File 'lib/fastly/api/acl_entry_api.rb', line 337 def list_acl_entries(opts = {}) data, _status_code, _headers = list_acl_entries_with_http_info(opts) data end |
#list_acl_entries_with_http_info(opts = {}) ⇒ Array<(Array<AclEntryResponse>, Integer, Hash)>
List ACL entries List ACL entries for a specified ACL.
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/fastly/api/acl_entry_api.rb', line 351 def list_acl_entries_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclEntryApi.list_acl_entries ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] acl_id = opts[:'acl_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 AclEntryApi.list_acl_entries" end # verify the required parameter 'acl_id' is set if @api_client.config.client_side_validation && acl_id.nil? fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.list_acl_entries" end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AclEntryApi.list_acl_entries, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AclEntryApi.list_acl_entries, must be greater than or equal to 1.' end allowable_values = ["ascend", "descend"] if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction']) fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}" end # resource path local_var_path = '/service/{service_id}/acl/{acl_id}/entries'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil? # 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<AclEntryResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"AclEntryApi.list_acl_entries", :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: AclEntryApi#list_acl_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_acl_entry(opts = {}) ⇒ AclEntryResponse
Update an ACL entry Update an ACL entry for a specified ACL.
429 430 431 432 |
# File 'lib/fastly/api/acl_entry_api.rb', line 429 def update_acl_entry(opts = {}) data, _status_code, _headers = update_acl_entry_with_http_info(opts) data end |
#update_acl_entry_with_http_info(opts = {}) ⇒ Array<(AclEntryResponse, Integer, Hash)>
Update an ACL entry Update an ACL entry for a specified ACL.
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 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 |
# File 'lib/fastly/api/acl_entry_api.rb', line 441 def update_acl_entry_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclEntryApi.update_acl_entry ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] acl_id = opts[:'acl_id'] acl_entry_id = opts[:'acl_entry_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 AclEntryApi.update_acl_entry" end # verify the required parameter 'acl_id' is set if @api_client.config.client_side_validation && acl_id.nil? fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.update_acl_entry" end # verify the required parameter 'acl_entry_id' is set if @api_client.config.client_side_validation && acl_entry_id.nil? fail ArgumentError, "Missing the required parameter 'acl_entry_id' when calling AclEntryApi.update_acl_entry" end # resource path local_var_path = '/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)).sub('{' + 'acl_entry_id' + '}', CGI.escape(acl_entry_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/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'acl_entry']) # return_type return_type = opts[:debug_return_type] || 'AclEntryResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"AclEntryApi.update_acl_entry", :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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AclEntryApi#update_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |