DataIntegration
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Table of Contents
Interfaces
- JsonSerializable
Properties
- $authMethods : array<string|int, DataIntegrationAuthMethods>
- How accounts authenticate with the provider for this Data Integration.
- $config : array<string, string>
- Provider-specific config values set on the Data Integration (e.g. a Snowflake `account`), keyed by config field. Only fields the provider declares are accepted.
- $createdAt : DateTimeImmutable
- An ISO 8601 timestamp.
- $credentials : DataIntegrationCredential|null
- The integration-level OAuth app credentials. `null` for `api_key` integrations, which hold no OAuth credentials (keys are installed per-tenant).
- $customProvider : DataIntegrationCustomProvider|null
- The OAuth definition when this is a custom provider; `null` for built-in providers.
- $description : string|null
- An optional description of the Data Integration.
- $enabled : bool
- Whether the Data Integration is enabled.
- $id : string
- Unique identifier of the Data Integration.
- $installation : DataIntegrationInstallation|null
- The tenant installation created when an API key was supplied at creation time; `null` otherwise. Not populated on list/get responses.
- $integrationType : string
- The integration type derived from the provider.
- $object : string
- Distinguishes the Data Integration object.
- $redirectUri : string
- The OAuth redirect URI to register with the provider when configuring the custom application.
- $scopes : array<string|int, string>|null
- The OAuth scopes configured for the Data Integration. `null` when the provider's configured scopes are used.
- $slug : string
- The provider slug for this Data Integration.
- $state : DataIntegrationState
- The state of the Data Integration.
- $updatedAt : DateTimeImmutable
- An ISO 8601 timestamp.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$authMethods
How accounts authenticate with the provider for this Data Integration.
public
array<string|int, DataIntegrationAuthMethods>
$authMethods
$config
Provider-specific config values set on the Data Integration (e.g. a Snowflake `account`), keyed by config field. Only fields the provider declares are accepted.
public
array<string, string>
$config
$createdAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$createdAt
$credentials
The integration-level OAuth app credentials. `null` for `api_key` integrations, which hold no OAuth credentials (keys are installed per-tenant).
public
DataIntegrationCredential|null
$credentials
$customProvider
The OAuth definition when this is a custom provider; `null` for built-in providers.
public
DataIntegrationCustomProvider|null
$customProvider
$description
An optional description of the Data Integration.
public
string|null
$description
$enabled
Whether the Data Integration is enabled.
public
bool
$enabled
$id
Unique identifier of the Data Integration.
public
string
$id
$installation
The tenant installation created when an API key was supplied at creation time; `null` otherwise. Not populated on list/get responses.
public
DataIntegrationInstallation|null
$installation
$integrationType
The integration type derived from the provider.
public
string
$integrationType
$object
Distinguishes the Data Integration object.
public
string
$object
$redirectUri
The OAuth redirect URI to register with the provider when configuring the custom application.
public
string
$redirectUri
$scopes
The OAuth scopes configured for the Data Integration. `null` when the provider's configured scopes are used.
public
array<string|int, string>|null
$scopes
$slug
The provider slug for this Data Integration.
public
string
$slug
$state
The state of the Data Integration.
public
DataIntegrationState
$state
$updatedAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$updatedAt
Methods
__construct()
public
__construct(string $object, string $id, string $slug, string $integrationType, string|null $description, bool $enabled, DataIntegrationState $state, array<string|int, mixed>|null $scopes, string $redirectUri, array<string|int, mixed> $authMethods, DataIntegrationCredential|null $credentials, DataIntegrationInstallation|null $installation, array<string|int, mixed> $config, DataIntegrationCustomProvider|null $customProvider, DateTimeImmutable $createdAt, DateTimeImmutable $updatedAt) : mixed
Parameters
- $object : string
- $id : string
- $slug : string
- $integrationType : string
- $description : string|null
- $enabled : bool
- $state : DataIntegrationState
- $scopes : array<string|int, mixed>|null
- $redirectUri : string
- $authMethods : array<string|int, mixed>
- $credentials : DataIntegrationCredential|null
- $installation : DataIntegrationInstallation|null
- $config : array<string|int, mixed>
- $customProvider : DataIntegrationCustomProvider|null
- $createdAt : DateTimeImmutable
- $updatedAt : DateTimeImmutable
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>