Class: DatadogAPIClient::V2::StegadographyAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/stegadography_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ StegadographyAPI

Returns a new instance of StegadographyAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/stegadography_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/stegadography_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_stegadography_widgets(image, opts = {}) ⇒ Object

Get widgets from an image.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/stegadography_api.rb', line 29

def get_stegadography_widgets(image, opts = {})
  data, _status_code, _headers = get_stegadography_widgets_with_http_info(image, opts)
  data
end

#get_stegadography_widgets_with_http_info(image, opts = {}) ⇒ Array<(StegadographyGetWidgetsResponse, Integer, Hash)>

Get widgets from an image.

Extracts watermarks from a PNG image and returns the cached widget data associated with each watermark found. The image must be uploaded as a multipart/form-data request with the file in the image field. Only widgets belonging to the authenticated organization are returned.

Parameters:

  • image (File) —

    PNG image file to scan for embedded watermarks.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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/datadog_api_client/v2/api/stegadography_api.rb', line 44

def get_stegadography_widgets_with_http_info(image, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StegadographyAPI.get_stegadography_widgets ...'
  end
  # verify the required parameter 'image' is set
  if @api_client.config.client_side_validation && image.nil?
    fail ArgumentError, "Missing the required parameter 'image' when calling StegadographyAPI.get_stegadography_widgets"
  end
  # resource path
  local_var_path = '/api/v2/stegadography/get-widgets'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['image'] = image

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'StegadographyGetWidgetsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_stegadography_widgets,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StegadographyAPI#get_stegadography_widgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end