class DocuSign_Monitor::DataSetApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = DataSetApi.default)
click to toggle source
# File lib/docusign_monitor/api/data_set_api.rb, line 32 def initialize(api_client = DataSetApi.default) @api_client = api_client end
Public Instance Methods
get_stream(data_set_name, version, options = DocuSign_Monitor::GetStreamOptions.default)
click to toggle source
Allows for the streaming of data as it becomes available Required scopes: impersonation @param data_set_name The name of the dataset to stream @param version The requested API version @param DocuSign_Monitor::GetStreamOptions
Options for modifying the behavior of the function. @return [CursoredResult]
# File lib/docusign_monitor/api/data_set_api.rb, line 42 def get_stream(data_set_name, version, options = DocuSign_Monitor::GetStreamOptions.default) data, _status_code, _headers = get_stream_with_http_info(data_set_name, version, options) return data end
get_stream_with_http_info(data_set_name, version, options = DocuSign_Monitor::GetStreamOptions.default)
click to toggle source
Allows for the streaming of data as it becomes available Required scopes: impersonation @param data_set_name The name of the dataset to stream @param version The requested API version @param DocuSign_Monitor::GetStreamOptions
Options for modifying the behavior of the function. @return [Array<(CursoredResult
, Fixnum, Hash)>] CursoredResult
data, response status code and response headers
# File lib/docusign_monitor/api/data_set_api.rb, line 53 def get_stream_with_http_info(data_set_name, version, options = DocuSign_Monitor::GetStreamOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: DataSetApi.get_stream ..." end # verify the required parameter 'data_set_name' is set fail ArgumentError, "Missing the required parameter 'data_set_name' when calling DataSetApi.get_stream" if data_set_name.nil? # verify the required parameter 'version' is set fail ArgumentError, "Missing the required parameter 'version' when calling DataSetApi.get_stream" if version.nil? # resource path local_var_path = "/api/v{version}/datasets/{dataSetName}/stream".sub('{format}','json').sub('{' + 'dataSetName' + '}', data_set_name.to_s).sub('{' + 'version' + '}', version.to_s) # query parameters query_params = {} query_params[:'cursor'] = options.cursor if !options.cursor.nil? query_params[:'limit'] = options.limit if !options.limit.nil? # header parameters 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(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CursoredResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: DataSetApi#get_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end