Class: Uploadcare::Resources::AddonExecution

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/uploadcare/resources/addon_execution.rb

Overview

Add-on execution resource.

Provides a unified interface for executing and checking status of AWS Rekognition, ClamAV, and Remove.bg add-ons.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#request_id ⇒ Object

Returns the value of attribute request_id.



10
11
12
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 10

def request_id
  @request_id
end

#result ⇒ Object

Returns the value of attribute result.



10
11
12
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 10

def result
  @result
end

#status ⇒ Object

Returns the value of attribute status.



10
11
12
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 10

def status
  @status
end

Class Method Details

.aws_rekognition_detect_labels(uuid:, client: nil, config: Uploadcare.configuration, request_options: {}) ⇒ Object

Execute AWS Rekognition label detection.



14
15
16
17
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 14

def aws_rekognition_detect_labels(uuid:, client: nil, config: Uploadcare.configuration, request_options: {})
  execute_addon(:aws_rekognition_detect_labels, client: client, config: config,
                                                request_options: request_options, uuid: uuid)
end

.aws_rekognition_detect_labels_status(request_id:, client: nil, config: Uploadcare.configuration, request_options: {}) ⇒ Object

Check AWS Rekognition label detection status.



20
21
22
23
24
25
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 20

def aws_rekognition_detect_labels_status(request_id:, client: nil, config: Uploadcare.configuration,
                                         request_options: {})
  check_addon_status(:aws_rekognition_detect_labels_status, client: client, config: config,
                                                            request_options: request_options,
                                                            request_id: request_id)
end

.aws_rekognition_detect_moderation_labels(uuid:, client: nil, config: Uploadcare.configuration, request_options: {}) ⇒ Object

Execute AWS Rekognition moderation label detection.



28
29
30
31
32
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 28

def aws_rekognition_detect_moderation_labels(uuid:, client: nil, config: Uploadcare.configuration,
                                             request_options: {})
  execute_addon(:aws_rekognition_detect_moderation_labels, client: client, config: config,
                                                           request_options: request_options, uuid: uuid)
end

.aws_rekognition_detect_moderation_labels_status(request_id:, client: nil, config: Uploadcare.configuration, request_options: {}) ⇒ Object

Check AWS Rekognition moderation label detection status.



35
36
37
38
39
40
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 35

def aws_rekognition_detect_moderation_labels_status(request_id:, client: nil,
                                                    config: Uploadcare.configuration, request_options: {})
  check_addon_status(:aws_rekognition_detect_moderation_labels_status, client: client, config: config,
                                                                       request_options: request_options,
                                                                       request_id: request_id)
end

.remove_bg(uuid:, params: {}, client: nil, config: Uploadcare.configuration, request_options: {}) ⇒ Object

Execute Remove.bg background removal.



61
62
63
64
65
66
67
68
69
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 61

def remove_bg(uuid:, params: {}, client: nil, config: Uploadcare.configuration, request_options: {})
  resolved_client = resolve_client(client: client, config: config)
  response = Uploadcare::Result.unwrap(
    resolved_client.api.rest.addons.remove_bg(
      uuid: uuid, params: params, request_options: request_options
    )
  )
  new(response, resolved_client)
end

.remove_bg_status(request_id:, client: nil, config: Uploadcare.configuration, request_options: {}) ⇒ Object

Check Remove.bg execution status.



72
73
74
75
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 72

def remove_bg_status(request_id:, client: nil, config: Uploadcare.configuration, request_options: {})
  check_addon_status(:remove_bg_status, client: client, config: config,
                                        request_options: request_options, request_id: request_id)
end

.uc_clamav_virus_scan(uuid:, params: {}, client: nil, config: Uploadcare.configuration, request_options: {}) ⇒ Object

Execute ClamAV virus scan.



43
44
45
46
47
48
49
50
51
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 43

def uc_clamav_virus_scan(uuid:, params: {}, client: nil, config: Uploadcare.configuration, request_options: {})
  resolved_client = resolve_client(client: client, config: config)
  response = Uploadcare::Result.unwrap(
    resolved_client.api.rest.addons.uc_clamav_virus_scan(
      uuid: uuid, params: params, request_options: request_options
    )
  )
  new(response, resolved_client)
end

.uc_clamav_virus_scan_status(request_id:, client: nil, config: Uploadcare.configuration, request_options: {}) ⇒ Object

Check ClamAV virus scan status.



54
55
56
57
58
 
# File 'lib/uploadcare/resources/addon_execution.rb', line 54

def uc_clamav_virus_scan_status(request_id:, client: nil, config: Uploadcare.configuration,
                                request_options: {})
  check_addon_status(:uc_clamav_virus_scan_status, client: client, config: config,
                                                   request_options: request_options, request_id: request_id)
end