Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
 - Variables
 - type APIError
 - type AbstractedEnvironmentVariable
 - type AccountFeatureUpdateRequest
 - type AccountFeatures
 - type AccountFeaturesResponse
 - type Adapter
 - type AdapterCredentialDetails
 - func GenerateAthenaCredentialDetails(awsAccessKeyId string, awsSecretAccessKey string, schema string) (AdapterCredentialDetails, error)
 - func GenerateDatabricksCredentialDetails(token string, schema string, targetName string, catalog string) (AdapterCredentialDetails, error)
 - func GenerateFabricCredentialDetails(user string, password string, tenantId string, clientId string, ...) (AdapterCredentialDetails, error)
 - func GenerateStarburstCredentialDetails(username string, password string, database string, schema string) (AdapterCredentialDetails, error)
 - func GenerateTeradataCredentialDetails(username string, password string, schema string, threads int) (AdapterCredentialDetails, error)
 
- type AdapterCredentialField
 - type AdapterCredentialFieldMetadata
 - type AdapterCredentialFieldMetadataOptions
 - type AdapterCredentialFieldMetadataValidation
 - type AdapterMetadata
 - type AdapterResponse
 - type ApacheSparkConfig
 - type AssignUserGroupsResponse
 - type AthenaConfig
 - type AthenaCredentialData
 - type AthenaCredentialRequest
 - type AthenaCredentialResponse
 - type AthenaUnencryptedCredentialDetails
 - type AuthResponse
 - type AuthResponseData
 - type AzureDevOpsProject
 - type AzureDevOpsProjectsData
 - type AzureDevOpsProjectsResponse
 - type AzureDevOpsRepositoriesData
 - type AzureDevOpsRepositoriesResponse
 - type AzureDevOpsRepository
 - type BigQueryConfig
 - type BigQueryCredential
 - type BigQueryCredentialResponse
 - type Cidrs
 - type Client
 - func (c *Client) AssignUserGroups(userId int, groupIDs []int) (*AssignUserGroupsResponse, error)
 - func (c *Client) CancelRun(runID int64) (*Run, error)
 - func (c *Client) CreateAthenaCredential(projectId int, awsAccessKeyId string, awsSecretAccessKey string, schema string) (*AthenaCredentialData, error)
 - func (c *Client) CreateBigQueryCredential(projectId int, type_ string, isActive bool, dataset string, numThreads int) (*BigQueryCredential, error)
 - func (c *Client) CreateDatabricksCredential(projectId int, token string, schema string, targetName string, catalog string) (*DatabricksCredential, error)
 - func (c *Client) CreateEnvironment(isActive bool, projectId int, name string, dbtVersion string, type_ string, ...) (*Environment, error)
 - func (c *Client) CreateEnvironmentVariable(projectID int, name string, environmentValues map[string]string) (*AbstractedEnvironmentVariable, error)
 - func (c *Client) CreateEnvironmentVariableJobOverride(projectID int, name string, rawValue string, jobDefinitionID int) (*EnvironmentVariableJobOverride, error)
 - func (c *Client) CreateExtendedAttributes(state int, projectId int, extendedAttributes json.RawMessage) (*ExtendedAttributes, error)
 - func (c *Client) CreateFabricCredential(projectId int, user string, password string, tenantId string, clientId string, ...) (*FabricCredential, error)
 - func (c *Client) CreateGroup(name string, assignByDefault bool, ssoMappingGroups []string) (*Group, error)
 - func (c *Client) CreateIPRestrictionsRule(ipRestrictionsRule IPRestrictionsRule) (*IPRestrictionsRule, error)
 - func (c *Client) CreateJob(projectId int, environmentId int, name string, description string, ...) (*Job, error)
 - func (c *Client) CreateLicenseMap(licenseType string, ssoLicenseMappingGroups []string) (*LicenseMap, error)
 - func (c *Client) CreateLineageIntegration(projectID int64, name string, host string, siteID string, tokenName string, ...) (*LineageIntegration, error)
 - func (c *Client) CreateModelNotifications(environmentID string, enabled bool, onSuccess bool, onFailure bool, ...) (*ModelNotifications, error)
 - func (c *Client) CreateNotification(userId int, onCancel []int, onFailure []int, onWarning []int, onSuccess []int, ...) (*Notification, error)
 - func (c *Client) CreateOAuthConfiguration(oAuthType string, name string, clientId string, clientSecret string, ...) (*OAuthConfiguration, error)
 - func (c *Client) CreatePostgresCredential(projectId int, isActive bool, type_ string, defaultSchema string, ...) (*PostgresCredential, error)
 - func (c *Client) CreateProject(name string, description string, dbtProjectSubdirectory string, ...) (*Project, error)
 - func (c *Client) CreateRepository(projectID int, remoteUrl string, isActive bool, gitCloneStrategy string, ...) (*Repository, error)
 - func (c *Client) CreateSemanticLayerConfiguration(projectId int64, environmentId int64) (*SemanticLayerConfiguration, error)
 - func (c *Client) CreateSemanticLayerCredential(projectId int64, isActive bool, database string, role string, warehouse string, ...) (*SemanticLayerCredentials, error)
 - func (c *Client) CreateServiceToken(name string, state int) (*ServiceToken, error)
 - func (c *Client) CreateSnowflakeCredential(projectId int, type_ string, isActive bool, database string, role string, ...) (*SnowflakeCredential, error)
 - func (c *Client) CreateStarburstCredential(ctx context.Context, projectId int, username string, password string, ...) (*StarburstCredentialData, error)
 - func (c *Client) CreateTeradataCredential(ctx context.Context, projectId int, username string, password string, ...) (*TeradataCredentialData, error)
 - func (c *Client) CreateWebhook(webhookId string, name string, description string, clientUrl string, ...) (*WebhookRead, error)
 - func (c *Client) DeleteCredential(credentialId, projectId string) (string, error)
 - func (c *Client) DeleteEnvironment(projectId, environmentId int) (string, error)
 - func (c *Client) DeleteEnvironmentVariable(environmentVariableName string, projectID int) (string, error)
 - func (c *Client) DeleteEnvironmentVariableJobOverride(projectID int, environmentVariableJobOverrideID int) (string, error)
 - func (c *Client) DeleteExtendedAttributes(projectId, extendedAttributesID int) (string, error)
 - func (c *Client) DeleteGlobalConnection(connectionID int64) (string, error)
 - func (c *Client) DeleteIPRestrictions(ipRestrictions IPRestrictions) error
 - func (c *Client) DeleteIPRestrictionsRule(ipRestrictionsRuleID int64) error
 - func (c *Client) DeleteLineageIntegration(projectID int64, lineageIntegrationID int64) error
 - func (c *Client) DeleteOAuthConfiguration(oAuthConfigurationID int64) error
 - func (c *Client) DeletePostgresCredential(credentialId, projectId string) (string, error)
 - func (c *Client) DeleteRepository(repositoryID, projectID string) (string, error)
 - func (c *Client) DeleteSemanticLayerConfiguration(projectId int64, semanticLayerConfigurationID int64) error
 - func (c *Client) DeleteSemanticLayerCredential(projectId int64, credentialId int64) error
 - func (c *Client) DeleteServiceToken(serviceTokenID int) (string, error)
 - func (c *Client) DeleteWebhook(webhookId string) (string, error)
 - func (c *Client) DestroyLicenseMap(licenseMapID int) error
 - func (c *Client) GetAccountFeatures() (*AccountFeatures, error)
 - func (c *Client) GetAllConnections() ([]GlobalConnectionSummary, error)
 - func (c *Client) GetAllEnvironments(projectID int) ([]Environment, error)
 - func (c *Client) GetAllGroupIDsByName(groupName string) []int
 - func (c *Client) GetAllJobs(projectID int, environmentID int) ([]JobWithEnvironment, error)
 - func (c *Client) GetAllLicenseMaps() ([]LicenseMap, error)
 - func (c *Client) GetAllNotifications() ([]Notification, error)
 - func (c *Client) GetAllProjects(nameContains string) ([]ProjectConnectionRepository, error)
 - func (c *Client) GetAllServiceTokens() ([]ServiceToken, error)
 - func (c *Client) GetAthenaCredential(projectId int, credentialId int) (*AthenaCredentialData, error)
 - func (c *Client) GetAzureDevOpsProject(projectName string) (*AzureDevOpsProject, error)
 - func (c *Client) GetAzureDevOpsProjects() ([]AzureDevOpsProject, error)
 - func (c *Client) GetAzureDevOpsRepositories(azureDevOpsProjectID string) ([]AzureDevOpsRepository, error)
 - func (c *Client) GetAzureDevOpsRepository(repositoryName string, azureDevOpsProjectID string) (*AzureDevOpsRepository, error)
 - func (c *Client) GetBigQueryCredential(projectId int, credentialId int) (*BigQueryCredential, error)
 - func (c *Client) GetConnectedUser() (*User, error)
 - func (c *Client) GetConstants() (*Constants, error)
 - func (c *Client) GetData(url string) []any
 - func (c *Client) GetDatabricksCredential(projectId int, credentialId int) (*DatabricksCredential, error)
 - func (c *Client) GetEndpoint(url string) ([]byte, error)
 - func (c *Client) GetEnvironment(projectId int, environmentId int) (*Environment, error)
 - func (c *Client) GetEnvironmentVariable(projectID int, environmentVariableName string) (*FullEnvironmentVariable, error)
 - func (c *Client) GetEnvironmentVariableJobOverride(projectID int, jobDefinitionID int, environmentVariableOverrideID int) (*EnvironmentVariableJobOverride, error)
 - func (c *Client) GetExtendedAttributes(projectId int, extendedAttributesID int) (*ExtendedAttributes, error)
 - func (c *Client) GetFabricCredential(projectId int, credentialId int) (*FabricCredential, error)
 - func (c *Client) GetGlobalConnectionAdapter(connectionID int64) (*GlobalConnectionAdapter, error)
 - func (c *Client) GetGroup(groupID int) (*Group, error)
 - func (c *Client) GetIPRestrictions() (*IPRestrictions, error)
 - func (c *Client) GetIPRestrictionsRule(ruleID int64) (*IPRestrictionsRule, error)
 - func (c *Client) GetJob(jobID string) (*Job, error)
 - func (c *Client) GetLicenseMap(licenseMapId int) (*LicenseMap, error)
 - func (c *Client) GetLineageIntegration(projectID int64, lineageIntegrationID int64) (*LineageIntegration, error)
 - func (c *Client) GetModelNotifications(environmentID string) (*ModelNotifications, error)
 - func (c *Client) GetNotification(notificationID string) (*Notification, error)
 - func (c *Client) GetOAuthConfiguration(oAuthConfigurationID int64) (*OAuthConfiguration, error)
 - func (c *Client) GetPermissionIDs() ([]string, error)
 - func (c *Client) GetPostgresCredential(projectId int, credentialId int) (*PostgresCredential, error)
 - func (c *Client) GetPrivatelinkEndpoint(endpointName string, privatelinkEndpointURL string) (*PrivatelinkEndpoint, error)
 - func (c *Client) GetProject(projectID string) (*Project, error)
 - func (c *Client) GetProjectByName(projectName string) (*Project, error)
 - func (c *Client) GetRawData(url string) ([]json.RawMessage, error)
 - func (c *Client) GetRepository(repositoryID, projectID string) (*Repository, error)
 - func (c *Client) GetRun(runID int64) (*Run, error)
 - func (c *Client) GetRuns(filter *RunFilter) (*[]Run, error)
 - func (c *Client) GetSemanticLayerConfiguration(projectId int64, semanticLayerConfigId int64) (*SemanticLayerConfiguration, error)
 - func (c *Client) GetSemanticLayerCredential(id int64) (*SemanticLayerCredentials, error)
 - func (c *Client) GetServiceToken(serviceTokenID int) (*ServiceToken, error)
 - func (c *Client) GetServiceTokenPermissions(serviceTokenID int) (*[]ServiceTokenPermission, error)
 - func (c *Client) GetSnowflakeCredential(projectId int, credentialId int) (*SnowflakeCredential, error)
 - func (c *Client) GetStarburstCredential(projectId int, credentialId int) (*StarburstCredentialData, error)
 - func (c *Client) GetTeradataCredential(projectId int, credentialId int) (*TeradataCredentialData, error)
 - func (c *Client) GetUser(email string) (*User, error)
 - func (c *Client) GetUserGroups(userId int) (*UserGroupsCurrentAccount, error)
 - func (c *Client) GetUsers() ([]User, error)
 - func (c *Client) GetWebhook(webhookID string) (*WebhookRead, error)
 - func (c *Client) RetryRun(runID int64) (*Run, error)
 - func (c *Client) TriggerRun(jobID int, gitSHA string, gitBranch string, githubPullRequestID string, ...) (*Run, error)
 - func (c *Client) UpdateAccountFeature(feature string, value bool) error
 - func (c *Client) UpdateAthenaCredential(projectId int, credentialId int, athenaCredential AthenaCredentialRequest) (*AthenaCredentialData, error)
 - func (c *Client) UpdateBigQueryCredential(projectId int, credentialId int, BigQueryCredential BigQueryCredential) (*BigQueryCredential, error)
 - func (c *Client) UpdateDatabricksCredentialGlobConn(projectId int, credentialId int, ...) (*DatabricksCredential, error)
 - func (c *Client) UpdateEnvironment(projectId int, environmentId int, environment Environment) (*Environment, error)
 - func (c *Client) UpdateEnvironmentVariable(projectID int, environmentVariable AbstractedEnvironmentVariable) (*AbstractedEnvironmentVariable, error)
 - func (c *Client) UpdateEnvironmentVariableJobOverride(projectID int, environmentVariableJobOverrideID int, ...) (*EnvironmentVariableJobOverride, error)
 - func (c *Client) UpdateExtendedAttributes(projectId int, extendedAttributesID int, extendedAttributes ExtendedAttributes) (*ExtendedAttributes, error)
 - func (c *Client) UpdateFabricCredential(projectId int, credentialId int, fabricCredential FabricCredential) (*FabricCredential, error)
 - func (c *Client) UpdateGroup(groupID int, group Group) (*Group, error)
 - func (c *Client) UpdateGroupPermissions(groupID int, groupPermissions []GroupPermission) (*[]GroupPermission, error)
 - func (c *Client) UpdateIPRestrictionsRule(ipRestrictionsId string, ipRestrictions IPRestrictionsRule) (*IPRestrictionsRule, error)
 - func (c *Client) UpdateJob(jobId string, job Job) (*Job, error)
 - func (c *Client) UpdateLicenseMap(licenseMapID int, licenseMap LicenseMap) (*LicenseMap, error)
 - func (c *Client) UpdateLineageIntegration(projectID int64, lineageIntegrationID int64, ...) (*LineageIntegration, error)
 - func (c *Client) UpdateModelNotifications(environmentID string, modelNotifications ModelNotifications) (*ModelNotifications, error)
 - func (c *Client) UpdateNotification(notificationId string, notification Notification) (*Notification, error)
 - func (c *Client) UpdateOAuthConfiguration(oAuthConfigurationID int64, oAuthConfiguration OAuthConfiguration) (*OAuthConfiguration, error)
 - func (c *Client) UpdatePostgresCredential(projectId int, credentialId int, postgresCredential PostgresCredential) (*PostgresCredential, error)
 - func (c *Client) UpdateProject(projectID string, project Project) (*Project, error)
 - func (c *Client) UpdateRepository(repositoryID, projectID string, repository Repository) (*Repository, error)
 - func (c *Client) UpdateSemanticLayerConfiguration(projectId int64, semanticLayerConfigId int64, ...) (*SemanticLayerConfiguration, error)
 - func (c *Client) UpdateSemanticLayerCredential(credentialId int64, credential SemanticLayerCredentials) (*SemanticLayerCredentials, error)
 - func (c *Client) UpdateServiceToken(serviceTokenID int, serviceToken ServiceToken) (*ServiceToken, error)
 - func (c *Client) UpdateServiceTokenPermissions(serviceTokenID int, serviceTokenPermissions []ServiceTokenPermission) (*[]ServiceTokenPermission, error)
 - func (c *Client) UpdateSnowflakeCredential(projectId int, credentialId int, snowflakeCredential SnowflakeCredential) (*SnowflakeCredential, error)
 - func (c *Client) UpdateStarburstCredential(projectId int, credentialId int, ...) (*StarburstCredentialData, error)
 - func (c *Client) UpdateTeradataCredential(projectId int, credentialId int, teradataCredential TeradataCredentialRequest) (*TeradataCredentialData, error)
 - func (c *Client) UpdateWebhook(webhookId string, webhook WebhookWrite) (*WebhookRead, error)
 
