salesforce Dreamforce On-Demand
Contact Us 1-800-596-4880
  1. Homepage
  2. Google Sheets Connector (1.0)

  3. Google Sheets Connector Reference

All Connectors

Google Sheets Connector 1.0 Reference - Mule 4

Anypoint Connector for Google Sheets (Google Sheets Connector) enables you to interface with the Google Sheets platform without having to interact with the Google Sheets API directly.

Configurations

Config

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Oauth 2 0 Connection Provider

The connection types to provide to this configuration.

x

Response Timeout

Number

The timeout for the request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

AUTO

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Oauth 2 0 Connection Provider
Parameters
Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Array of Default Query Param

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections to keep open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Idle Timeout

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not received responses should be streamed

false

Response Buffer Size

Number

The space, in bytes, for the buffer where the HTTP response is stored.

-1

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

Tls

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Consumer Key

String

The OAuth consumer key as registered with the service provider

x

Consumer Secret

String

The OAuth consumer secret as registered with the service provider

x

Authorization Url

String

The service provider’s authorization endpoint URL

https://accounts.google.com/oauth2/auth/

Access Token Url

String

The service provider’s access token endpoint URL

https://oauth2.googleapis.com/token

Scopes

String

The OAuth scopes to request during the dance.

https://www.googleapis.com/auth/spreadsheets, https://www.googleapis.com, and /auth/drive.readonly

Resource Owner Id

String

The resource owner ID that each component should use if it isn’t referenced otherwise.

Before

String

The name of a flow to execute before starting the OAuth dance

After

String

The name of a flow to execute after an access token is received

Listener Config

String

A reference to an <http:listener-config /> to use to create the listener that will catch the access token callback endpoint.

x

Callback Path

String

The path of the access token callback endpoint

x

Authorize Path

String

The path of the local HTTP endpoint that triggers the OAuth dance

x

External Callback Url

String

If the callback endpoint is behind a proxy or should be accessed through an indirect URL, use this parameter to tell the OAuth provider the URL it should use to access the callback

Object Store

String

A reference to the object store to use to store each resource owner ID’s data. If not specified, runtime automatically provisions the default object store.

Sources

On New Row Listener

<google-sheets:new-row-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Response timeout

Number

30

Response timeout time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

SECONDS

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message

Spreadsheet

String

ID of the spreadsheet

x

Worksheet Name

String

Name of the worksheet

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

For Configurations

On New Spreadsheet Listener

<google-sheets:new-spreadsheet-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Response timeout

Number

30

Response timeout time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

SECONDS

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost

sour

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message

sour

Reconnection Strategy

A retry strategy in case of connectivity errors

sour

Output

Type

Any

For Configurations

On Updated Row Listener

<google-sheets:updated-row-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Response timeout

Number

30

Response timeout time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

SECONDS

Include Newly Added Rows

Boolean

Indicates whether to include newly added rows in the output.

false

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message

Spreadsheet

String

The ID of the spreadsheet

x

Worksheet Name

String

The name of the worksheet

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

For Configurations

Supported Operations

Operations

Append Spreadsheets Values

<google-sheets:create-spreadsheets-values-rangeappend-by-spreadsheet-id>

Appends values to an existing spreadsheet, as determined by the specified range This operation makes an HTTP POST request to the /spreadsheets/{spreadsheetId}/values/{range}:append endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Spreadsheet

String

ID of the target spreadsheet

x

Range

String

A1 notation of a range that determines where to start appending the values. The values are appended starting in the first column and after the last row in the specified range.

x

Value Input Option

Enumeration, one of:

  • USER_ENTERED

  • INPUT_VALUE_OPTION_UNSPECIFIED

  • RAW

Indicates how to interpret the new content: INPUT_VALUE: Default input value. This value must not be used. RAW: Append the content as is, without parsing it. USER_ENTERED: Parse the values as if they were entered into the Google Sheets UI.

USER_ENTERED

Content Type

String

Type of content

application/json

Spreadsheets Values Rangeappend Content

Any

Content to append

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • GOOGLE-SHEETS:BAD_REQUEST

  • GOOGLE-SHEETS:CLIENT_ERROR

  • GOOGLE-SHEETS:CONNECTIVITY

  • GOOGLE-SHEETS:INTERNAL_SERVER_ERROR

  • GOOGLE-SHEETS:NOT_ACCEPTABLE

  • GOOGLE-SHEETS:NOT_FOUND

  • GOOGLE-SHEETS:RETRY_EXHAUSTED

  • GOOGLE-SHEETS:SERVER_ERROR

  • GOOGLE-SHEETS:SERVICE_UNAVAILABLE

  • GOOGLE-SHEETS:TIMEOUT

  • GOOGLE-SHEETS:TOO_MANY_REQUESTS

  • GOOGLE-SHEETS:UNAUTHORIZED

  • GOOGLE-SHEETS:UNSUPPORTED_MEDIA_TYPE

List Drive Files

<google-sheets:get-files>

Returns a list of the user’s Google Drive files This operation makes an HTTP GET request to the /files endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page Size

String

Page size for the returned results

100

Query

String

Search query

Fields

String

Paths to the fields to include in the response. Use * to retrieve all fields.

Order By

String

