class AsposeImagingCloud::FilterEffectImageRequest

Request model for filter_effect_image operation.

Public Class Methods

new(name, filter_type, filter_properties, format = nil, folder = nil, storage = nil) click to toggle source

Apply filtering effects to an existing image. @param [String] name Filename of an image. @param [String] filter_type Filter type (BigRectangular, SmallRectangular, Median, GaussWiener, MotionWiener, GaussianBlur, Sharpen, BilateralSmoothing). @param [FilterPropertiesBase] filter_properties Filter properties. @param [String] format Resulting image format. Please, refer to docs.aspose.cloud/display/imagingcloud/Supported+File+Formats#SupportedFileFormats-CommonOperationsFormatSupportMap for possible use-cases. @param [String] folder Folder with image to process. @param [String] storage Your Aspose Cloud Storage name.

# File lib/aspose-imaging-cloud/models/requests/filter_effect_image_request.rb, line 41
def initialize(name, filter_type, filter_properties, format = nil, folder = nil, storage = nil)
  @name = name
  @filter_type = filter_type
  @filter_properties = filter_properties
  @format = format
  @folder = folder
  @storage = storage
end

Public Instance Methods

to_http_info(config) click to toggle source
# File lib/aspose-imaging-cloud/models/requests/filter_effect_image_request.rb, line 50
def to_http_info(config)
  # verify the required parameter 'name' is set
  if config.client_side_validation && @name.nil?
    raise ArgumentError, "Missing the required parameter 'name' when calling ImagingApi.filter_effect_image"
  end

  # verify the required parameter 'filter_type' is set
  if config.client_side_validation && @filter_type.nil?
    raise ArgumentError, "Missing the required parameter 'filter_type' when calling ImagingApi.filter_effect_image"
  end

  # verify the required parameter 'filter_properties' is set
  if config.client_side_validation && @filter_properties.nil?
    raise ArgumentError, "Missing the required parameter 'filter_properties' when calling ImagingApi.filter_effect_image"
  end

  # resource path
  local_var_path = '/imaging/{name}/filterEffect'.sub('{' + 'name' + '}', @name.to_s)

  # query parameters
  query_params = {}
  query_params[:filterType] = @filter_type
  query_params[:format] = @format unless @format.nil?
  query_params[:folder] = @folder unless @folder.nil?
  query_params[:storage] = @storage unless @storage.nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = object_to_http_body(@filter_properties)
  auth_names = ['JWT']

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json', 'application/xml'])

  AsposeImagingCloud::HttpRequest.new(local_var_path,
                                  header_params,
                                  query_params,
                                  form_params,
                                  post_body,
                                  auth_names)
end