- type Constants
 - type ConstantsResponse
 - type CreateEnvironmentVariableResponse
 - type CreateEnvironmentVariableResponseMessage
 - type CurrentUser
 - type CurrentUserResponse
 - type DatabricksConfig
 - type DatabricksCredential
 - type DatabricksCredentialGLobConnPatch
 - type DatabricksCredentialGlobConn
 - type DatabricksCredentialListResponse
 - type DatabricksCredentialResponse
 - type DatabricksUnencryptedCredentialDetails
 - type DeployKey
 - type EmptyConfig
 - type Environment
 - type EnvironmentCategory
 - type EnvironmentResponse
 - type EnvironmentVariableJobOverride
 - type EnvironmentVariableJobOverrideAllResponse
 - type EnvironmentVariableJobOverrideResponse
 - type EnvironmentVariableNameValue
 - type EnvironmentVariablesGet
 - type ExtendedAttributes
 - type ExtendedAttributesResponse
 - type Extra
 - type FabricConfig
 - type FabricCredential
 - type FabricCredentialListResponse
 - type FabricCredentialResponse
 - type FabricUnencryptedCredentialDetails
 - type FullEnvironmentVariable
 - type GetEnvironmentVariableResponse
 - type GlobalConnectionAdapter
 - type GlobalConnectionClient
 - func (c *GlobalConnectionClient[T]) Create(common GlobalConnectionCommon, config T) (*GlobalConnectionCommon, *T, error)
 - func (c *GlobalConnectionClient[T]) CreateUpdateEncryption(encryptionPayload GlobalConnectionEncryptionPayload) (*GlobalConnectionEncryptionPayload, error)
 - func (c *GlobalConnectionClient[T]) Get(connectionID int64) (*GlobalConnectionCommon, *T, error)
 - func (c *GlobalConnectionClient[T]) GetEncryptionsForConnection(connectionID int64) (*[]GlobalConnectionEncryptionPayload, error)
 - func (c *GlobalConnectionClient[T]) Update(connectionID int64, common GlobalConnectionCommon, config T) (*GlobalConnectionCommon, *T, error)
 
- type GlobalConnectionCommon
 - type GlobalConnectionConfig
 - type GlobalConnectionEncryptionPayload
 - type GlobalConnectionSummary
 - type Group
 - type GroupPermission
 - type GroupPermissionListResponse
 - type GroupResponse
 - type IPRestrictions
 - type IPRestrictionsResponse
 - type IPRestrictionsRule
 - type IPRestrictionsRuleResponse
 - type Job
 - type JobCompletionTrigger
 - type JobCompletionTriggerCondition
 - type JobExecution
 - type JobResponse
 - type JobSchedule
 - type JobSettings
 - type JobTrigger
 - type JobWithEnvironment
 - type LicenseMap
 - type LicenseMapResponse
 - type LineageIntegration
 - type LineageIntegrationConfig
 - type LineageIntegrationResponse
 - type ModelNotifications
 - type ModelNotificationsResponse
 - type Notification
 - type NotificationResponse
 - type OAuthConfiguration
 - type OAuthConfigurationExtra
 - type OAuthConfigurationListResponse
 - type OAuthConfigurationResponse
 - type Pagination
 - type Permission
 - type PostgresConfig
 - type PostgresCredential
 - type PostgresCredentialResponse
 - type PrivatelinkEndpoint
 - type PrivatelinkEndpointListResponse
 - type PrivatelinkEndpointResponse
 - type Project
 - type ProjectConnectionRepository
 - type ProjectListResponse
 - type ProjectResponse
 - type RawResponse
 - type RedshiftConfig
 - type Repository
 - type RepositoryListResponse
 - type RepositoryResponse
 - type Response
 - type ResponseExtra
 - type ResponseExtraFilters
 - type ResponseExtraPagination
 - type ResponseStatus
 - type Run
 - type RunFilter
 - type RunResponse
 - type RunsResponse
 - type SemanticLayerConfiguration
 - type SemanticLayerConfigurationResponse
 - type SemanticLayerCredentialResponse
 - type SemanticLayerCredentials
 - type SemanticLayerCredentialsFilter
 - type SemanticLayerCredentialsResponse
 - type ServiceToken
 - type ServiceTokenListResponse
 - type ServiceTokenPermission
 - type ServiceTokenPermissionListResponse
 - type ServiceTokenResponse
 - type SnowflakeConfig
 - type SnowflakeCredential
 - type SnowflakeCredentialResponse
 - type StarburstConfig
 - type StarburstCredentialData
 - type StarburstCredentialRequest
 - type StarburstCredentialResponse
 - type StarburstUnencryptedCredentialDetails
 - type SynapseConfig
 - type TeradataConfig
 - type TeradataCredentialData
 - type TeradataCredentialRequest
 - type TeradataCredentialResponse
 - type TeradataUnencryptedCredentialDetails
 - type User
 - type UserGroups
 - type UserGroupsBody
 - type UserGroupsCurrentAccount
 - type UserGroupsResponse
 - type UserListResponse
 - type WebhookRead
 - type WebhookResponse
 - type WebhookWrite
 
Constants ¶
const ( DEFAULT_THREADS = 4 DEFAULT_TARGET_NAME = "default" DEFAULT_ATHENA_AUTH = "iam_user" )
const ( STATE_ACTIVE = 1 STATE_DELETED = 2 ID_DELIMITER = ":" NUM_THREADS_CREDENTIAL = 6 )
Variables ¶
var EnvironmentCategories = []EnvironmentCategory{ EnvironmentCategory_All, EnvironmentCategory_Development, EnvironmentCategory_Staging, EnvironmentCategory_Production, EnvironmentCategory_Other, }
EnvironmentCategories is a list of all possible environment categories
var FabricDriver = "ODBC Driver 18 for SQL Server"
    var (
	PermissionSets = []string{
		"owner",
		"member",
		"account_admin",
		"security_admin",
		"billing_admin",
		"admin",
		"database_admin",
		"git_admin",
		"team_admin",
		"job_admin",
		"job_runner",
		"job_viewer",
		"analyst",
		"developer",
		"stakeholder",
		"readonly",
		"project_creator",
		"account_viewer",
		"metadata_only",
		"semantic_layer_only",
		"webhooks_only",
	}
)
    var SynapseDriver = FabricDriver
    Right now Synapse and Fabric are the same If they diverge in the future, we can update the SynapseConfig struct
Functions ¶
This section is empty.
Types ¶
type APIError ¶ added in v0.2.1
type APIError struct {
	Data   interface{} `json:"data"`
	Status struct {
		Code             int    `json:"code"`
		DeveloperMessage string `json:"developer_message"`
		IsSuccess        bool   `json:"is_success"`
		UserMessage      string `json:"user_message"`
	} `json:"status"`
}
    Parses the error we get to see if it is a 404 for a missing resource
