Task Parameters

<< Click to Display Table of Contents >>

RayVentory Data Hub > 12.6 u5 > Connectors > Alphabetic Connector List > CloudSphere IQSonar > Connector Parameters 

Task Parameters

Page Size

This parameter defines the page size (number of records) during a paginated API request.

 

Technical Name

page_size

Category

Technical

Type

Integer

Default Value

50

Example Values

50

 

Changing the page size should only be necessary if running into connection issues or rate limitation. The larger the page the longer every single request takes. However, the total number of necessary requests decreases. The sweet spot depends on the server capabilities and the connection quality. Most APIs limit the maximum page size.

 

Rate Limiter Number of Requests

Limits the number of requests issued in the time interval set by the parameter Rate Limiter Duration.

 

Technical Name

rate_limiter_num_requests

Category

Technical

Type

Integer

Default Value

1000

Example Values

1000, 20

 

The rate limiter ensures that at most Rate Limiter Number of Requests are issued in a Rate Limiter Duration. If requests fail with a "too many requests" error, study the API documentation and adapt those parameters accordingly.

 

Rate Limiter Duration

This parameter represents the time interval during which at most Rate Limiter Number of Requests are issued by the connector.

 

Technical Name

rate_limiter_duration

Category

Technical

Type

String

Default Value

PT1S

Example Values

PT1S, PT1M, PT2H

 

The rate limiter ensures that at most Rate Limiter Number of Requests are issued in a Rate Limiter Duration. If requests fail with a "too many requests" error, study the API documentation and adapt those parameters accordingly.

 

Connection Timeout (in ms)

This parameter defines the time (in milliseconds) after which a running request aborts. If set to null, the default timeout of the system is used.

 

Technical Name

timeout

Category

Technical

Type

Integer

null

Default Value

null

Example Values

10000, 10000

 

Initial Delay (in ms)

This parameter defines the initial time (in milliseconds) to wait before a failed request is reattempted.

 

Technical Name

initial_delay

Category

Technical

Type

Integer

Default Value

1000

Example Values

1000

 

Maximum Delay (in ms)

This parameter represents the maximum amount of time (in milliseconds) to wait before a failed HTTP request is reattempted. Set to null for unrestricted delay.

 

Technical Name

max_delay

Category

Technical

Type

Integer

null

Default Value

180000

Example Values

180000

 

Maximum Number of Attempts

This parameter represents the maximum number of attempts after which an HTTP request will fail permanently.

 

Technical Name

max_attempts

Category

Technical

Type

Integer

Default Value

5

Example Values

5

 

Failed requests will be resend by the connector before failing the whole connector run. When experiencing a lot of connectivity issues which are not related to server overload or some kind of rate limitation, it is recommended to increase this parameter as well as the Timeout and the Maximum Delay parameter.