JobsHttpClientV1 class

Implemented types

Constructors

JobsHttpClientV1([dynamic config])

Properties

baseRoute ↔ String
The base route.
read / write, inherited
client ↔ Client
The HTTP client.
read / write, inherited
connectionResolver ↔ HttpConnectionResolver
The connection resolver.
read / write, inherited
connectTimeout ↔ int
The connection timeout in milliseconds.
read / write, inherited
counters ↔ CompositeCounters
The performance counters.
read / write, inherited
hashCode → int
The hash code for this object. [...]
read-only, inherited
headers ↔ Map<String, String>
The default headers to be added to every request.
read / write, inherited
logger ↔ CompositeLogger
The logger.
read / write, inherited
options ↔ ConfigParams
The configuration options.
read / write, inherited
retries ↔ int
The number of retries.
read / write, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
timeout ↔ int
The invocation timeout in milliseconds.
read / write, inherited
uri ↔ String
The remote service uri which is calculated on open.
read / write, inherited

Methods

abortJob(String correlationId, String jobId) → Future<JobV1>
Aborts job [...]
override
addJob(String correlationId, NewJobV1 newJob) → Future<JobV1>
Add new job from newJob. [...]
override
addUniqJob(String correlationId, NewJobV1 newJob) → Future<JobV1>
Add new job if not exist with same type and ref_jobId [...]
override
completeJob(String correlationId, String jobId) → Future<JobV1>
Completes job [...]
override
deleteJobById(String correlationId, String jobId) → Future<JobV1>
Deletes a job by it's unique jobId. [...]
override
deleteJobs(String correlationId) → Future
Removes all jobs [...]
override
extendJob(String correlationId, String jobId, num timeout) → Future<JobV1>
Extends job execution limit on timeout value [...]
override
getJobById(String correlationId, String jobId) → Future<JobV1>
Gets a job by its unique jobId. [...]
override
getJobs(String correlationId, FilterParams filter, PagingParams paging) → Future<DataPage<JobV1>>
Gets a page of jobs retrieved by a given filter. [...]
override
startJobById(String correlationId, String jobId, num timeout) → Future<JobV1>
Starts a job by its unique jobId. [...]
override
startJobByType(String correlationId, String jobType, num timeout, num maxRetries) → Future<JobV1>
Start fist free job by type [...]
override
addCorrelationId(Map<String, String> params, String correlationId) → Map<String, String>
Adds a correlation id (correlation_id) to invocation parameter map. [...]
inherited
addFilterParams(Map<String, String> params, FilterParams filter) → Map<String, String>
Adds filter parameters (with the same name as they defined) to invocation parameter map. [...]
inherited
addPagingParams(Map<String, String> params, PagingParams paging) → Map<String, String>
Adds paging parameters (skip, take, total) to invocation parameter map. [...]
inherited
call(String method, String route, String correlationId, Map<String, String> params, [dynamic data]) → Future
Calls a remote method via HTTP/REST protocol. [...]
inherited
callCommand(String name, String correlationId, dynamic params) → Future
Calls a remote method via HTTP commadable protocol. The call is made via POST operation and all parameters are sent in body object. The complete route to remote method is defined as baseRoute + "/" + name. [...]
inherited
close(String correlationId) → Future
Closes component and frees used resources. [...]
inherited
configure(ConfigParams config) → void
Configures component by passing configuration parameters. [...]
inherited
createRequestRoute(String route) → String
inherited
instrument(String correlationId, String name) → Timing
Adds instrumentation to log calls and measure call time. It returns a Timing object that is used to end the time measurement. [...]
inherited
instrumentError(String correlationId, String name, dynamic err, [bool reerror = false]) → void
Adds instrumentation to error handling. [...]
inherited
isOpen() → bool
Checks if the component is opened. Returns true if the component has been opened and false otherwise.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
open(String correlationId) → Future
Opens the component. [...]
inherited
setReferences(IReferences references) → void
Sets references to dependent components. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
inherited