type AbstractedEnvironmentVariable ¶ added in v1.0.0
type AccountFeatureUpdateRequest ¶ added in v0.3.22
type AccountFeatures ¶ added in v0.3.22
type AccountFeaturesResponse ¶ added in v0.3.22
type AccountFeaturesResponse struct {
	Data   AccountFeatures `json:"data"`
	Status ResponseStatus  `json:"status"`
	Extra  ResponseExtra   `json:"extra"`
}
    type Adapter ¶
type Adapter struct {
	ID                      *int            `json:"id,omitempty"`
	AccountID               int             `json:"account_id"`
	ProjectID               int             `json:"project_id"`
	CreatedByID             *int            `json:"created_by_id,omitempty"`
	CreatedByServiceTokenID *int            `json:"created_by_service_token_id,omitempty"`
	Metadata                AdapterMetadata `json:"metadata_json"`
	State                   int             `json:"state"`
	AdapterVersion          string          `json:"adapter_version"`
	CreatedAt               *string         `json:"created_at,omitempty"`
	UpdatedAt               *string         `json:"updated_at,omitempty"`
}
    type AdapterCredentialDetails ¶ added in v0.2.17
type AdapterCredentialDetails struct {
	Fields      map[string]AdapterCredentialField `json:"fields"`
	Field_Order []string                          `json:"field_order"`
}
    func GenerateAthenaCredentialDetails ¶ added in v0.3.25
func GenerateAthenaCredentialDetails( awsAccessKeyId string, awsSecretAccessKey string, schema string, ) (AdapterCredentialDetails, error)
func GenerateDatabricksCredentialDetails ¶ added in v0.3.19
func GenerateFabricCredentialDetails ¶ added in v0.2.17
func GenerateStarburstCredentialDetails ¶ added in v0.3.26
func GenerateTeradataCredentialDetails ¶ added in v1.0.0
type AdapterCredentialField ¶ added in v0.2.17
type AdapterCredentialField struct {
	Metadata AdapterCredentialFieldMetadata `json:"metadata"`
	Value    interface{}                    `json:"value"`
}
    Value can actually be a string or an int (for threads)
type AdapterCredentialFieldMetadata ¶ added in v0.2.17
type AdapterCredentialFieldMetadata struct {
	Label        string                                   `json:"label"`
	Description  string                                   `json:"description"`
	Field_Type   string                                   `json:"field_type"`
	Encrypt      bool                                     `json:"encrypt"`
	Overrideable bool                                     `json:"overrideable"`
	Options      []AdapterCredentialFieldMetadataOptions  `json:"options,omitempty"`
	Validation   AdapterCredentialFieldMetadataValidation `json:"validation"`
}
    type AdapterCredentialFieldMetadataOptions ¶ added in v0.2.17
type AdapterCredentialFieldMetadataValidation ¶ added in v0.2.17
type AdapterCredentialFieldMetadataValidation struct {
	Required bool `json:"required"`
}
    type AdapterMetadata ¶
