ProvisioningClient-class: Client for working with Keboola Connection Provisioning API.

In keboola/provisioning-r-client: Keboola Connection Provisioning client

Client for working with Keboola Connection Provisioning API.

Description

The client allows to create and retrieve credentials for sandbox and transformation buckets. Additional methods to kill sandbox/transformation bucket are available.

Methods

decodeResponse(response)

Internal method to process API response.

Parameters

• response List as returned from httr POST/GET methods.

Return Value

Response body - either list or string in case the body cannot be parsed as JSON.

dropCredentials(id)

Delete credentials and cleanup the associated database bucket.

Parameters

• id Credentials id.

Return Value

TRUE

getCredentials(type = "transformations")

Get new credentials of the given type or reuse existing credentials if available.

Parameters

• type Credentials type - either transformations or sandbox

Return Value

List with credentials.

getCredentialsById(id)

Get existing credentials.

Parameters

• id Credentials id.

Return Value

List with credentials.

initialize(backend, token, runId = "", url = "https://syrup.keboola.com/provisioning")

Constructor.

Parameters

• backend Type of database backend - either mysql or redshift

• token KBC Storage API token.

• runId Optional Run ID of the parent job.

• url Optional URL of the provisioning API.

killProcesses(id)

Kill database processes running with the given credentials.

Parameters

• id Credentials id.

Return Value

TRUE

keboola/provisioning-r-client documentation built on March 15, 2023, 5:36 a.m.