Order By

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • GOOGLE-SHEETS:BAD_REQUEST

  • GOOGLE-SHEETS:CLIENT_ERROR

  • GOOGLE-SHEETS:CONNECTIVITY

  • GOOGLE-SHEETS:INTERNAL_SERVER_ERROR

  • GOOGLE-SHEETS:NOT_ACCEPTABLE

  • GOOGLE-SHEETS:NOT_FOUND

  • GOOGLE-SHEETS:SERVER_ERROR

  • GOOGLE-SHEETS:SERVICE_UNAVAILABLE

  • GOOGLE-SHEETS:TIMEOUT

  • GOOGLE-SHEETS:TOO_MANY_REQUESTS

  • GOOGLE-SHEETS:UNAUTHORIZED

  • GOOGLE-SHEETS:UNSUPPORTED_MEDIA_TYPE

Get Spreadsheet Properties

<google-sheets:get-spreadsheets-by-spreadsheet-id>

Returns the Properties of the specified Google spreadsheet This operation makes an HTTP GET request to the /spreadsheets/{spreadsheetId}?fields=sheets.properties endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Spreadsheet Id

String

ID of the target spreadsheet

x

Fields

String

Paths to the fields to include in the response. Use * to retrieve all fields.

Content Type

String

Content type

application/json

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • GOOGLE-SHEETS:BAD_REQUEST

  • GOOGLE-SHEETS:CLIENT_ERROR

  • GOOGLE-SHEETS:CONNECTIVITY

  • GOOGLE-SHEETS:INTERNAL_SERVER_ERROR

  • GOOGLE-SHEETS:NOT_ACCEPTABLE

  • GOOGLE-SHEETS:NOT_FOUND

  • GOOGLE-SHEETS:RETRY_EXHAUSTED

  • GOOGLE-SHEETS:SERVER_ERROR

  • GOOGLE-SHEETS:SERVICE_UNAVAILABLE

  • GOOGLE-SHEETS:TIMEOUT

  • GOOGLE-SHEETS:TOO_MANY_REQUESTS

  • GOOGLE-SHEETS:UNAUTHORIZED

  • GOOGLE-SHEETS:UNSUPPORTED_MEDIA_TYPE

Get Spreadsheets Values

<google-sheets:get-spreadsheets-values-by-spreadsheet-id-range>

Returns the values from the specified range in a Google spreadsheet This operation makes an HTTP GET request to the /spreadsheets/{spreadsheetId}/values/{range} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Spreadsheet

String

ID of the target spreadsheet

x

Range

String

A1 notation of the range whose properties to return. You can specify multiple ranges.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • GOOGLE-SHEETS:BAD_REQUEST

  • GOOGLE-SHEETS:CLIENT_ERROR

  • GOOGLE-SHEETS:CONNECTIVITY

  • GOOGLE-SHEETS:INTERNAL_SERVER_ERROR

  • GOOGLE-SHEETS:NOT_ACCEPTABLE

  • GOOGLE-SHEETS:NOT_FOUND

  • GOOGLE-SHEETS:RETRY_EXHAUSTED

  • GOOGLE-SHEETS:SERVER_ERROR

  • GOOGLE-SHEETS:SERVICE_UNAVAILABLE

  • GOOGLE-SHEETS:TIMEOUT

  • GOOGLE-SHEETS:TOO_MANY_REQUESTS

  • GOOGLE-SHEETS:UNAUTHORIZED

  • GOOGLE-SHEETS:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<google-sheets:unauthorize>

Deletes all of the access token information associated with a given resource owner ID, so that it’s impossible to execute an operation for that user without redoing the authorization dance

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner whose access should be invalidated

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

For Configurations

Update Spreadsheets Values

<google-sheets:update-spreadsheets-values-by-spreadsheet-id-range>

Updates the values of a spreadsheet at the specified range This operation makes an HTTP PUT request to the /spreadsheets/{spreadsheetId}/values/{range} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Spreadsheet

String

ID of the target spreadsheet

x

Range

String

A1 notation of the range where you want to update values

x

Value Input Option

Enumeration, one of:

  • USER_ENTERED

  • INPUT_VALUE_OPTION_UNSPECIFIED

  • RAW

Indicates how to interpret the new content: INPUT_VALUE: Default input value. This value must * not be used. RAW: Append the content as is, without parsing it. USER_ENTERED: Parse the values as if they were entered into the Google Sheets UI.

USER_ENTERED

Content Type

String

Content type

application/json

Spreadsheets Values Rangeappend Content

Any

Updated values

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • GOOGLE-SHEETS:BAD_REQUEST

  • GOOGLE-SHEETS:CLIENT_ERROR

  • GOOGLE-SHEETS:CONNECTIVITY

  • GOOGLE-SHEETS:INTERNAL_SERVER_ERROR

  • GOOGLE-SHEETS:NOT_ACCEPTABLE

  • GOOGLE-SHEETS:NOT_FOUND

  • GOOGLE-SHEETS:RETRY_EXHAUSTED

  • GOOGLE-SHEETS:SERVER_ERROR

  • GOOGLE-SHEETS:SERVICE_UNAVAILABLE

  • GOOGLE-SHEETS:TIMEOUT

  • GOOGLE-SHEETS:TOO_MANY_REQUESTS

  • GOOGLE-SHEETS:UNAUTHORIZED

  • GOOGLE-SHEETS:UNSUPPORTED_MEDIA_TYPE

Types

Default Header

Field Type Description Default Value Required

Key

String

x

Value

String

x

Default Query Param

Field Type Description Default Value Required

Key

String

x

Value

String

x

Proxy

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Key Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which is resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations is performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which is resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file is used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Http Response Attributes

Field Type Description Default Value Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

See Also

Back to top
View on GitHub