type AdapterResponse ¶
type AdapterResponse struct {
	Data   Adapter        `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type ApacheSparkConfig ¶ added in v0.3.13
type ApacheSparkConfig struct {
	Method         *string                   `json:"method,omitempty"`
	Host           *string                   `json:"host,omitempty"`
	Port           *int64                    `json:"port,omitempty"`
	Cluster        *string                   `json:"cluster,omitempty"`
	ConnectTimeout *int64                    `json:"connect_timeout,omitempty"`
	ConnectRetries *int64                    `json:"connect_retries,omitempty"`
	Organization   nullable.Nullable[string] `json:"organization,omitempty"`
	User           nullable.Nullable[string] `json:"user,omitempty"`
	Auth           nullable.Nullable[string] `json:"auth,omitempty"`
}
    func (ApacheSparkConfig) AdapterVersion ¶ added in v0.3.13
func (ApacheSparkConfig) AdapterVersion() string
type AssignUserGroupsResponse ¶ added in v0.2.4
type AssignUserGroupsResponse struct {
	Data   []Group        `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type AthenaConfig ¶ added in v0.3.13
type AthenaConfig struct {
	RegionName        *string                   `json:"region_name,omitempty"`
	Database          *string                   `json:"database,omitempty"`
	S3StagingDir      *string                   `json:"s3_staging_dir,omitempty"`
	WorkGroup         nullable.Nullable[string] `json:"work_group,omitempty"`
	SparkWorkGroup    nullable.Nullable[string] `json:"spark_work_group,omitempty"`
	S3DataDir         nullable.Nullable[string] `json:"s3_data_dir,omitempty"`
	S3DataNaming      nullable.Nullable[string] `json:"s3_data_naming,omitempty"`
	S3TmpTableDir     nullable.Nullable[string] `json:"s3_tmp_table_dir,omitempty"`
	PollInterval      nullable.Nullable[int64]  `json:"poll_interval,omitempty"`
	NumRetries        nullable.Nullable[int64]  `json:"num_retries,omitempty"`
	NumBoto3Retries   nullable.Nullable[int64]  `json:"num_boto3_retries,omitempty"`
	NumIcebergRetries nullable.Nullable[int64]  `json:"num_iceberg_retries,omitempty"`
}
    func (AthenaConfig) AdapterVersion ¶ added in v0.3.13
func (AthenaConfig) AdapterVersion() string
type AthenaCredentialData ¶ added in v0.3.25
type AthenaCredentialData struct {
	ID                           *int                               `json:"id"`
	AccountID                    int                                `json:"account_id"`
	ProjectID                    int                                `json:"project_id"`
	Type                         string                             `json:"type"`
	State                        int                                `json:"state"`
	Threads                      int                                `json:"threads"`
	TargetName                   string                             `json:"target_name"`
	AdapterVersion               string                             `json:"adapter_version,omitempty"`
	UnencryptedCredentialDetails AthenaUnencryptedCredentialDetails `json:"unencrypted_credential_details"`
}
    AthenaCredentialData represents the data returned by the API for an Athena credential
type AthenaCredentialRequest ¶ added in v0.3.25
type AthenaCredentialRequest struct {
	ID                *int                     `json:"id,omitempty"`
	AccountID         int                      `json:"account_id"`
	ProjectID         int                      `json:"project_id"`
	Type              string                   `json:"type"`
	State             int                      `json:"state"`
	Threads           int                      `json:"threads"`
	TargetName        string                   `json:"target_name"`
	AdapterVersion    string                   `json:"adapter_version,omitempty"`
	CredentialDetails AdapterCredentialDetails `json:"credential_details"`
}
    AthenaCredentialRequest is used for creating and updating Athena credentials It doesn't include the UnencryptedCredentialDetails field which is only returned by the API
type AthenaCredentialResponse ¶ added in v0.3.25
type AthenaCredentialResponse struct {
	Data   AthenaCredentialData `json:"data"`
	Status ResponseStatus       `json:"status"`
}
    type AthenaUnencryptedCredentialDetails ¶ added in v0.3.25
type AuthResponse ¶
type AuthResponse struct {
	Status ResponseStatus     `json:"status"`
	Data   []AuthResponseData `json:"data"`
}
    AuthResponse -
type AuthResponseData ¶
type AuthResponseData struct {
	DocsJobId                      int    `json:"docs_job_id"`
	FreshnessJobId                 int    `json:"freshness_job_id"`
	LockReason                     string `json:"lock_reason"`
	UnlockIfSubscriptionRenewed    bool   `json:"unlock_if_subscription_renewed"`
	ReadOnlySeats                  int    `json:"read_only_seats"`
	Id                             int    `json:"id"`
	Name                           string `json:"name"`
	State                          int    `json:"state"`
	Plan                           string `json:"plan"`
	PendingCancel                  bool   `json:"pending_cancel"`
	RunSlots                       int    `json:"run_slots"`
	DeveloperSeats                 int    `json:"developer_seats"`
	QueueLimit                     int    `json:"queue_limit"`
	PodMemoryRequestMebibytes      int    `json:"pod_memory_request_mebibytes"`
	RunDurationLimitSeconds        int    `json:"run_duration_limit_seconds"`
	EnterpriseAuthenticationMethod string `json:"enterprise_authentication_method"`
	EnterpriseLoginSlug            string `json:"enterprise_login_slug"`
	EnterpriseUniqueIdentifier     string `json:"enterprise_unique_identifier"`
	BillingEmailAddress            string `json:"billing_email_address"`
	Locked                         bool   `json:"locked"`
	DevelopFileSystem              bool   `json:"develop_file_system"`
	UnlockedAt                     string `json:"unlocked_at"`
	CreatedAt                      string `json:"created_at"`
	UpdatedAt                      string `json:"updated_at"`
	StarterRepoUrl                 string `json:"starter_repo_url"`
	SsoReauth                      bool   `json:"sso_reauth"`
	GitAuthLevel                   string `json:"git_auth_level"`
	DocsJob                        string `json:"docs_job"`
	FreshnessJob                   string `json:"freshness_job"`
	EnterpriseLoginUrl             string `json:"enterprise_login_url"`
}
    type AzureDevOpsProject ¶ added in v0.2.14
type AzureDevOpsProjectsData ¶ added in v0.2.14
type AzureDevOpsProjectsData struct {
	Count int                  `json:"count"`
	Value []AzureDevOpsProject `json:"value"`
}
    type AzureDevOpsProjectsResponse ¶ added in v0.2.14
type AzureDevOpsProjectsResponse struct {
	Data   AzureDevOpsProjectsData `json:"data"`
	Status ResponseStatus          `json:"status"`
}
    type AzureDevOpsRepositoriesData ¶ added in v0.2.14
type AzureDevOpsRepositoriesData struct {
	Count int                     `json:"count"`
	Value []AzureDevOpsRepository `json:"value"`
}
    type AzureDevOpsRepositoriesResponse ¶ added in v0.2.14
type AzureDevOpsRepositoriesResponse struct {
	Data   AzureDevOpsRepositoriesData `json:"data"`
	Status ResponseStatus              `json:"status"`
}
    type AzureDevOpsRepository ¶ added in v0.2.14
type BigQueryConfig ¶ added in v0.3.11
type BigQueryConfig struct {
	ProjectID                 *string                   `json:"project_id,omitempty"`
	TimeoutSeconds            *int64                    `json:"timeout_seconds,omitempty"`
	PrivateKeyID              *string                   `json:"private_key_id,omitempty"`
	PrivateKey                *string                   `json:"private_key,omitempty"`
	ClientEmail               *string                   `json:"client_email,omitempty"`
	ClientID                  *string                   `json:"client_id,omitempty"`
	AuthURI                   *string                   `json:"auth_uri,omitempty"`
	TokenURI                  *string                   `json:"token_uri,omitempty"`
	AuthProviderX509CertURL   *string                   `json:"auth_provider_x509_cert_url,omitempty"`
	ClientX509CertURL         *string                   `json:"client_x509_cert_url,omitempty"`
	Priority                  nullable.Nullable[string] `json:"priority,omitempty"`
	Retries                   *int64                    `json:"retries,omitempty"` //not nullable because there is a default in the UI
	Location                  nullable.Nullable[string] `json:"location,omitempty"`
	MaximumBytesBilled        nullable.Nullable[int64]  `json:"maximum_bytes_billed,omitempty"`
	ExecutionProject          nullable.Nullable[string] `json:"execution_project,omitempty"`
	ImpersonateServiceAccount nullable.Nullable[string] `json:"impersonate_service_account,omitempty"`
	JobRetryDeadlineSeconds   nullable.Nullable[int64]  `json:"job_retry_deadline_seconds,omitempty"`
	JobCreationTimeoutSeconds nullable.Nullable[int64]  `json:"job_creation_timeout_seconds,omitempty"`
	ApplicationID             nullable.Nullable[string] `json:"application_id,omitempty"`
	ApplicationSecret         nullable.Nullable[string] `json:"application_secret,omitempty"`
	GcsBucket                 nullable.Nullable[string] `json:"gcs_bucket,omitempty"`
	DataprocRegion            nullable.Nullable[string] `json:"dataproc_region,omitempty"`
	DataprocClusterName       nullable.Nullable[string] `json:"dataproc_cluster_name,omitempty"`
	Scopes                    []string                  `json:"scopes,omitempty"` //not nullable because there is a default in the UI
}
    func (BigQueryConfig) AdapterVersion ¶ added in v0.3.11
func (BigQueryConfig) AdapterVersion() string
type BigQueryCredential ¶
type BigQueryCredentialResponse ¶
type BigQueryCredentialResponse struct {
	Data   BigQueryCredential `json:"data"`
	Status ResponseStatus     `json:"status"`
}
    type Cidrs ¶ added in v0.3.22
type Cidrs struct {
	ID                  int64  `json:"id,omitempty"`
	IPRestrictionRuleID int64  `json:"ip_restriction_rule_id,omitempty"`
	Cidr                string `json:"cidr,omitempty"`
	CidrIpv6            string `json:"cidr_ipv6,omitempty"`
	// not needed for TF
	State     int64  `json:"state,omitempty"`
	Enabled   bool   `json:"enabled,omitempty"`
	CreatedAt string `json:"created_at,omitempty"`
	UpdatedAt string `json:"updated_at,omitempty"`
}
    type Client ¶
type Client struct {
	HostURL    string
	HTTPClient *http.Client
	Token      string
	AccountURL string
	AccountID  int
}
    func (*Client) AssignUserGroups ¶ added in v0.2.4
func (c *Client) AssignUserGroups(userId int, groupIDs []int) (*AssignUserGroupsResponse, error)
func (*Client) CreateAthenaCredential ¶ added in v0.3.25
func (*Client) CreateBigQueryCredential ¶
func (*Client) CreateDatabricksCredential ¶
func (*Client) CreateEnvironment ¶
func (*Client) CreateEnvironmentVariable ¶
func (*Client) CreateEnvironmentVariableJobOverride ¶ added in v0.2.16
func (*Client) CreateExtendedAttributes ¶ added in v0.2.9
func (c *Client) CreateExtendedAttributes( state int, projectId int, extendedAttributes json.RawMessage, ) (*ExtendedAttributes, error)
func (*Client) CreateFabricCredential ¶ added in v0.2.17
func (*Client) CreateGroup ¶
func (*Client) CreateIPRestrictionsRule ¶ added in v0.3.22
func (c *Client) CreateIPRestrictionsRule( ipRestrictionsRule IPRestrictionsRule, ) (*IPRestrictionsRule, error)
func (*Client) CreateJob ¶
func (c *Client) CreateJob( projectId int, environmentId int, name string, description string, executeSteps []string, dbtVersion string, isActive bool, triggers map[string]any, numThreads int, targetName string, generateDocs bool, runGenerateSources bool, scheduleType string, scheduleInterval int, scheduleHours []int, scheduleDays []int, scheduleCron string, deferringJobId int, deferringEnvironmentID int, selfDeferring bool, timeoutSeconds int, triggersOnDraftPR bool, jobCompletionTriggerCondition map[string]any, runCompareChanges bool, runLint bool, errorsOnLintFailure bool, jobType string, compareChangesFlags string, ) (*Job, error)
func (*Client) CreateLicenseMap ¶ added in v0.2.6
func (c *Client) CreateLicenseMap(licenseType string, ssoLicenseMappingGroups []string) (*LicenseMap, error)
func (*Client) CreateLineageIntegration ¶ added in v0.3.20
func (*Client) CreateModelNotifications ¶ added in v0.3.25
func (*Client) CreateNotification ¶ added in v0.2.3
func (*Client) CreateOAuthConfiguration ¶ added in v0.3.21
func (*Client) CreatePostgresCredential ¶
func (c *Client) CreatePostgresCredential( projectId int, isActive bool, type_ string, defaultSchema string, targetName string, username string, password string, numThreads int, ) (*PostgresCredential, error)
CreatePostgresCredential creates a new Postgres credential
func (*Client) CreateProject ¶
func (*Client) CreateRepository ¶
func (c *Client) CreateRepository( projectID int, remoteUrl string, isActive bool, gitCloneStrategy string, gitlabProjectID int, githubInstallationID int, azureActiveDirectoryProjectID string, azureActiveDirectoryRepositoryID string, azureBypassWebhookRegistrationFailure bool, pullRequestURLTemplate string, ) (*Repository, error)
func (*Client) CreateSemanticLayerConfiguration ¶ added in v1.0.0
func (c *Client) CreateSemanticLayerConfiguration( projectId int64, environmentId int64, ) (*SemanticLayerConfiguration, error)
func (*Client) CreateSemanticLayerCredential ¶ added in v1.0.0
func (c *Client) CreateSemanticLayerCredential( projectId int64, isActive bool, database string, role string, warehouse string, schema string, user string, password string, privateKey string, privateKeyPassphrase string, authType string, numThreads int, name string, adapterVersion string, ) (*SemanticLayerCredentials, error)
func (*Client) CreateServiceToken ¶
func (c *Client) CreateServiceToken( name string, state int, ) (*ServiceToken, error)
func (*Client) CreateSnowflakeCredential ¶
func (*Client) CreateStarburstCredential ¶ added in v0.3.26
func (*Client) CreateTeradataCredential ¶ added in v1.0.0
func (*Client) CreateWebhook ¶
func (*Client) DeleteCredential ¶ added in v0.2.17
func (*Client) DeleteEnvironment ¶
func (*Client) DeleteEnvironmentVariable ¶
func (*Client) DeleteEnvironmentVariableJobOverride ¶ added in v0.2.16
func (*Client) DeleteExtendedAttributes ¶ added in v0.2.9
func (*Client) DeleteGlobalConnection ¶ added in v0.3.11
func (*Client) DeleteIPRestrictions ¶ added in v0.3.22
func (c *Client) DeleteIPRestrictions(ipRestrictions IPRestrictions) error
func (*Client) DeleteIPRestrictionsRule ¶ added in v0.3.22
func (*Client) DeleteLineageIntegration ¶ added in v0.3.20
func (*Client) DeleteOAuthConfiguration ¶ added in v0.3.21
func (*Client) DeletePostgresCredential ¶
DeletePostgresCredential deletes a Postgres credential by its ID
func (*Client) DeleteRepository ¶
func (*Client) DeleteSemanticLayerConfiguration ¶ added in v1.0.0
func (*Client) DeleteSemanticLayerCredential ¶ added in v1.0.0
func (*Client) DeleteServiceToken ¶
func (*Client) DestroyLicenseMap ¶ added in v0.2.6
func (*Client) GetAccountFeatures ¶ added in v0.3.22
func (c *Client) GetAccountFeatures() (*AccountFeatures, error)
func (*Client) GetAllConnections ¶ added in v0.3.15
func (c *Client) GetAllConnections() ([]GlobalConnectionSummary, error)
func (*Client) GetAllEnvironments ¶ added in v0.3.4
func (c *Client) GetAllEnvironments(projectID int) ([]Environment, error)
func (*Client) GetAllGroupIDsByName ¶ added in v0.3.3
func (*Client) GetAllJobs ¶ added in v0.3.10
func (c *Client) GetAllJobs(projectID int, environmentID int) ([]JobWithEnvironment, error)
func (*Client) GetAllLicenseMaps ¶ added in v0.3.6
func (c *Client) GetAllLicenseMaps() ([]LicenseMap, error)
func (*Client) GetAllNotifications ¶ added in v0.3.5
func (c *Client) GetAllNotifications() ([]Notification, error)
func (*Client) GetAllProjects ¶ added in v0.3.15
func (c *Client) GetAllProjects(nameContains string) ([]ProjectConnectionRepository, error)
func (*Client) GetAllServiceTokens ¶ added in v0.3.5
func (c *Client) GetAllServiceTokens() ([]ServiceToken, error)
func (*Client) GetAthenaCredential ¶ added in v0.3.25
func (c *Client) GetAthenaCredential( projectId int, credentialId int, ) (*AthenaCredentialData, error)
func (*Client) GetAzureDevOpsProject ¶ added in v0.2.14
func (c *Client) GetAzureDevOpsProject( projectName string, ) (*AzureDevOpsProject, error)
func (*Client) GetAzureDevOpsProjects ¶ added in v0.2.14
func (c *Client) GetAzureDevOpsProjects() ([]AzureDevOpsProject, error)
func (*Client) GetAzureDevOpsRepositories ¶ added in v0.2.14
func (c *Client) GetAzureDevOpsRepositories( azureDevOpsProjectID string, ) ([]AzureDevOpsRepository, error)
func (*Client) GetAzureDevOpsRepository ¶ added in v0.2.14
func (c *Client) GetAzureDevOpsRepository( repositoryName string, azureDevOpsProjectID string, ) (*AzureDevOpsRepository, error)
func (*Client) GetBigQueryCredential ¶
func (c *Client) GetBigQueryCredential( projectId int, credentialId int, ) (*BigQueryCredential, error)
func (*Client) GetConnectedUser ¶
func (*Client) GetConstants ¶ added in v0.2.22
func (*Client) GetDatabricksCredential ¶
func (c *Client) GetDatabricksCredential( projectId int, credentialId int, ) (*DatabricksCredential, error)
func (*Client) GetEndpoint ¶ added in v0.3.3
func (*Client) GetEnvironment ¶
func (c *Client) GetEnvironment(projectId int, environmentId int) (*Environment, error)
func (*Client) GetEnvironmentVariable ¶
func (c *Client) GetEnvironmentVariable( projectID int, environmentVariableName string, ) (*FullEnvironmentVariable, error)
func (*Client) GetEnvironmentVariableJobOverride ¶ added in v0.2.16
func (*Client) GetExtendedAttributes ¶ added in v0.2.9
func (c *Client) GetExtendedAttributes(projectId int, extendedAttributesID int) (*ExtendedAttributes, error)
func (*Client) GetFabricCredential ¶ added in v0.2.17
func (c *Client) GetFabricCredential( projectId int, credentialId int, ) (*FabricCredential, error)
func (*Client) GetGlobalConnectionAdapter ¶ added in v0.3.12
func (c *Client) GetGlobalConnectionAdapter(connectionID int64) (*GlobalConnectionAdapter, error)
func (*Client) GetIPRestrictions ¶ added in v0.3.22
func (c *Client) GetIPRestrictions() (*IPRestrictions, error)
func (*Client) GetIPRestrictionsRule ¶ added in v0.3.22
func (c *Client) GetIPRestrictionsRule(ruleID int64) (*IPRestrictionsRule, error)
func (*Client) GetLicenseMap ¶ added in v0.2.6
func (c *Client) GetLicenseMap(licenseMapId int) (*LicenseMap, error)
func (*Client) GetLineageIntegration ¶ added in v0.3.20
func (c *Client) GetLineageIntegration( projectID int64, lineageIntegrationID int64, ) (*LineageIntegration, error)
func (*Client) GetModelNotifications ¶ added in v0.3.25
func (c *Client) GetModelNotifications(environmentID string) (*ModelNotifications, error)
func (*Client) GetNotification ¶ added in v0.2.3
func (c *Client) GetNotification(notificationID string) (*Notification, error)
func (*Client) GetOAuthConfiguration ¶ added in v0.3.21
func (c *Client) GetOAuthConfiguration(oAuthConfigurationID int64) (*OAuthConfiguration, error)
func (*Client) GetPermissionIDs ¶ added in v0.2.22
func (*Client) GetPostgresCredential ¶
func (c *Client) GetPostgresCredential( projectId int, credentialId int, ) (*PostgresCredential, error)
GetPostgresCredential retrieves a specific Postgres credential by its ID
func (*Client) GetPrivatelinkEndpoint ¶
func (c *Client) GetPrivatelinkEndpoint(endpointName string, privatelinkEndpointURL string) (*PrivatelinkEndpoint, error)
func (*Client) GetProjectByName ¶ added in v0.2.10
func (*Client) GetRawData ¶ added in v0.3.23
func (c *Client) GetRawData(url string) ([]json.RawMessage, error)
func (*Client) GetRepository ¶
func (c *Client) GetRepository( repositoryID, projectID string, ) (*Repository, error)
func (*Client) GetSemanticLayerConfiguration ¶ added in v1.0.0
func (c *Client) GetSemanticLayerConfiguration(projectId int64, semanticLayerConfigId int64) (*SemanticLayerConfiguration, error)
func (*Client) GetSemanticLayerCredential ¶ added in v1.0.0
func (c *Client) GetSemanticLayerCredential(id int64) (*SemanticLayerCredentials, error)
func (*Client) GetServiceToken ¶
func (c *Client) GetServiceToken(serviceTokenID int) (*ServiceToken, error)
func (*Client) GetServiceTokenPermissions ¶
func (c *Client) GetServiceTokenPermissions(serviceTokenID int) (*[]ServiceTokenPermission, error)
func (*Client) GetSnowflakeCredential ¶
func (c *Client) GetSnowflakeCredential( projectId int, credentialId int, ) (*SnowflakeCredential, error)
func (*Client) GetStarburstCredential ¶ added in v0.3.26
func (c *Client) GetStarburstCredential( projectId int, credentialId int, ) (*StarburstCredentialData, error)
func (*Client) GetTeradataCredential ¶ added in v1.0.0
func (c *Client) GetTeradataCredential( projectId int, credentialId int, ) (*TeradataCredentialData, error)
func (*Client) GetUserGroups ¶ added in v0.2.4
func (c *Client) GetUserGroups(userId int) (*UserGroupsCurrentAccount, error)
func (*Client) GetWebhook ¶
func (c *Client) GetWebhook(webhookID string) (*WebhookRead, error)
func (*Client) TriggerRun ¶ added in v1.0.0
func (*Client) UpdateAccountFeature ¶ added in v0.3.22
func (*Client) UpdateAthenaCredential ¶ added in v0.3.25
func (c *Client) UpdateAthenaCredential( projectId int, credentialId int, athenaCredential AthenaCredentialRequest, ) (*AthenaCredentialData, error)
func (*Client) UpdateBigQueryCredential ¶
func (c *Client) UpdateBigQueryCredential( projectId int, credentialId int, BigQueryCredential BigQueryCredential, ) (*BigQueryCredential, error)
func (*Client) UpdateDatabricksCredentialGlobConn ¶ added in v0.3.19
func (c *Client) UpdateDatabricksCredentialGlobConn( projectId int, credentialId int, databricksCredential DatabricksCredentialGLobConnPatch, ) (*DatabricksCredential, error)
func (*Client) UpdateEnvironment ¶
func (c *Client) UpdateEnvironment( projectId int, environmentId int, environment Environment, ) (*Environment, error)
func (*Client) UpdateEnvironmentVariable ¶
func (c *Client) UpdateEnvironmentVariable( projectID int, environmentVariable AbstractedEnvironmentVariable, ) (*AbstractedEnvironmentVariable, error)
func (*Client) UpdateEnvironmentVariableJobOverride ¶ added in v0.2.16
func (c *Client) UpdateEnvironmentVariableJobOverride( projectID int, environmentVariableJobOverrideID int, environmentVariableJobOverride EnvironmentVariableJobOverride, ) (*EnvironmentVariableJobOverride, error)
func (*Client) UpdateExtendedAttributes ¶ added in v0.2.9
func (c *Client) UpdateExtendedAttributes(projectId int, extendedAttributesID int, extendedAttributes ExtendedAttributes) (*ExtendedAttributes, error)
func (*Client) UpdateFabricCredential ¶ added in v0.2.17
func (c *Client) UpdateFabricCredential( projectId int, credentialId int, fabricCredential FabricCredential, ) (*FabricCredential, error)
func (*Client) UpdateGroupPermissions ¶
func (c *Client) UpdateGroupPermissions( groupID int, groupPermissions []GroupPermission, ) (*[]GroupPermission, error)
func (*Client) UpdateIPRestrictionsRule ¶ added in v0.3.22
func (c *Client) UpdateIPRestrictionsRule( ipRestrictionsId string, ipRestrictions IPRestrictionsRule, ) (*IPRestrictionsRule, error)
func (*Client) UpdateLicenseMap ¶ added in v0.2.6
func (c *Client) UpdateLicenseMap(licenseMapID int, licenseMap LicenseMap) (*LicenseMap, error)
func (*Client) UpdateLineageIntegration ¶ added in v0.3.20
func (c *Client) UpdateLineageIntegration( projectID int64, lineageIntegrationID int64, lineageIntegration LineageIntegration, ) (*LineageIntegration, error)
func (*Client) UpdateModelNotifications ¶ added in v0.3.25
func (c *Client) UpdateModelNotifications( environmentID string, modelNotifications ModelNotifications, ) (*ModelNotifications, error)
func (*Client) UpdateNotification ¶ added in v0.2.3
func (c *Client) UpdateNotification( notificationId string, notification Notification, ) (*Notification, error)
func (*Client) UpdateOAuthConfiguration ¶ added in v0.3.21
func (c *Client) UpdateOAuthConfiguration( oAuthConfigurationID int64, oAuthConfiguration OAuthConfiguration, ) (*OAuthConfiguration, error)
func (*Client) UpdatePostgresCredential ¶
func (c *Client) UpdatePostgresCredential( projectId int, credentialId int, postgresCredential PostgresCredential, ) (*PostgresCredential, error)
UpdatePostgresCredential updates an existing Postgres credential
func (*Client) UpdateProject ¶
func (*Client) UpdateRepository ¶
func (c *Client) UpdateRepository( repositoryID, projectID string, repository Repository, ) (*Repository, error)
func (*Client) UpdateSemanticLayerConfiguration ¶ added in v1.0.0
func (c *Client) UpdateSemanticLayerConfiguration( projectId int64, semanticLayerConfigId int64, semanticLayerConfig SemanticLayerConfiguration) (*SemanticLayerConfiguration, error)
func (*Client) UpdateSemanticLayerCredential ¶ added in v1.0.0
func (c *Client) UpdateSemanticLayerCredential( credentialId int64, credential SemanticLayerCredentials) (*SemanticLayerCredentials, error)
func (*Client) UpdateServiceToken ¶
func (c *Client) UpdateServiceToken(serviceTokenID int, serviceToken ServiceToken) (*ServiceToken, error)
func (*Client) UpdateServiceTokenPermissions ¶
func (c *Client) UpdateServiceTokenPermissions(serviceTokenID int, serviceTokenPermissions []ServiceTokenPermission) (*[]ServiceTokenPermission, error)
func (*Client) UpdateSnowflakeCredential ¶
func (c *Client) UpdateSnowflakeCredential( projectId int, credentialId int, snowflakeCredential SnowflakeCredential, ) (*SnowflakeCredential, error)
func (*Client) UpdateStarburstCredential ¶ added in v0.3.26
func (c *Client) UpdateStarburstCredential( projectId int, credentialId int, starburstCredential StarburstCredentialRequest, ) (*StarburstCredentialData, error)
func (*Client) UpdateTeradataCredential ¶ added in v1.0.0
func (c *Client) UpdateTeradataCredential( projectId int, credentialId int, teradataCredential TeradataCredentialRequest, ) (*TeradataCredentialData, error)
func (*Client) UpdateWebhook ¶
func (c *Client) UpdateWebhook(webhookId string, webhook WebhookWrite) (*WebhookRead, error)
type ConstantsResponse ¶ added in v0.2.22
type ConstantsResponse struct {
	Data   Constants      `json:"data"`
	Status ResponseStatus `json:"status"`
}
    This is not used now but allows us to find the list of permission sets allowed Terraform doesn't allow to run it in the offline validation mode though as we don't have access to the configuration context
type CreateEnvironmentVariableResponse ¶
type CreateEnvironmentVariableResponse struct {
	Data   CreateEnvironmentVariableResponseMessage `json:"data"`
	Status ResponseStatus                           `json:"status"`
}
    type CurrentUser ¶
type CurrentUser struct {
	User User `json:"user"`
}
    type CurrentUserResponse ¶
type CurrentUserResponse struct {
	Data   CurrentUser    `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type DatabricksConfig ¶ added in v0.3.12
type DatabricksConfig struct {
	Host         *string                   `json:"host,omitempty"`
	HTTPPath     *string                   `json:"http_path,omitempty"`
	Catalog      nullable.Nullable[string] `json:"catalog,omitempty"`
	ClientID     nullable.Nullable[string] `json:"client_id,omitempty"`
	ClientSecret nullable.Nullable[string] `json:"client_secret,omitempty"`
}
    func (DatabricksConfig) AdapterVersion ¶ added in v0.3.12
func (DatabricksConfig) AdapterVersion() string
type DatabricksCredential ¶
type DatabricksCredential struct {
	ID                           *int                                   `json:"id"`
	Account_Id                   int                                    `json:"account_id"`
	Project_Id                   int                                    `json:"project_id"`
	Type                         string                                 `json:"type"`
	State                        int                                    `json:"state"`
	Threads                      int                                    `json:"threads"`
	Target_Name                  string                                 `json:"target_name"`
	AdapterVersion               string                                 `json:"adapter_version,omitempty"`
	Credential_Details           AdapterCredentialDetails               `json:"credential_details"`
	UnencryptedCredentialDetails DatabricksUnencryptedCredentialDetails `json:"unencrypted_credential_details"`
}
    type DatabricksCredentialGLobConnPatch ¶ added in v0.3.19
type DatabricksCredentialGLobConnPatch struct {
	ID                int                      `json:"id"`
	CredentialDetails AdapterCredentialDetails `json:"credential_details"`
}
    type DatabricksCredentialGlobConn ¶ added in v0.3.19
type DatabricksCredentialGlobConn struct {
	ID                *int                     `json:"id"`
	AccountID         int                      `json:"account_id"`
	ProjectID         int                      `json:"project_id"`
	Type              string                   `json:"type"`
	State             int                      `json:"state"`
	Threads           int                      `json:"threads"`
	AdapterVersion    string                   `json:"adapter_version"`
	CredentialDetails AdapterCredentialDetails `json:"credential_details"`
}
    type DatabricksCredentialListResponse ¶
type DatabricksCredentialListResponse struct {
	Data   []DatabricksCredential `json:"data"`
	Status ResponseStatus         `json:"status"`
}
    type DatabricksCredentialResponse ¶
type DatabricksCredentialResponse struct {
	Data   DatabricksCredential `json:"data"`
	Status ResponseStatus       `json:"status"`
}
    type EmptyConfig ¶ added in v0.3.15
type EmptyConfig struct {
}
    func (EmptyConfig) AdapterVersion ¶ added in v0.3.15
func (EmptyConfig) AdapterVersion() string
type Environment ¶
type Environment struct {
	ID                           *int                 `json:"id,omitempty"`
	State                        int                  `json:"state,omitempty"`
	Account_Id                   int                  `json:"account_id"`
	Project_Id                   int                  `json:"project_id"`
	Credential_Id                *int                 `json:"credentials_id,omitempty"`
	Name                         string               `json:"name"`
	Dbt_Version                  string               `json:"dbt_version"`
	Type                         string               `json:"type"`
	Use_Custom_Branch            bool                 `json:"use_custom_branch"`
	Custom_Branch                *string              `json:"custom_branch"`
	Environment_Id               *int                 `json:"-"` //TODO: check why this is here
	Support_Docs                 bool                 `json:"supports_docs"`
	Created_At                   *string              `json:"created_at"`
	Updated_At                   *string              `json:"updated_at"`
	Project                      Project              `json:"project"`
	Jobs                         *string              `json:"jobs"`
	Credentials                  *SnowflakeCredential `json:"credentials"`
	Custom_Environment_Variables *string              `json:"custom_environment_variables"`
	DeploymentType               *string              `json:"deployment_type,omitempty"`
	ExtendedAttributesID         *int                 `json:"extended_attributes_id,omitempty"`
	ConnectionID                 *int                 `json:"connection_id,omitempty"`
	EnableModelQueryHistory      bool                 `json:"enable_model_query_history,omitempty"`
}
    type EnvironmentCategory ¶ added in v0.3.10
type EnvironmentCategory = string
EnvironmentCategory is a type for the different environment categories
const ( // All is the category for all environments EnvironmentCategory_All EnvironmentCategory = "all" // Development is the category for development environments EnvironmentCategory_Development EnvironmentCategory = "development" // Staging is the category for staging environments EnvironmentCategory_Staging EnvironmentCategory = "staging" // Production is the category for production environments EnvironmentCategory_Production EnvironmentCategory = "production" // Other is the category for other environments EnvironmentCategory_Other EnvironmentCategory = "other" )
type EnvironmentResponse ¶
type EnvironmentResponse struct {
	Data   Environment    `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type EnvironmentVariableJobOverride ¶ added in v0.2.16
type EnvironmentVariableJobOverrideAllResponse ¶ added in v0.2.16
type EnvironmentVariableJobOverrideAllResponse struct {
	Data   any            `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type EnvironmentVariableJobOverrideResponse ¶ added in v0.2.16
type EnvironmentVariableJobOverrideResponse struct {
	Data   EnvironmentVariableJobOverride `json:"data"`
	Status ResponseStatus                 `json:"status"`
}
    type EnvironmentVariablesGet ¶
type EnvironmentVariablesGet struct {
	Environment []string                                           `json:"environments"`
	Variables   map[string]map[string]EnvironmentVariableNameValue `json:"variables"`
}
    type ExtendedAttributes ¶ added in v0.2.9
type ExtendedAttributesResponse ¶ added in v0.2.9
type ExtendedAttributesResponse struct {
	Data   ExtendedAttributes `json:"data"`
	Status ResponseStatus     `json:"status"`
}
    type Extra ¶ added in v0.3.3
type Extra struct {
	Pagination Pagination `json:"pagination"`
}
    type FabricConfig ¶ added in v0.3.13
type FabricConfig struct {
	Driver       *string `json:"driver,omitempty"`
	Server       *string `json:"server,omitempty"`
	Port         *int64  `json:"port,omitempty"`
	Database     *string `json:"database,omitempty"`
	Retries      *int64  `json:"retries,omitempty"`
	LoginTimeout *int64  `json:"login_timeout,omitempty"`
	QueryTimeout *int64  `json:"query_timeout,omitempty"`
}
    func (FabricConfig) AdapterVersion ¶ added in v0.3.13
func (FabricConfig) AdapterVersion() string
type FabricCredential ¶ added in v0.2.17
type FabricCredential struct {
	ID                           *int                               `json:"id"`
	Account_Id                   int                                `json:"account_id"`
	Project_Id                   int                                `json:"project_id"`
	Type                         string                             `json:"type"`
	State                        int                                `json:"state"`
	Threads                      int                                `json:"threads"`
	AdapterVersion               string                             `json:"adapter_version"`
	CredentialDetails            AdapterCredentialDetails           `json:"credential_details"`
	UnencryptedCredentialDetails FabricUnencryptedCredentialDetails `json:"unencrypted_credential_details"`
}
    type FabricCredentialListResponse ¶ added in v0.2.17
type FabricCredentialListResponse struct {
	Data   []FabricCredential `json:"data"`
	Status ResponseStatus     `json:"status"`
}
    type FabricCredentialResponse ¶ added in v0.2.17
type FabricCredentialResponse struct {
	Data   FabricCredential `json:"data"`
	Status ResponseStatus   `json:"status"`
}
    type FabricUnencryptedCredentialDetails ¶ added in v0.2.17
type FullEnvironmentVariable ¶ added in v1.0.0
type FullEnvironmentVariable struct {
	Name                  string
	ProjectID             int
	EnvironmentNameValues map[string]EnvironmentVariableNameValue
}
    type GetEnvironmentVariableResponse ¶
type GetEnvironmentVariableResponse struct {
	Data   EnvironmentVariablesGet `json:"data"`
	Status ResponseStatus          `json:"status"`
}
    type GlobalConnectionAdapter ¶ added in v0.3.12
type GlobalConnectionAdapter struct {
	Data struct {
		ID             int64  `json:"id"`
		AdapterVersion string `json:"adapter_version"`
	} `json:"data"`
}
    TODO: Could be improved in the future, maybe creating a client with empty Config For now, I couldn't use it as the AdapterVersion is not returned in the GET response To be revisited when we handle different versions for the same adapter
type GlobalConnectionClient ¶ added in v0.3.11
type GlobalConnectionClient[T GlobalConnectionConfig] struct{ *Client }
    func NewGlobalConnectionClient ¶ added in v0.3.11
func NewGlobalConnectionClient[T GlobalConnectionConfig](c *Client) GlobalConnectionClient[T]
func (*GlobalConnectionClient[T]) Create ¶ added in v0.3.11
func (c *GlobalConnectionClient[T]) Create( common GlobalConnectionCommon, config T, ) (*GlobalConnectionCommon, *T, error)
func (*GlobalConnectionClient[T]) CreateUpdateEncryption ¶ added in v0.3.13
func (c *GlobalConnectionClient[T]) CreateUpdateEncryption( encryptionPayload GlobalConnectionEncryptionPayload, ) (*GlobalConnectionEncryptionPayload, error)
func (*GlobalConnectionClient[T]) Get ¶ added in v0.3.11
func (c *GlobalConnectionClient[T]) Get(connectionID int64) (*GlobalConnectionCommon, *T, error)
func (*GlobalConnectionClient[T]) GetEncryptionsForConnection ¶ added in v0.3.13
func (c *GlobalConnectionClient[T]) GetEncryptionsForConnection( connectionID int64, ) (*[]GlobalConnectionEncryptionPayload, error)
func (*GlobalConnectionClient[T]) Update ¶ added in v0.3.11
func (c *GlobalConnectionClient[T]) Update( connectionID int64, common GlobalConnectionCommon, config T, ) (*GlobalConnectionCommon, *T, error)
type GlobalConnectionCommon ¶ added in v0.3.11
type GlobalConnectionCommon struct {
	ID                    *int64                    `json:"id,omitempty"`
	Name                  *string                   `json:"name,omitempty"`
	IsSshTunnelEnabled    *bool                     `json:"is_ssh_tunnel_enabled,omitempty"`
	PrivateLinkEndpointId nullable.Nullable[string] `json:"private_link_endpoint_id,omitempty"`
	OauthConfigurationId  nullable.Nullable[int64]  `json:"oauth_configuration_id,omitempty"`
}
    type GlobalConnectionConfig ¶ added in v0.3.11
type GlobalConnectionConfig interface {
	AdapterVersion() string
}
    type GlobalConnectionEncryptionPayload ¶ added in v0.3.13
type GlobalConnectionEncryptionPayload struct {
	ID           *int64 `json:"id"`
	AccountID    int64  `json:"account_id"`
	ConnectionID int64  `json:"connection_id"`
	Username     string `json:"username,omitempty"`
	Port         int64  `json:"port,omitempty"`
	HostName     string `json:"hostname,omitempty"`
	PublicKey    string `json:"public_key,omitempty"`
	State        int64  `json:"state,omitempty"`
}
    type GlobalConnectionSummary ¶ added in v0.3.15
type GlobalConnectionSummary struct {
	ID                    int64   `json:"id"`
	CreatedAt             string  `json:"created_at"`
	UpdatedAt             string  `json:"updated_at"`
	AccountID             int64   `json:"account_id"`
	Name                  string  `json:"name"`
	AdapterVersion        string  `json:"adapter_version"`
	PrivateLinkEndpointID *string `json:"private_link_endpoint_id"`
	IsSSHTunnelEnabled    bool    `json:"is_ssh_tunnel_enabled"`
	OauthConfigurationID  *int64  `json:"oauth_configuration_id"`
	EnvironmentCount      int64   `json:"environment__count"`
}
    type GroupPermission ¶
type GroupPermission struct {
	ID                            *int     `json:"id,omitempty"`
	AccountID                     int      `json:"account_id"`
	GroupID                       int      `json:"group_id"`
	ProjectID                     int      `json:"project_id,omitempty"`
	AllProjects                   bool     `json:"all_projects"`
	State                         int      `json:"state,omitempty"`
	Set                           string   `json:"permission_set,omitempty"`
	Level                         string   `json:"permission_level,omitempty"`
	WritableEnvironmentCategories []string `json:"writable_environment_categories,omitempty"` // TODO(cwalden): use environment_category.go#EnvironmentCategory ?
}
    type GroupPermissionListResponse ¶
type GroupPermissionListResponse struct {
	Data   []GroupPermission `json:"data"`
	Status ResponseStatus    `json:"status"`
}
    type GroupResponse ¶
type GroupResponse struct {
	Data   Group          `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type IPRestrictions ¶ added in v0.3.22
type IPRestrictions []IPRestrictionsRule
type IPRestrictionsResponse ¶ added in v0.3.22
type IPRestrictionsResponse struct {
	Data   IPRestrictions `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type IPRestrictionsRule ¶ added in v0.3.22
type IPRestrictionsRule struct {
	ID                     int64   `json:"id,omitempty"`
	IPRestrictionRuleSetID int64   `json:"ip_restriction_rule_set_id,omitempty"`
	Name                   string  `json:"name"`
	Type                   int64   `json:"type"`
	AccountID              int64   `json:"account_id,omitempty"`
	Description            string  `json:"description"`
	Cidrs                  []Cidrs `json:"cidrs,"`
	RuleSetEnabled         bool    `json:"rule_set_enabled"`
	// not needed for TF
	State                   int64 `json:"state,omitempty"`
	CreatedByID             int64 `json:"created_by_id,omitempty"`
	EnabledForServiceTokens bool  `json:"enabled_for_service_tokens,omitempty"`
}
    type IPRestrictionsRuleResponse ¶ added in v0.3.22
type IPRestrictionsRuleResponse struct {
	Data   IPRestrictionsRule `json:"data"`
	Status ResponseStatus     `json:"status"`
}
    type Job ¶
type Job struct {
	ID                     *int                  `json:"id"`
	AccountId              int                   `json:"account_id"`
	ProjectId              int                   `json:"project_id"`
	EnvironmentId          int                   `json:"environment_id"`
	Name                   string                `json:"name"`
	CompareChangesFlags    string                `json:"compare_changes_flags"`
	DbtVersion             *string               `json:"dbt_version"`
	DeferringEnvironmentId *int                  `json:"deferring_environment_id"`
	DeferringJobId         *int                  `json:"deferring_job_definition_id"`
	Description            string                `json:"description"`
	ErrorsOnLintFailure    bool                  `json:"errors_on_lint_failure"`
	ExecuteSteps           []string              `json:"execute_steps"`
	Execution              JobExecution          `json:"execution"`
	GenerateDocs           bool                  `json:"generate_docs"`
	JobCompletionTrigger   *JobCompletionTrigger `json:"job_completion_trigger_condition"`
	JobType                string                `json:"job_type,omitempty"`
	RunCompareChanges      bool                  `json:"run_compare_changes"`
	RunGenerateSources     bool                  `json:"run_generate_sources"`
	RunLint                bool                  `json:"run_lint"`
	Schedule               JobSchedule           `json:"schedule"`
	Settings               JobSettings           `json:"settings"`
	State                  int                   `json:"state"`
	TriggersOnDraftPR      bool                  `json:"triggers_on_draft_pr"`
	Triggers               JobTrigger            `json:"triggers"`
}
    type JobCompletionTrigger ¶ added in v0.2.20
type JobCompletionTrigger struct {
	Condition JobCompletionTriggerCondition `json:"condition"`
}
    type JobCompletionTriggerCondition ¶ added in v0.2.20
type JobExecution ¶
type JobExecution struct {
	TimeoutSeconds int `json:"timeout_seconds"`
}
    type JobResponse ¶
type JobResponse struct {
	Data   Job            `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type JobSchedule ¶
type JobSchedule struct {
	Cron string       `json:"cron"`
	Date scheduleDate `json:"date"`
	Time scheduleTime `json:"time"`
}
    type JobSettings ¶
type JobTrigger ¶
type JobWithEnvironment ¶ added in v0.3.10
type JobWithEnvironment struct {
	Job
	Environment Environment `json:"environment"`
}
    type LicenseMap ¶ added in v0.2.6
type LicenseMapResponse ¶ added in v0.2.6
type LicenseMapResponse struct {
	Data   LicenseMap     `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type LineageIntegration ¶ added in v0.3.20
type LineageIntegration struct {
	ID        *int64                   `json:"id,omitempty"`
	AccountID int64                    `json:"account_id,omitempty"`
	ProjectID int64                    `json:"project_id,omitempty"`
	Name      string                   `json:"name,omitempty"`
	Config    LineageIntegrationConfig `json:"config"`
}
    type LineageIntegrationConfig ¶ added in v0.3.20
type LineageIntegrationResponse ¶ added in v0.3.20
type LineageIntegrationResponse struct {
	Data   LineageIntegration `json:"data"`
	Status ResponseStatus     `json:"status"`
}
    type ModelNotifications ¶ added in v0.3.25
type ModelNotifications struct {
	ID            *int   `json:"id,omitempty"`
	CreatedAt     string `json:"created_at,omitempty"`
	UpdatedAt     string `json:"updated_at,omitempty"`
	AccountID     int    `json:"account_id,omitempty"`
	EnvironmentID int    `json:"environment_id"`
	Enabled       bool   `json:"enabled"`
	OnSuccess     bool   `json:"on_success"`
	OnFailure     bool   `json:"on_failure"`
	OnWarning     bool   `json:"on_warning"`
	OnSkipped     bool   `json:"on_skipped"`
}
    type ModelNotificationsResponse ¶ added in v0.3.25
type ModelNotificationsResponse struct {
	Data   ModelNotifications `json:"data"`
	Status ResponseStatus     `json:"status"`
}
    type Notification ¶ added in v0.2.3
type Notification struct {
	Id               *int    `json:"id,omitempty"`
	AccountId        int     `json:"account_id"`
	UserId           int     `json:"user_id"`
	OnCancel         []int   `json:"on_cancel"`
	OnFailure        []int   `json:"on_failure"`
	OnWarning        []int   `json:"on_warning"`
	OnSuccess        []int   `json:"on_success"`
	State            int     `json:"state"`
	NotificationType int     `json:"type"`
	ExternalEmail    *string `json:"external_email"`
	SlackChannelID   *string `json:"slack_channel_id"`
	SlackChannelName *string `json:"slack_channel_name"`
}
    type NotificationResponse ¶ added in v0.2.3
type NotificationResponse struct {
	Data   Notification   `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type OAuthConfiguration ¶ added in v0.3.21
type OAuthConfiguration struct {
	ID                      *int64                   `json:"id,omitempty"`
	AccountId               int64                    `json:"account_id"`
	Type                    string                   `json:"type"`
	Name                    string                   `json:"name"`
	ClientId                string                   `json:"client_id"`
	ClientSecret            string                   `json:"client_secret"`
	AuthorizeUrl            string                   `json:"authorize_url"`
	TokenUrl                string                   `json:"token_url"`
	RedirectUri             string                   `json:"redirect_uri"`
	OAuthConfigurationExtra *OAuthConfigurationExtra `json:"extra_data,omitempty"`
}
    type OAuthConfigurationExtra ¶ added in v0.3.21
type OAuthConfigurationExtra struct {
	ApplicationIdUri *string `json:"application_id_uri,omitempty"`
}
    type OAuthConfigurationListResponse ¶ added in v0.3.21
type OAuthConfigurationListResponse struct {
	Data   []OAuthConfiguration `json:"data"`
	Status ResponseStatus       `json:"status"`
	Extra  ResponseExtra        `json:"extra"`
}
    type OAuthConfigurationResponse ¶ added in v0.3.21
type OAuthConfigurationResponse struct {
	Data   OAuthConfiguration `json:"data"`
	Status ResponseStatus     `json:"status"`
}
    type Pagination ¶ added in v0.3.3
type Permission ¶ added in v0.2.4
type PostgresConfig ¶ added in v0.3.13
type PostgresConfig struct {
	HostName *string                   `json:"hostname,omitempty"`
	Port     *int64                    `json:"port,omitempty"`
	DBName   nullable.Nullable[string] `json:"dbname,omitempty"`
}
    func (PostgresConfig) AdapterVersion ¶ added in v0.3.13
func (PostgresConfig) AdapterVersion() string
type PostgresCredential ¶
type PostgresCredential struct {
	ID             *int   `json:"id"`
	Account_Id     int    `json:"account_id"`
	Project_Id     int    `json:"project_id"`
	Type           string `json:"type"`
	State          int    `json:"state"`
	Threads        int    `json:"threads"`
	Username       string `json:"username"`
	Default_Schema string `json:"default_schema"`
	Target_Name    string `json:"target_name"`
	Password       string `json:"password,omitempty"`
}
    type PostgresCredentialResponse ¶
type PostgresCredentialResponse struct {
	Data   PostgresCredential `json:"data"`
	Status ResponseStatus     `json:"status"`
}
    type PrivatelinkEndpoint ¶
type PrivatelinkEndpointListResponse ¶
type PrivatelinkEndpointListResponse struct {
	Data   []PrivatelinkEndpoint `json:"data"`
	Status ResponseStatus        `json:"status"`
}
    type PrivatelinkEndpointResponse ¶
type PrivatelinkEndpointResponse struct {
	Data   PrivatelinkEndpoint `json:"data"`
	Status ResponseStatus      `json:"status"`
}
    type Project ¶
type Project struct {
	ID                     *int    `json:"id,omitempty"`
	Name                   string  `json:"name"`
	Description            string  `json:"description"`
	DbtProjectSubdirectory *string `json:"dbt_project_subdirectory,omitempty"`
	DbtProjectType         int64   `json:"type"`
	ConnectionID           *int    `json:"connection_id,omitempty"`
	RepositoryID           *int    `json:"repository_id,omitempty"`
	State                  int     `json:"state"`
	AccountID              int     `json:"account_id"`
	FreshnessJobId         *int    `json:"freshness_job_id"`
	DocsJobId              *int    `json:"docs_job_id,"`
}
    type ProjectConnectionRepository ¶ added in v0.3.15
type ProjectConnectionRepository struct {
	Name                   string                                `json:"name,omitempty"`
	AccountID              int64                                 `json:"account_id,omitempty"`
	Description            string                                `json:"description,omitempty"`
	ConnectionID           int64                                 `json:"connection_id,omitempty"`
	RepositoryID           int64                                 `json:"repository_id,omitempty"`
	SemanticLayerConfigID  *int64                                `json:"semantic_layer_config_id,omitempty"`
	SkippedSetup           bool                                  `json:"skipped_setup,omitempty"`
	State                  int64                                 `json:"state,omitempty"`
	DbtProjectSubdirectory string                                `json:"dbt_project_subdirectory,omitempty"`
	DocsJobID              *int64                                `json:"docs_job_id,omitempty"`
	DbtProjectType         int64                                 `json:"type"`
	FreshnessJobID         *int64                                `json:"freshness_job_id,omitempty"`
	ID                     int64                                 `json:"id,omitempty"`
	CreatedAt              string                                `json:"created_at,omitempty"`
	UpdatedAt              string                                `json:"updated_at,omitempty"`
	Connection             *globalConnectionPayload[EmptyConfig] `json:"connection,omitempty"`
	Environments           any                                   `json:"environments,omitempty"`
	Repository             *Repository                           `json:"repository,omitempty"`
	GroupPermissions       any                                   `json:"group_permissions,omitempty"`
	DocsJob                any                                   `json:"docs_job,omitempty"`
	FreshnessJob           any                                   `json:"freshness_job,omitempty"`
}
    type ProjectListResponse ¶
type ProjectListResponse struct {
	Data   []Project      `json:"data"`
	Status ResponseStatus `json:"status"`
	Extra  ResponseExtra  `json:"extra"`
}
    type ProjectResponse ¶
type ProjectResponse struct {
	Data   Project        `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type RawResponse ¶ added in v0.3.23
type RawResponse struct {
	Data  []json.RawMessage `json:"data"`
	Extra Extra             `json:"extra"`
}
    type RedshiftConfig ¶ added in v0.3.13
type RedshiftConfig struct {
	HostName *string                   `json:"hostname,omitempty"`
	Port     *int64                    `json:"port,omitempty"`
	DBName   nullable.Nullable[string] `json:"dbname,omitempty"`
}
    Redshift and Postgres are the same today but they might diverge in the future to support more authentication methods
func (RedshiftConfig) AdapterVersion ¶ added in v0.3.13
func (RedshiftConfig) AdapterVersion() string
type Repository ¶
type Repository struct {
	ID                                    *int       `json:"id,omitempty"`
	AccountID                             int        `json:"account_id"`
	ProjectID                             int        `json:"project_id"`
	RemoteUrl                             string     `json:"remote_url"`
	State                                 int        `json:"state"`
	AzureActiveDirectoryProjectID         *string    `json:"azure_active_directory_project_id,omitempty"`
	AzureActiveDirectoryRepositoryID      *string    `json:"azure_active_directory_repository_id,omitempty"`
	AzureBypassWebhookRegistrationFailure *bool      `json:"azure_bypass_webhook_registration_failure,omitempty"`
	GitCloneStrategy                      string     `json:"git_clone_strategy"`
	RepositoryCredentialsID               *int       `json:"repository_credentials_id,omitempty"`
	GitlabProjectID                       *int       `json:"gitlab_project_id,omitempty"`
	GithubInstallationID                  *int       `json:"github_installation_id,omitempty"`
	DeployKey                             *DeployKey `json:"deploy_key,omitempty"`
	DeployKeyID                           *int       `json:"deploy_key_id,omitempty"`
	PullRequestURLTemplate                string     `json:"pull_request_url_template,omitempty"`
}
    type RepositoryListResponse ¶
type RepositoryListResponse struct {
	Data   []Repository   `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type RepositoryResponse ¶
type RepositoryResponse struct {
	Data   Repository     `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type ResponseExtra ¶ added in v0.2.10
type ResponseExtra struct {
	Pagination ResponseExtraPagination `json:"pagination"`
	Filters    ResponseExtraFilters    `json:"filters"`
}
    type ResponseExtraFilters ¶ added in v0.2.10
type ResponseExtraPagination ¶ added in v0.2.10
type ResponseStatus ¶
type Run ¶ added in v1.0.0
type Run struct {
	ID                  int64  `json:"id,omitempty"`
	AccountID           int64  `json:"account_id"`
	JobID               int    `json:"job_id"`
	GitSHA              string `json:"git_sha,omitempty"`
	GitBranch           string `json:"git_branch,omitempty"`
	GitHubPullRequestID string `json:"github_pull_request_id,omitempty"`
	SchemaOverride      string `json:"schema_override,omitempty"`
	Cause               string `json:"cause,omitempty"`
}
    type RunFilter ¶ added in v1.0.0
type RunFilter struct {
	Limit           int    `json:"limit"`
	EnvironmentID   int    `json:"environment_id"`
	ProjectID       int    `json:"project_id"`
	TriggerID       int    `json:"trigger_id"`
	JobDefinitionID int    `json:"job_definition_id"`
	PullRequestID   int    `json:"pull_request_id"`
	Status          int    `json:"status"`
	StatusIn        string `json:"status_in"`
}
    type RunResponse ¶ added in v1.0.0
type RunResponse struct {
	Data   Run            `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type RunsResponse ¶ added in v1.0.0
type RunsResponse struct {
	Data   []Run          `json:"data"`
	Status ResponseStatus `json:"status"`
	Extra  ResponseExtra  `json:"extra"`
}
    type SemanticLayerConfiguration ¶ added in v1.0.0
type SemanticLayerConfigurationResponse ¶ added in v1.0.0
type SemanticLayerConfigurationResponse struct {
	Data   SemanticLayerConfiguration `json:"data"`
	Status ResponseStatus             `json:"status"`
}
    type SemanticLayerCredentialResponse ¶ added in v1.0.0
type SemanticLayerCredentialResponse struct {
	Status ResponseStatus           `json:"status"`
	Data   SemanticLayerCredentials `json:"data"`
}
    type SemanticLayerCredentials ¶ added in v1.0.0
type SemanticLayerCredentialsFilter ¶ added in v1.0.0
type SemanticLayerCredentialsFilter struct {
	ProjectID int
}
    type SemanticLayerCredentialsResponse ¶ added in v1.0.0
type SemanticLayerCredentialsResponse struct {
	Status ResponseStatus             `json:"status"`
	Data   []SemanticLayerCredentials `json:"data"`
}
    type ServiceToken ¶
type ServiceTokenListResponse ¶
type ServiceTokenListResponse struct {
	Data   []ServiceToken `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type ServiceTokenPermission ¶
type ServiceTokenPermission struct {
	ID             *int                  `json:"id,omitempty"`
	AccountID      int                   `json:"account_id"`
	ServiceTokenID int                   `json:"service_token_id"`
	ProjectID      int                   `json:"project_id,omitempty"`
	AllProjects    bool                  `json:"all_projects"`
	State          int                   `json:"state,omitempty"`
	Set            string                `json:"permission_set,omitempty"`
	WritableEnvs   []EnvironmentCategory `json:"writable_environment_categories,omitempty"`
}
    type ServiceTokenPermissionListResponse ¶
type ServiceTokenPermissionListResponse struct {
	Data   []ServiceTokenPermission `json:"data"`
	Status ResponseStatus           `json:"status"`
}
    type ServiceTokenResponse ¶
type ServiceTokenResponse struct {
	Data   ServiceToken   `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type SnowflakeConfig ¶ added in v0.3.11
type SnowflakeConfig struct {
	Account                *string                   `json:"account,omitempty"`
	Database               *string                   `json:"database,omitempty"`
	Warehouse              *string                   `json:"warehouse,omitempty"`
	ClientSessionKeepAlive *bool                     `json:"client_session_keep_alive,omitempty"`
	Role                   nullable.Nullable[string] `json:"role,omitempty"`
	AllowSso               *bool                     `json:"allow_sso,omitempty"`
	OauthClientID          *string                   `json:"oauth_client_id,omitempty"`
	OauthClientSecret      *string                   `json:"oauth_client_secret,omitempty"`
}
    func (SnowflakeConfig) AdapterVersion ¶ added in v0.3.11
func (SnowflakeConfig) AdapterVersion() string
type SnowflakeCredential ¶
type SnowflakeCredential struct {
	ID                   *int   `json:"id"`
	Account_Id           int    `json:"account_id"`
	Project_Id           int    `json:"project_id"`
	Type                 string `json:"type"`
	State                int    `json:"state"`
	Threads              int    `json:"threads"`
	User                 string `json:"user"`
	Password             string `json:"password,omitempty"`
	Auth_Type            string `json:"auth_type"`
	Database             string `json:"database"`
	Role                 string `json:"role"`
	Warehouse            string `json:"warehouse"`
	Schema               string `json:"schema"`
	PrivateKey           string `json:"private_key,omitempty"`
	PrivateKeyPassphrase string `json:"private_key_passphrase,omitempty"`
}
    type SnowflakeCredentialResponse ¶
type SnowflakeCredentialResponse struct {
	Data   SnowflakeCredential `json:"data"`
	Status ResponseStatus      `json:"status"`
}
    type StarburstConfig ¶ added in v0.3.13
type StarburstConfig struct {
	Method *string `json:"method,omitempty"`
	Host   *string `json:"host,omitempty"`
	Port   *int64  `json:"port,omitempty"`
}
    func (StarburstConfig) AdapterVersion ¶ added in v0.3.13
func (StarburstConfig) AdapterVersion() string
type StarburstCredentialData ¶ added in v0.3.26
type StarburstCredentialData struct {
	ID                           *int                                  `json:"id"`
	AccountID                    int                                   `json:"account_id"`
	ProjectID                    int                                   `json:"project_id"`
	Type                         string                                `json:"type"`
	State                        int                                   `json:"state"`
	Threads                      int                                   `json:"threads"`
	TargetName                   string                                `json:"target_name"`
	AdapterVersion               string                                `json:"adapter_version,omitempty"`
	UnencryptedCredentialDetails StarburstUnencryptedCredentialDetails `json:"unencrypted_credential_details"`
}
    StarburstCredentialData represents the data returned by the API for an Starburst credential
type StarburstCredentialRequest ¶ added in v0.3.26
type StarburstCredentialRequest struct {
	ID                *int                     `json:"id,omitempty"`
	AccountID         int                      `json:"account_id"`
	ProjectID         int                      `json:"project_id"`
	Type              string                   `json:"type"`
	State             int                      `json:"state"`
	Threads           int                      `json:"threads"`
	TargetName        string                   `json:"target_name"`
	AdapterVersion    string                   `json:"adapter_version,omitempty"`
	CredentialDetails AdapterCredentialDetails `json:"credential_details"`
}
    StarburstCredentialRequest is used for creating and updating Starburst credentials It doesn't include the UnencryptedCredentialDetails field which is only returned by the API
type StarburstCredentialResponse ¶ added in v0.3.26
type StarburstCredentialResponse struct {
	Data   StarburstCredentialData `json:"data"`
	Status ResponseStatus          `json:"status"`
}
    type StarburstUnencryptedCredentialDetails ¶ added in v0.3.26
type SynapseConfig ¶ added in v0.3.13
type SynapseConfig struct {
	Driver       *string `json:"driver,omitempty"`
	Host         *string `json:"host,omitempty"`
	Port         *int64  `json:"port,omitempty"`
	Database     *string `json:"database,omitempty"`
	Retries      *int64  `json:"retries,omitempty"`
	LoginTimeout *int64  `json:"login_timeout,omitempty"`
	QueryTimeout *int64  `json:"query_timeout,omitempty"`
}
    func (SynapseConfig) AdapterVersion ¶ added in v0.3.13
func (SynapseConfig) AdapterVersion() string
type TeradataConfig ¶ added in v1.0.0
type TeradataConfig struct {
	Port           *string `json:"port,omitempty"`
	TMode          *string `json:"tmode,omitempty"`
	Host           *string `json:"host,omitempty"`
	Retries        *int64  `json:"retries,omitempty"`
	RequestTimeout *int64  `json:"request_timeout,omitempty"`
}
    func (TeradataConfig) AdapterVersion ¶ added in v1.0.0
func (TeradataConfig) AdapterVersion() string
type TeradataCredentialData ¶ added in v1.0.0
type TeradataCredentialData struct {
	ID                           *int                                 `json:"id"`
	AccountID                    int                                  `json:"account_id"`
	Threads                      int                                  `json:"threads"`
	TargetName                   string                               `json:"target_name"`
	AdapterVersion               string                               `json:"adapter_version,omitempty"`
	UnencryptedCredentialDetails TeradataUnencryptedCredentialDetails `json:"unencrypted_credential_details"`
}
    TeradataCredentialData represents the data returned by the API for an Teradata credential
type TeradataCredentialRequest ¶ added in v1.0.0
type TeradataCredentialRequest struct {
	ID                *int                     `json:"id,omitempty"`
	AccountID         int                      `json:"account_id"`
	ProjectID         int                      `json:"project_id"`
	Type              string                   `json:"type"`
	State             int                      `json:"state"`
	Threads           int                      `json:"threads"`
	TargetName        string                   `json:"target_name"`
	AdapterVersion    string                   `json:"adapter_version,omitempty"`
	CredentialDetails AdapterCredentialDetails `json:"credential_details"`
}
    TeradataCredentialRequest is used for creating and updating Teradata credentials It doesn't include the UnencryptedCredentialDetails field which is only returned by the API
type TeradataCredentialResponse ¶ added in v1.0.0
type TeradataCredentialResponse struct {
	Data   TeradataCredentialData `json:"data"`
	Status ResponseStatus         `json:"status"`
}
    type TeradataUnencryptedCredentialDetails ¶ added in v1.0.0
type UserGroups ¶ added in v0.2.4
type UserGroups struct {
	Permissions []Permission `json:"permissions"`
}
    type UserGroupsBody ¶ added in v0.2.4
type UserGroupsCurrentAccount ¶ added in v0.2.4
type UserGroupsCurrentAccount struct {
	Groups []Group
}
    type UserGroupsResponse ¶ added in v0.2.4
type UserGroupsResponse struct {
	Data   UserGroups     `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type UserListResponse ¶
type UserListResponse struct {
	Data   []User         `json:"data"`
	Status ResponseStatus `json:"status"`
	Extra  ResponseExtra  `json:"extra"`
}
    type WebhookRead ¶
type WebhookRead struct {
	WebhookId         string   `json:"id"`
	Name              string   `json:"name"`
	Description       string   `json:"description,omitempty"`
	ClientUrl         string   `json:"client_url"`
	EventTypes        []string `json:"event_types,omitempty"`
	JobIds            []string `json:"job_ids"`
	Active            bool     `json:"active,omitempty"`
	HmacSecret        *string  `json:"hmac_secret,omitempty"`
	HttpStatusCode    *string  `json:"http_status_code,omitempty"`
	AccountIdentifier *string  `json:"account_identifier,omitempty"`
}
    type WebhookResponse ¶
type WebhookResponse struct {
	Data   WebhookRead    `json:"data"`
	Status ResponseStatus `json:"status"`
}
    type WebhookWrite ¶
      
      Source Files
      ¶
    
- account_features.go
 - adapter.go
 - athena_credential.go
 - azure_dev_ops_project.go
 - azure_dev_ops_repository.go
 - bigquery_credential.go
 - client.go
 - common.go
 - credential.go
 - databricks_credential.go
 - environment.go
 - environment_category.go
 - environment_variable.go
 - environment_variable_job_override.go
 - extended_attributes.go
 - fabric_credential.go
 - global_connection.go
 - global_connections.go
 - group.go
 - ip_restrictions.go
 - job.go
 - license_map.go
 - lineage.go
 - model_notifications.go
 - notification.go
 - oauth_configuration.go
 - paginate.go
 - postgres_credential.go
 - privatelink_endpoint.go
 - project.go
 - projects.go
 - repository.go
 - run.go
 - semantic_layer_configuration.go
 - semantic_layer_credential.go
 - service_token.go
 - snowflake_credential.go
 - starburst_credential.go
 - teradata_credential.go
 - user.go
 - user_groups.go
 - webhook.go