Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(ootbc): Update timeout settings in network communication docs #3526

Merged
merged 2 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/components/connectors/protocol/graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,13 @@ Variables:
}
```

### Connection Timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection Timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response mapping

Expand Down
11 changes: 7 additions & 4 deletions docs/components/connectors/protocol/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Make a request to a REST API and use the response in the next steps
:::caution
If you use the REST Connector, ensure you do not have any instance variable named in the list below:

- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`
- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`, `readTimeoutInSeconds`, `writeTimeoutInSeconds`

:::

Expand Down Expand Up @@ -167,10 +167,13 @@ Secrets are currently not supported in the body of a **REST Connector**.
}
```

### Connection timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,13 @@ Variables:
}
```

### Connection Timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection Timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response mapping

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Make a request to a REST API and use the response in the next steps
:::caution
If you use the REST Connector, ensure you do not have any instance variable named in the list below:

- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`
- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`, `readTimeoutInSeconds`, `writeTimeoutInSeconds`

:::

Expand Down Expand Up @@ -167,10 +167,13 @@ Secrets are currently not supported in the body of a **REST Connector**.
}
```

### Connection timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,13 @@ Variables:
}
```

### Connection Timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection Timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response mapping

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Make a request to a REST API and use the response in the next steps
:::caution
If you use the REST Connector, ensure you do not have any instance variable named in the list below:

- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`
- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`, `readTimeoutInSeconds`, `writeTimeoutInSeconds`

:::

Expand Down Expand Up @@ -167,10 +167,13 @@ Secrets are currently not supported in the body of a **REST Connector**.
}
```

### Connection timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,13 @@ Variables:
}
```

### Connection Timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection Timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response mapping

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Make a request to a REST API and use the response in the next steps
:::caution
If you use the REST Connector, ensure you do not have any instance variable named in the list below:

- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`
- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`, `readTimeoutInSeconds`, `writeTimeoutInSeconds`

:::

Expand Down Expand Up @@ -167,10 +167,13 @@ Secrets are currently not supported in the body of a **REST Connector**.
}
```

### Connection timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,13 @@ Variables:
}
```

### Connection Timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection Timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response mapping

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Make a request to a REST API and use the response in the next steps
:::caution
If you use the REST Connector, ensure you do not have any instance variable named in the list below:

- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`
- `body`, `url`, `method`, `headers`, `authentication`, `queryParameters`, `connectionTimeoutInSeconds`, `readTimeoutInSeconds`, `writeTimeoutInSeconds`

:::

Expand Down Expand Up @@ -167,10 +167,13 @@ Secrets are currently not supported in the body of a **REST Connector**.
}
```

### Connection timeout
### Network communication timeouts

To set connection timeout in your request, set it in seconds in the **Connection timeout** section.
This is not a required field, with a default value of 20 seconds. To set an infinite timeout, set this value to `0`.
- **Connection timeout in seconds** determines the time frame in which the client will try to establish a connection with the server. If you do not specify a value, the system uses the default of 20 seconds. For cases where you need to wait indefinitely, set this value to 0.

- **Read timeout in seconds** is the amount of time the client will wait to read data from the server after the connection has been made. The default is also set to 20 seconds. To allow an unlimited wait time for slow responses, set this to 0.

- **Write timeout in seconds** controls how long the client will wait to successfully send data to the server. The default setting for this is 0, indicating that there is no limit and the client will wait indefinitely for the operation to complete.

## Response

Expand Down
Loading