InfoPolicy

InfoPolicy

A policy affecting the behavior of info operations.

Please note that InfoPolicy does not derive from BasePolicy and that info commands do not support automatic retry.

Constructor

new InfoPolicy(propsopt)

Description:
  • Initializes a new InfoPolicy from the provided policy values.

Source:
Since:
  • v3.0.0
Parameters:
Name Type Attributes Description
props Object <optional>

Policy values

Members

checkBounds :boolean

Description:
  • Ensure the request is within allowable size limits.

Source:

Ensure the request is within allowable size limits.

Type:
  • boolean

checkBounds :boolean

Description:
  • Ensure the request is within allowable size limits.

Source:

Ensure the request is within allowable size limits.

Type:
  • boolean

sendAsIs :boolean

Description:
  • Send request without any further processing.

Source:

Send request without any further processing.

Type:
  • boolean

sendAsIs :boolean

Description:
  • Send request without any further processing.

Source:

Send request without any further processing.

Type:
  • boolean

timeout :number

Description:
  • Maximum time in milliseconds to wait for the operation to complete.

Source:

Maximum time in milliseconds to wait for the operation to complete.

Type:
  • number

timeout :number

Description:
  • Maximum time in milliseconds to wait for the operation to complete.

Source:

Maximum time in milliseconds to wait for the operation to complete.

Type:
  • number

InfoPolicy

A policy affecting the behavior of info operations.

Please note that InfoPolicy does not derive from BasePolicy and that info commands do not support automatic retry.

Constructor

new InfoPolicy(propsopt)

Description:
  • Initializes a new InfoPolicy from the provided policy values.

Source:
Since:
  • v3.0.0
Parameters:
Name Type Attributes Description
props Object <optional>

Policy values

Members

checkBounds :boolean

Description:
  • Ensure the request is within allowable size limits.

Source:

Ensure the request is within allowable size limits.

Type:
  • boolean

checkBounds :boolean

Description:
  • Ensure the request is within allowable size limits.

Source:

Ensure the request is within allowable size limits.

Type:
  • boolean

sendAsIs :boolean

Description:
  • Send request without any further processing.

Source:

Send request without any further processing.

Type:
  • boolean

sendAsIs :boolean

Description:
  • Send request without any further processing.

Source:

Send request without any further processing.

Type:
  • boolean

timeout :number

Description:
  • Maximum time in milliseconds to wait for the operation to complete.

Source:

Maximum time in milliseconds to wait for the operation to complete.

Type:
  • number

timeout :number

Description:
  • Maximum time in milliseconds to wait for the operation to complete.

Source:

Maximum time in milliseconds to wait for the operation to complete.

Type:
  • number