Class: DatadogAPIClient::V2::ContainerImagesAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::ContainerImagesAPI
- Defined in:
- lib/datadog_api_client/v2/api/container_images_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ ContainerImagesAPI
constructor
A new instance of ContainerImagesAPI.
-
#list_container_images(opts = {}) ⇒ Object
Get all Container Images.
-
#list_container_images_with_http_info(opts = {}) ⇒ Array<(ContainerImagesResponse, Integer, Hash)>
Get all Container Images.
-
#list_container_images_with_pagination(opts = {}) {|ContainerImageItem| ... } ⇒ Object
Get all Container Images.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ ContainerImagesAPI
Returns a new instance of ContainerImagesAPI.
22 23 24 |
# File 'lib/datadog_api_client/v2/api/container_images_api.rb', line 22 def initialize(api_client = DatadogAPIClient::APIClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
20 21 22 |
# File 'lib/datadog_api_client/v2/api/container_images_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#list_container_images(opts = {}) ⇒ Object
Get all Container Images.
29 30 31 32 |
# File 'lib/datadog_api_client/v2/api/container_images_api.rb', line 29 def list_container_images(opts = {}) data, _status_code, _headers = list_container_images_with_http_info(opts) data end |
#list_container_images_with_http_info(opts = {}) ⇒ Array<(ContainerImagesResponse, Integer, Hash)>
Get all Container Images.
Get all container images for your organization. This endpoint queries current inventory and does not support time-range parameters.
Use group_by to return image groups with counts. Grouped results are limited
by page[size], may be incomplete, and do not support pagination.
Note: To enrich the data returned by this endpoint with security scans, see the new api/v2/security/scanned-assets-metadata endpoint.
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 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/datadog_api_client/v2/api/container_images_api.rb', line 51 def list_container_images_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContainerImagesAPI.list_container_images ...' end if @api_client.config.client_side_validation && !opts[:'filter_tags'].nil? && opts[:'filter_tags'].to_s.length > 1024 fail ArgumentError, 'invalid value for "opts[:"filter_tags"]" when calling ContainerImagesAPI.list_container_images, the character length must be smaller than or equal to 1024.' end if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000 fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContainerImagesAPI.list_container_images, must be smaller than or equal to 10000.' end if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1 fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ContainerImagesAPI.list_container_images, must be greater than or equal to 1.' end # resource path local_var_path = '/api/v2/container_images' # query parameters query_params = opts[:query_params] || {} query_params[:'filter[tags]'] = opts[:'filter_tags'] if !opts[:'filter_tags'].nil? query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].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] || 'ContainerImagesResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :list_container_images, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContainerImagesAPI#list_container_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_container_images_with_pagination(opts = {}) {|ContainerImageItem| ... } ⇒ Object
Get all Container Images.
Provide a paginated version of #list_container_images, returning all items.
To use it you need to use a block: list_container_images_with_pagination { |item| p item }
118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/datadog_api_client/v2/api/container_images_api.rb', line 118 def list_container_images_with_pagination(opts = {}) api_version = "V2" page_size = @api_client.get_attribute_from_path(opts, "page_size", 1000) @api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size) while true do response = list_container_images(opts) @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) } if @api_client.get_attribute_from_path(response, "data").length == 0 break end @api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.pagination.next_cursor")) end end |