client

package
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 12, 2024 License: MIT Imports: 9 Imported by: 0

README

CMS GraphQL Client

Client generation

Download the client generation tool:

go get github.com/Khan/genqlient

Copy the Propel API schema from: https://studio.apollographql.com/public/Propel-API/variant/production/schema/sdl to the file schema.graphql

In this folder:

go run github.com/Khan/genqlient
Usage
package my_package

import (
	"context"
	"fmt"
	"log"

	pc "github.com/propeldata/terraform-provider-propel/propel_client"
)

func main() {
	c, err := pc.NewPropelClient("clientID", "clientSecret", "user-agent")
	if err != nil {
		log.Fatal(err)
	}

	resp, err := pc.DataSource(context.Background(), c, "DSO00000000000000000000000000")
	
	fmt.Println(resp.DataSource.Account.Id, err)
}

Documentation

Index

Constants

View Source
const AddColumnToDataPoolJob_Operation = `` /* 311-byte string literal not displayed */

The query or mutation executed by AddColumnToDataPoolJob.

View Source
const AssignDataPoolAccessPolicy_Operation = `` /* 202-byte string literal not displayed */

The query or mutation executed by AssignDataPoolAccessPolicy.

View Source
const CreateAddColumnToDataPoolJob_Operation = `` /* 379-byte string literal not displayed */

The query or mutation executed by CreateAddColumnToDataPoolJob.

View Source
const CreateAverageMetric_Operation = `` /* 4161-byte string literal not displayed */

The query or mutation executed by CreateAverageMetric.

View Source
const CreateCountDistinctMetric_Operation = `` /* 4179-byte string literal not displayed */

The query or mutation executed by CreateCountDistinctMetric.

View Source
const CreateCountMetric_Operation = `` /* 4155-byte string literal not displayed */

The query or mutation executed by CreateCountMetric.

View Source
const CreateCustomMetric_Operation = `` /* 4159-byte string literal not displayed */

The query or mutation executed by CreateCustomMetric.

View Source
const CreateDataPoolAccessPolicy_Operation = `` /* 613-byte string literal not displayed */

The query or mutation executed by CreateDataPoolAccessPolicy.

View Source
const CreateDataPool_Operation = `` /* 3033-byte string literal not displayed */

The query or mutation executed by CreateDataPool.

View Source
const CreateHttpDataSource_Operation = `` /* 1634-byte string literal not displayed */

The query or mutation executed by CreateHttpDataSource.

View Source
const CreateMaterializedView_Operation = `` /* 514-byte string literal not displayed */

The query or mutation executed by CreateMaterializedView.

View Source
const CreateMaxMetric_Operation = `` /* 4149-byte string literal not displayed */

The query or mutation executed by CreateMaxMetric.

View Source
const CreateMinMetric_Operation = `` /* 4149-byte string literal not displayed */

The query or mutation executed by CreateMinMetric.

View Source
const CreatePolicy_Operation = `` /* 208-byte string literal not displayed */

The query or mutation executed by CreatePolicy.

View Source
const CreateS3DataSource_Operation = `` /* 1628-byte string literal not displayed */

The query or mutation executed by CreateS3DataSource.

View Source
const CreateSnowflakeDataSource_Operation = `` /* 1809-byte string literal not displayed */

The query or mutation executed by CreateSnowflakeDataSource.

View Source
const CreateSumMetric_Operation = `` /* 4149-byte string literal not displayed */

The query or mutation executed by CreateSumMetric.

View Source
const CreateWebhookDataSource_Operation = `` /* 1643-byte string literal not displayed */

The query or mutation executed by CreateWebhookDataSource.

View Source
const DataPoolAccessPolicy_Operation = `` /* 574-byte string literal not displayed */

The query or mutation executed by DataPoolAccessPolicy.

View Source
const DataPoolByName_Operation = `` /* 2972-byte string literal not displayed */

The query or mutation executed by DataPoolByName.

View Source
const DataPool_Operation = `` /* 2922-byte string literal not displayed */

The query or mutation executed by DataPool.

View Source
const DataPools_Operation = `` /* 3183-byte string literal not displayed */

The query or mutation executed by DataPools.

View Source
const DataSourceByName_Operation = `` /* 1611-byte string literal not displayed */

The query or mutation executed by DataSourceByName.

View Source
const DataSource_Operation = `` /* 1559-byte string literal not displayed */

The query or mutation executed by DataSource.

View Source
const DataSources_Operation = `` /* 1820-byte string literal not displayed */

The query or mutation executed by DataSources.

View Source
const DeleteDataPoolAccessPolicy_Operation = `
mutation DeleteDataPoolAccessPolicy ($id: ID!) {
	deleteDataPoolAccessPolicy(id: $id)
}
`

The query or mutation executed by DeleteDataPoolAccessPolicy.

View Source
const DeleteDataPoolByName_Operation = `
mutation DeleteDataPoolByName ($uniqueName: String!) {
	deleteDataPoolByName(uniqueName: $uniqueName)
}
`

The query or mutation executed by DeleteDataPoolByName.

View Source
const DeleteDataPool_Operation = `
mutation DeleteDataPool ($id: ID!) {
	deleteDataPool(id: $id)
}
`

The query or mutation executed by DeleteDataPool.

View Source
const DeleteDataSourceByName_Operation = `
mutation DeleteDataSourceByName ($uniqueName: String!) {
	deleteDataSourceByName(uniqueName: $uniqueName)
}
`

The query or mutation executed by DeleteDataSourceByName.

View Source
const DeleteDataSource_Operation = `
mutation DeleteDataSource ($id: ID!) {
	deleteDataSource(id: $id)
}
`

The query or mutation executed by DeleteDataSource.

View Source
const DeleteMaterializedView_Operation = `
mutation DeleteMaterializedView ($id: ID!) {
	deleteMaterializedView(id: $id)
}
`

The query or mutation executed by DeleteMaterializedView.

View Source
const DeleteMetricByName_Operation = `
mutation DeleteMetricByName ($uniqueName: String!) {
	deleteMetricByName(uniqueName: $uniqueName)
}
`

The query or mutation executed by DeleteMetricByName.

View Source
const DeleteMetric_Operation = `
mutation DeleteMetric ($id: ID!) {
	deleteMetric(id: $id)
}
`

The query or mutation executed by DeleteMetric.

View Source
const DeletePolicy_Operation = `
mutation DeletePolicy ($id: ID!) {
	deletePolicy(id: $id)
}
`

The query or mutation executed by DeletePolicy.

View Source
const MaterializedView_Operation = `` /* 383-byte string literal not displayed */

The query or mutation executed by MaterializedView.

View Source
const MetricByName_Operation = `` /* 4121-byte string literal not displayed */

The query or mutation executed by MetricByName.

View Source
const Metric_Operation = `` /* 4073-byte string literal not displayed */

The query or mutation executed by Metric.

View Source
const Metrics_Operation = `` /* 4376-byte string literal not displayed */

The query or mutation executed by Metrics.

View Source
const ModifyDataPoolAccessPolicy_Operation = `` /* 613-byte string literal not displayed */

The query or mutation executed by ModifyDataPoolAccessPolicy.

View Source
const ModifyDataPool_Operation = `` /* 3139-byte string literal not displayed */

The query or mutation executed by ModifyDataPool.

View Source
const ModifyHttpDataSource_Operation = `` /* 1634-byte string literal not displayed */

The query or mutation executed by ModifyHttpDataSource.

View Source
const ModifyMaterializedView_Operation = `` /* 458-byte string literal not displayed */

The query or mutation executed by ModifyMaterializedView.

View Source
const ModifyMetric_Operation = `` /* 4140-byte string literal not displayed */

The query or mutation executed by ModifyMetric.

View Source
const ModifyPolicy_Operation = `` /* 208-byte string literal not displayed */

The query or mutation executed by ModifyPolicy.

View Source
const ModifyS3DataSource_Operation = `` /* 1628-byte string literal not displayed */

The query or mutation executed by ModifyS3DataSource.

View Source
const ModifySnowflakeDataSource_Operation = `` /* 1809-byte string literal not displayed */

The query or mutation executed by ModifySnowflakeDataSource.

View Source
const ModifyWebhookDataSource_Operation = `` /* 1643-byte string literal not displayed */

The query or mutation executed by ModifyWebhookDataSource.

View Source
const Policy_Operation = `` /* 153-byte string literal not displayed */

The query or mutation executed by Policy.

View Source
const UnAssignDataPoolAccessPolicy_Operation = `` /* 208-byte string literal not displayed */

The query or mutation executed by UnAssignDataPoolAccessPolicy.

Variables

This section is empty.

Functions

func NewPropelClient

func NewPropelClient(clientId string, secret string, userAgent string, oauthURL string, apiURL string) (graphql.Client, error)

Types

type AddColumnToDataPoolJobAddColumnToDataPoolJob added in v1.1.0

type AddColumnToDataPoolJobAddColumnToDataPoolJob struct {
	AddColumnToDataPoolJobData `json:"-"`
}

AddColumnToDataPoolJobAddColumnToDataPoolJob includes the requested fields of the GraphQL type AddColumnToDataPoolJob. The GraphQL type's documentation follows.

AddColumnToDataPoolJob scheduled for a specific Data Pool.

The Add Column Job represents the asynchronous process of adding a column, given its name and type, to a Data Pool. It tracks the process of adding a column until it is finished, showing the progress and the outcome when it is finished.

func (*AddColumnToDataPoolJobAddColumnToDataPoolJob) GetColumnName added in v1.1.0

GetColumnName returns AddColumnToDataPoolJobAddColumnToDataPoolJob.ColumnName, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobAddColumnToDataPoolJob) GetColumnType added in v1.1.0

GetColumnType returns AddColumnToDataPoolJobAddColumnToDataPoolJob.ColumnType, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobAddColumnToDataPoolJob) GetDataPool added in v1.1.0

GetDataPool returns AddColumnToDataPoolJobAddColumnToDataPoolJob.DataPool, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobAddColumnToDataPoolJob) GetError added in v1.1.0

GetError returns AddColumnToDataPoolJobAddColumnToDataPoolJob.Error, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobAddColumnToDataPoolJob) GetId added in v1.1.0

GetId returns AddColumnToDataPoolJobAddColumnToDataPoolJob.Id, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobAddColumnToDataPoolJob) GetStatus added in v1.1.0

GetStatus returns AddColumnToDataPoolJobAddColumnToDataPoolJob.Status, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobAddColumnToDataPoolJob) MarshalJSON added in v1.1.0

func (*AddColumnToDataPoolJobAddColumnToDataPoolJob) UnmarshalJSON added in v1.1.0

type AddColumnToDataPoolJobData added in v1.1.0

type AddColumnToDataPoolJobData struct {
	// The AddColumnToDataPoolJob's ID.
	Id string `json:"id"`
	// The Data Pool to which a column will be added by the Job.
	DataPool *AddColumnToDataPoolJobDataDataPool `json:"dataPool"`
	// The current AddColumnToDataPoolJob's status.
	Status JobStatus `json:"status"`
	// The error that occurred while adding the column data, if any.
	Error *AddColumnToDataPoolJobDataError `json:"error"`
	// Name of the new column.
	ColumnName string `json:"columnName"`
	// Type of the new column.
	ColumnType ColumnType `json:"columnType"`
}

AddColumnToDataPoolJobData includes the GraphQL fields of AddColumnToDataPoolJob requested by the fragment AddColumnToDataPoolJobData. The GraphQL type's documentation follows.

AddColumnToDataPoolJob scheduled for a specific Data Pool.

The Add Column Job represents the asynchronous process of adding a column, given its name and type, to a Data Pool. It tracks the process of adding a column until it is finished, showing the progress and the outcome when it is finished.

func (*AddColumnToDataPoolJobData) GetColumnName added in v1.1.0

func (v *AddColumnToDataPoolJobData) GetColumnName() string

GetColumnName returns AddColumnToDataPoolJobData.ColumnName, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobData) GetColumnType added in v1.1.0

func (v *AddColumnToDataPoolJobData) GetColumnType() ColumnType

GetColumnType returns AddColumnToDataPoolJobData.ColumnType, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobData) GetDataPool added in v1.1.0

GetDataPool returns AddColumnToDataPoolJobData.DataPool, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobData) GetError added in v1.1.0

GetError returns AddColumnToDataPoolJobData.Error, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobData) GetId added in v1.1.0

GetId returns AddColumnToDataPoolJobData.Id, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobData) GetStatus added in v1.1.0

func (v *AddColumnToDataPoolJobData) GetStatus() JobStatus

GetStatus returns AddColumnToDataPoolJobData.Status, and is useful for accessing the field via an interface.

type AddColumnToDataPoolJobDataDataPool added in v1.1.0

type AddColumnToDataPoolJobDataDataPool struct {
	// The Data Pool's unique identifier.
	Id string `json:"id"`
}

AddColumnToDataPoolJobDataDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*AddColumnToDataPoolJobDataDataPool) GetId added in v1.1.0

GetId returns AddColumnToDataPoolJobDataDataPool.Id, and is useful for accessing the field via an interface.

type AddColumnToDataPoolJobDataError added in v1.1.0

type AddColumnToDataPoolJobDataError struct {
	GqlError `json:"-"`
}

AddColumnToDataPoolJobDataError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*AddColumnToDataPoolJobDataError) GetCode added in v1.1.0

func (v *AddColumnToDataPoolJobDataError) GetCode() *int

GetCode returns AddColumnToDataPoolJobDataError.Code, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobDataError) GetMessage added in v1.1.0

func (v *AddColumnToDataPoolJobDataError) GetMessage() string

GetMessage returns AddColumnToDataPoolJobDataError.Message, and is useful for accessing the field via an interface.

func (*AddColumnToDataPoolJobDataError) MarshalJSON added in v1.1.0

func (v *AddColumnToDataPoolJobDataError) MarshalJSON() ([]byte, error)

func (*AddColumnToDataPoolJobDataError) UnmarshalJSON added in v1.1.0

func (v *AddColumnToDataPoolJobDataError) UnmarshalJSON(b []byte) error

type AddColumnToDataPoolJobResponse added in v1.1.0

type AddColumnToDataPoolJobResponse struct {
	// This query returns the AddColumnToDataPoolJob specified by the given ID.
	//
	// The AddColumnToDataPoolJob represents the asynchronous process of adding
	// a column, given its name and type, to a Data Pool.
	AddColumnToDataPoolJob *AddColumnToDataPoolJobAddColumnToDataPoolJob `json:"addColumnToDataPoolJob"`
}

AddColumnToDataPoolJobResponse is returned by AddColumnToDataPoolJob on success.

func AddColumnToDataPoolJob added in v1.1.0

func AddColumnToDataPoolJob(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*AddColumnToDataPoolJobResponse, error)

func (*AddColumnToDataPoolJobResponse) GetAddColumnToDataPoolJob added in v1.1.0

GetAddColumnToDataPoolJob returns AddColumnToDataPoolJobResponse.AddColumnToDataPoolJob, and is useful for accessing the field via an interface.

type AggregatingMergeTreeTableEngineInput added in v1.2.1

type AggregatingMergeTreeTableEngineInput struct {
	// The type is always `AGGREGATING_MERGE_TREE`.
	Type *TableEngineType `json:"type"`
}

Parameters for the AggregatingMergeTree table engine.

func (*AggregatingMergeTreeTableEngineInput) GetType added in v1.2.1

GetType returns AggregatingMergeTreeTableEngineInput.Type, and is useful for accessing the field via an interface.

type AssignDataPoolAccessPolicyResponse added in v1.1.0

type AssignDataPoolAccessPolicyResponse struct {
	// Assign a Data Pool Access Policy to an Application.
	//
	// The Data Pool Access Policy will restrict the Data Pool rows and columns that the Application
	// can query. If the Data Pool has `accessControlEnabled` set to true, the Application
	// *must* have a Data Pool Access Policy assigned in order to query the Data Pool.
	//
	// An Application can have at most one Data Pool Access Policy assigned for a given Data Pool. If
	// an Application already has a Data Pool Access Policy for a given Data Pool, and you call this
	// mutation with another Data Pool Access Policy for the same Data Pool, the Application's Data Pool Access
	// Policy will be replaced.
	AssignDataPoolAccessPolicyToApplication *string `json:"assignDataPoolAccessPolicyToApplication"`
}

AssignDataPoolAccessPolicyResponse is returned by AssignDataPoolAccessPolicy on success.

func AssignDataPoolAccessPolicy added in v1.1.0

func AssignDataPoolAccessPolicy(
	ctx context.Context,
	client graphql.Client,
	application string,
	dataPoolAccessPolicy string,
) (*AssignDataPoolAccessPolicyResponse, error)

func (*AssignDataPoolAccessPolicyResponse) GetAssignDataPoolAccessPolicyToApplication added in v1.1.0

func (v *AssignDataPoolAccessPolicyResponse) GetAssignDataPoolAccessPolicyToApplication() *string

GetAssignDataPoolAccessPolicyToApplication returns AssignDataPoolAccessPolicyResponse.AssignDataPoolAccessPolicyToApplication, and is useful for accessing the field via an interface.

type BackfillOptionsInput added in v1.2.1

type BackfillOptionsInput struct {
	// Whether historical data should be backfilled or not
	Backfill *bool `json:"backfill"`
}

func (*BackfillOptionsInput) GetBackfill added in v1.2.1

func (v *BackfillOptionsInput) GetBackfill() *bool

GetBackfill returns BackfillOptionsInput.Backfill, and is useful for accessing the field via an interface.

type ColumnData

type ColumnData struct {
	// The column's name.
	Name string `json:"name"`
	// The column's type.
	Type string `json:"type"`
	// Whether the column is nullable, meaning whether it accepts a null value.
	IsNullable *bool `json:"isNullable"`
}

ColumnData includes the GraphQL fields of Column requested by the fragment ColumnData. The GraphQL type's documentation follows.

The column object.

Once a table introspection succeeds, it creates a new table object for every table it introspected. Within each table object, it also creates a column object for every column it introspected.

func (*ColumnData) GetIsNullable

func (v *ColumnData) GetIsNullable() *bool

GetIsNullable returns ColumnData.IsNullable, and is useful for accessing the field via an interface.

func (*ColumnData) GetName

func (v *ColumnData) GetName() string

GetName returns ColumnData.Name, and is useful for accessing the field via an interface.

func (*ColumnData) GetType

func (v *ColumnData) GetType() string

GetType returns ColumnData.Type, and is useful for accessing the field via an interface.

type ColumnType

type ColumnType string

The Propel data types.

const (
	// True or false.
	ColumnTypeBoolean ColumnType = "BOOLEAN"
	// A variable-length string.
	ColumnTypeString ColumnType = "STRING"
	// A 32-bit signed double-precision floating point number.
	ColumnTypeFloat ColumnType = "FLOAT"
	// A 64-bit signed double-precision floating point number.
	ColumnTypeDouble ColumnType = "DOUBLE"
	// An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.
	ColumnTypeInt8 ColumnType = "INT8"
	// A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.
	ColumnTypeInt16 ColumnType = "INT16"
	// A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.
	ColumnTypeInt32 ColumnType = "INT32"
	// A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.
	ColumnTypeInt64 ColumnType = "INT64"
	// A date without a timestamp. For example, "YYYY-MM-DD".
	ColumnTypeDate ColumnType = "DATE"
	// A date with a timestamp. For example, "yyy-MM-dd HH:mm:ss".
	ColumnTypeTimestamp ColumnType = "TIMESTAMP"
	// A JavaScript Object Notation (JSON) document.
	ColumnTypeJson ColumnType = "JSON"
	// A ClickHouse-specific type.
	ColumnTypeClickhouse ColumnType = "CLICKHOUSE"
)

type CommonData

type CommonData interface {

	// GetUniqueName returns the interface-field "uniqueName" from its implementation.
	// The GraphQL interface field's documentation follows.
	//
	// The resource's unique name.
	GetUniqueName() string
	// GetDescription returns the interface-field "description" from its implementation.
	// The GraphQL interface field's documentation follows.
	//
	// The resource's description.
	GetDescription() string
	// GetAccount returns the interface-field "account" from its implementation.
	// The GraphQL interface field's documentation follows.
	//
	// The resource's Account.
	GetAccount() *CommonDataAccount
	// GetEnvironment returns the interface-field "environment" from its implementation.
	// The GraphQL interface field's documentation follows.
	//
	// The resource's Environment.
	GetEnvironment() *CommonDataEnvironment
	// GetCreatedAt returns the interface-field "createdAt" from its implementation.
	// The GraphQL interface field's documentation follows.
	//
	// The resource's creation date and time in UTC.
	GetCreatedAt() time.Time
	// GetModifiedAt returns the interface-field "modifiedAt" from its implementation.
	// The GraphQL interface field's documentation follows.
	//
	// The resource's last modification date and time in UTC.
	GetModifiedAt() time.Time
	// GetCreatedBy returns the interface-field "createdBy" from its implementation.
	// The GraphQL interface field's documentation follows.
	//
	// The resource's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	GetCreatedBy() string
	// GetModifiedBy returns the interface-field "modifiedBy" from its implementation.
	// The GraphQL interface field's documentation follows.
	//
	// The resource's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	GetModifiedBy() string
	// contains filtered or unexported methods
}

CommonData includes the GraphQL fields of Common requested by the fragment CommonData. The GraphQL type's documentation follows.

All Propel resources, such as Applications and Metrics, have a set of common properties, such as the Propel Account and Environment that they are associated with. They also have a unique ID, which is specified in the interface `Node`.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

CommonData is implemented by the following types: CommonDataApplication CommonDataDataSource CommonDataDataPool CommonDataMaterializedView CommonDataMetric CommonDataDataPoolAccessPolicy

type CommonDataAccount

type CommonDataAccount struct {
	// The Account's unique identifier.
	Id string `json:"id"`
}

CommonDataAccount includes the requested fields of the GraphQL type Account. The GraphQL type's documentation follows.

The Account object.

func (*CommonDataAccount) GetId

func (v *CommonDataAccount) GetId() string

GetId returns CommonDataAccount.Id, and is useful for accessing the field via an interface.

type CommonDataApplication

type CommonDataApplication struct {
	// The resource's unique name.
	UniqueName string `json:"uniqueName"`
	// The resource's description.
	Description string `json:"description"`
	// The resource's Account.
	Account *CommonDataAccount `json:"account"`
	// The resource's Environment.
	Environment *CommonDataEnvironment `json:"environment"`
	// The resource's creation date and time in UTC.
	CreatedAt time.Time `json:"createdAt"`
	// The resource's last modification date and time in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The resource's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	CreatedBy string `json:"createdBy"`
	// The resource's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	ModifiedBy string `json:"modifiedBy"`
}

CommonData includes the GraphQL fields of Application requested by the fragment CommonData. The GraphQL type's documentation follows.

All Propel resources, such as Applications and Metrics, have a set of common properties, such as the Propel Account and Environment that they are associated with. They also have a unique ID, which is specified in the interface `Node`.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

func (*CommonDataApplication) GetAccount

func (v *CommonDataApplication) GetAccount() *CommonDataAccount

GetAccount returns CommonDataApplication.Account, and is useful for accessing the field via an interface.

func (*CommonDataApplication) GetCreatedAt

func (v *CommonDataApplication) GetCreatedAt() time.Time

GetCreatedAt returns CommonDataApplication.CreatedAt, and is useful for accessing the field via an interface.

func (*CommonDataApplication) GetCreatedBy

func (v *CommonDataApplication) GetCreatedBy() string

GetCreatedBy returns CommonDataApplication.CreatedBy, and is useful for accessing the field via an interface.

func (*CommonDataApplication) GetDescription

func (v *CommonDataApplication) GetDescription() string

GetDescription returns CommonDataApplication.Description, and is useful for accessing the field via an interface.

func (*CommonDataApplication) GetEnvironment

func (v *CommonDataApplication) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns CommonDataApplication.Environment, and is useful for accessing the field via an interface.

func (*CommonDataApplication) GetModifiedAt

func (v *CommonDataApplication) GetModifiedAt() time.Time

GetModifiedAt returns CommonDataApplication.ModifiedAt, and is useful for accessing the field via an interface.

func (*CommonDataApplication) GetModifiedBy

func (v *CommonDataApplication) GetModifiedBy() string

GetModifiedBy returns CommonDataApplication.ModifiedBy, and is useful for accessing the field via an interface.

func (*CommonDataApplication) GetUniqueName

func (v *CommonDataApplication) GetUniqueName() string

GetUniqueName returns CommonDataApplication.UniqueName, and is useful for accessing the field via an interface.

type CommonDataDataPool

type CommonDataDataPool struct {
	// The resource's unique name.
	UniqueName string `json:"uniqueName"`
	// The resource's description.
	Description string `json:"description"`
	// The resource's Account.
	Account *CommonDataAccount `json:"account"`
	// The resource's Environment.
	Environment *CommonDataEnvironment `json:"environment"`
	// The resource's creation date and time in UTC.
	CreatedAt time.Time `json:"createdAt"`
	// The resource's last modification date and time in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The resource's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	CreatedBy string `json:"createdBy"`
	// The resource's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	ModifiedBy string `json:"modifiedBy"`
}

CommonData includes the GraphQL fields of DataPool requested by the fragment CommonData. The GraphQL type's documentation follows.

All Propel resources, such as Applications and Metrics, have a set of common properties, such as the Propel Account and Environment that they are associated with. They also have a unique ID, which is specified in the interface `Node`.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

func (*CommonDataDataPool) GetAccount

func (v *CommonDataDataPool) GetAccount() *CommonDataAccount

GetAccount returns CommonDataDataPool.Account, and is useful for accessing the field via an interface.

func (*CommonDataDataPool) GetCreatedAt

func (v *CommonDataDataPool) GetCreatedAt() time.Time

GetCreatedAt returns CommonDataDataPool.CreatedAt, and is useful for accessing the field via an interface.

func (*CommonDataDataPool) GetCreatedBy

func (v *CommonDataDataPool) GetCreatedBy() string

GetCreatedBy returns CommonDataDataPool.CreatedBy, and is useful for accessing the field via an interface.

func (*CommonDataDataPool) GetDescription

func (v *CommonDataDataPool) GetDescription() string

GetDescription returns CommonDataDataPool.Description, and is useful for accessing the field via an interface.

func (*CommonDataDataPool) GetEnvironment

func (v *CommonDataDataPool) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns CommonDataDataPool.Environment, and is useful for accessing the field via an interface.

func (*CommonDataDataPool) GetModifiedAt

func (v *CommonDataDataPool) GetModifiedAt() time.Time

GetModifiedAt returns CommonDataDataPool.ModifiedAt, and is useful for accessing the field via an interface.

func (*CommonDataDataPool) GetModifiedBy

func (v *CommonDataDataPool) GetModifiedBy() string

GetModifiedBy returns CommonDataDataPool.ModifiedBy, and is useful for accessing the field via an interface.

func (*CommonDataDataPool) GetUniqueName

func (v *CommonDataDataPool) GetUniqueName() string

GetUniqueName returns CommonDataDataPool.UniqueName, and is useful for accessing the field via an interface.

type CommonDataDataPoolAccessPolicy added in v1.1.0

type CommonDataDataPoolAccessPolicy struct {
	// The resource's unique name.
	UniqueName string `json:"uniqueName"`
	// The resource's description.
	Description string `json:"description"`
	// The resource's Account.
	Account *CommonDataAccount `json:"account"`
	// The resource's Environment.
	Environment *CommonDataEnvironment `json:"environment"`
	// The resource's creation date and time in UTC.
	CreatedAt time.Time `json:"createdAt"`
	// The resource's last modification date and time in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The resource's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	CreatedBy string `json:"createdBy"`
	// The resource's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	ModifiedBy string `json:"modifiedBy"`
}

CommonData includes the GraphQL fields of DataPoolAccessPolicy requested by the fragment CommonData. The GraphQL type's documentation follows.

All Propel resources, such as Applications and Metrics, have a set of common properties, such as the Propel Account and Environment that they are associated with. They also have a unique ID, which is specified in the interface `Node`.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

func (*CommonDataDataPoolAccessPolicy) GetAccount added in v1.1.0

GetAccount returns CommonDataDataPoolAccessPolicy.Account, and is useful for accessing the field via an interface.

func (*CommonDataDataPoolAccessPolicy) GetCreatedAt added in v1.1.0

func (v *CommonDataDataPoolAccessPolicy) GetCreatedAt() time.Time

GetCreatedAt returns CommonDataDataPoolAccessPolicy.CreatedAt, and is useful for accessing the field via an interface.

func (*CommonDataDataPoolAccessPolicy) GetCreatedBy added in v1.1.0

func (v *CommonDataDataPoolAccessPolicy) GetCreatedBy() string

GetCreatedBy returns CommonDataDataPoolAccessPolicy.CreatedBy, and is useful for accessing the field via an interface.

func (*CommonDataDataPoolAccessPolicy) GetDescription added in v1.1.0

func (v *CommonDataDataPoolAccessPolicy) GetDescription() string

GetDescription returns CommonDataDataPoolAccessPolicy.Description, and is useful for accessing the field via an interface.

func (*CommonDataDataPoolAccessPolicy) GetEnvironment added in v1.1.0

GetEnvironment returns CommonDataDataPoolAccessPolicy.Environment, and is useful for accessing the field via an interface.

func (*CommonDataDataPoolAccessPolicy) GetModifiedAt added in v1.1.0

func (v *CommonDataDataPoolAccessPolicy) GetModifiedAt() time.Time

GetModifiedAt returns CommonDataDataPoolAccessPolicy.ModifiedAt, and is useful for accessing the field via an interface.

func (*CommonDataDataPoolAccessPolicy) GetModifiedBy added in v1.1.0

func (v *CommonDataDataPoolAccessPolicy) GetModifiedBy() string

GetModifiedBy returns CommonDataDataPoolAccessPolicy.ModifiedBy, and is useful for accessing the field via an interface.

func (*CommonDataDataPoolAccessPolicy) GetUniqueName added in v1.1.0

func (v *CommonDataDataPoolAccessPolicy) GetUniqueName() string

GetUniqueName returns CommonDataDataPoolAccessPolicy.UniqueName, and is useful for accessing the field via an interface.

type CommonDataDataSource

type CommonDataDataSource struct {
	// The resource's unique name.
	UniqueName string `json:"uniqueName"`
	// The resource's description.
	Description string `json:"description"`
	// The resource's Account.
	Account *CommonDataAccount `json:"account"`
	// The resource's Environment.
	Environment *CommonDataEnvironment `json:"environment"`
	// The resource's creation date and time in UTC.
	CreatedAt time.Time `json:"createdAt"`
	// The resource's last modification date and time in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The resource's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	CreatedBy string `json:"createdBy"`
	// The resource's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	ModifiedBy string `json:"modifiedBy"`
}

CommonData includes the GraphQL fields of DataSource requested by the fragment CommonData. The GraphQL type's documentation follows.

All Propel resources, such as Applications and Metrics, have a set of common properties, such as the Propel Account and Environment that they are associated with. They also have a unique ID, which is specified in the interface `Node`.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

func (*CommonDataDataSource) GetAccount

func (v *CommonDataDataSource) GetAccount() *CommonDataAccount

GetAccount returns CommonDataDataSource.Account, and is useful for accessing the field via an interface.

func (*CommonDataDataSource) GetCreatedAt

func (v *CommonDataDataSource) GetCreatedAt() time.Time

GetCreatedAt returns CommonDataDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*CommonDataDataSource) GetCreatedBy

func (v *CommonDataDataSource) GetCreatedBy() string

GetCreatedBy returns CommonDataDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*CommonDataDataSource) GetDescription

func (v *CommonDataDataSource) GetDescription() string

GetDescription returns CommonDataDataSource.Description, and is useful for accessing the field via an interface.

func (*CommonDataDataSource) GetEnvironment

func (v *CommonDataDataSource) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns CommonDataDataSource.Environment, and is useful for accessing the field via an interface.

func (*CommonDataDataSource) GetModifiedAt

func (v *CommonDataDataSource) GetModifiedAt() time.Time

GetModifiedAt returns CommonDataDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*CommonDataDataSource) GetModifiedBy

func (v *CommonDataDataSource) GetModifiedBy() string

GetModifiedBy returns CommonDataDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*CommonDataDataSource) GetUniqueName

func (v *CommonDataDataSource) GetUniqueName() string

GetUniqueName returns CommonDataDataSource.UniqueName, and is useful for accessing the field via an interface.

type CommonDataEnvironment

type CommonDataEnvironment struct {
	// The Environment's unique identifier.
	Id string `json:"id"`
}

CommonDataEnvironment includes the requested fields of the GraphQL type Environment. The GraphQL type's documentation follows.

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

func (*CommonDataEnvironment) GetId

func (v *CommonDataEnvironment) GetId() string

GetId returns CommonDataEnvironment.Id, and is useful for accessing the field via an interface.

type CommonDataMaterializedView added in v1.2.1

type CommonDataMaterializedView struct {
	// The resource's unique name.
	UniqueName string `json:"uniqueName"`
	// The resource's description.
	Description string `json:"description"`
	// The resource's Account.
	Account *CommonDataAccount `json:"account"`
	// The resource's Environment.
	Environment *CommonDataEnvironment `json:"environment"`
	// The resource's creation date and time in UTC.
	CreatedAt time.Time `json:"createdAt"`
	// The resource's last modification date and time in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The resource's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	CreatedBy string `json:"createdBy"`
	// The resource's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	ModifiedBy string `json:"modifiedBy"`
}

CommonData includes the GraphQL fields of MaterializedView requested by the fragment CommonData. The GraphQL type's documentation follows.

All Propel resources, such as Applications and Metrics, have a set of common properties, such as the Propel Account and Environment that they are associated with. They also have a unique ID, which is specified in the interface `Node`.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

func (*CommonDataMaterializedView) GetAccount added in v1.2.1

GetAccount returns CommonDataMaterializedView.Account, and is useful for accessing the field via an interface.

func (*CommonDataMaterializedView) GetCreatedAt added in v1.2.1

func (v *CommonDataMaterializedView) GetCreatedAt() time.Time

GetCreatedAt returns CommonDataMaterializedView.CreatedAt, and is useful for accessing the field via an interface.

func (*CommonDataMaterializedView) GetCreatedBy added in v1.2.1

func (v *CommonDataMaterializedView) GetCreatedBy() string

GetCreatedBy returns CommonDataMaterializedView.CreatedBy, and is useful for accessing the field via an interface.

func (*CommonDataMaterializedView) GetDescription added in v1.2.1

func (v *CommonDataMaterializedView) GetDescription() string

GetDescription returns CommonDataMaterializedView.Description, and is useful for accessing the field via an interface.

func (*CommonDataMaterializedView) GetEnvironment added in v1.2.1

GetEnvironment returns CommonDataMaterializedView.Environment, and is useful for accessing the field via an interface.

func (*CommonDataMaterializedView) GetModifiedAt added in v1.2.1

func (v *CommonDataMaterializedView) GetModifiedAt() time.Time

GetModifiedAt returns CommonDataMaterializedView.ModifiedAt, and is useful for accessing the field via an interface.

func (*CommonDataMaterializedView) GetModifiedBy added in v1.2.1

func (v *CommonDataMaterializedView) GetModifiedBy() string

GetModifiedBy returns CommonDataMaterializedView.ModifiedBy, and is useful for accessing the field via an interface.

func (*CommonDataMaterializedView) GetUniqueName added in v1.2.1

func (v *CommonDataMaterializedView) GetUniqueName() string

GetUniqueName returns CommonDataMaterializedView.UniqueName, and is useful for accessing the field via an interface.

type CommonDataMetric

type CommonDataMetric struct {
	// The resource's unique name.
	UniqueName string `json:"uniqueName"`
	// The resource's description.
	Description string `json:"description"`
	// The resource's Account.
	Account *CommonDataAccount `json:"account"`
	// The resource's Environment.
	Environment *CommonDataEnvironment `json:"environment"`
	// The resource's creation date and time in UTC.
	CreatedAt time.Time `json:"createdAt"`
	// The resource's last modification date and time in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The resource's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	CreatedBy string `json:"createdBy"`
	// The resource's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	ModifiedBy string `json:"modifiedBy"`
}

CommonData includes the GraphQL fields of Metric requested by the fragment CommonData. The GraphQL type's documentation follows.

All Propel resources, such as Applications and Metrics, have a set of common properties, such as the Propel Account and Environment that they are associated with. They also have a unique ID, which is specified in the interface `Node`.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

func (*CommonDataMetric) GetAccount

func (v *CommonDataMetric) GetAccount() *CommonDataAccount

GetAccount returns CommonDataMetric.Account, and is useful for accessing the field via an interface.

func (*CommonDataMetric) GetCreatedAt

func (v *CommonDataMetric) GetCreatedAt() time.Time

GetCreatedAt returns CommonDataMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*CommonDataMetric) GetCreatedBy

func (v *CommonDataMetric) GetCreatedBy() string

GetCreatedBy returns CommonDataMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*CommonDataMetric) GetDescription

func (v *CommonDataMetric) GetDescription() string

GetDescription returns CommonDataMetric.Description, and is useful for accessing the field via an interface.

func (*CommonDataMetric) GetEnvironment

func (v *CommonDataMetric) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns CommonDataMetric.Environment, and is useful for accessing the field via an interface.

func (*CommonDataMetric) GetModifiedAt

func (v *CommonDataMetric) GetModifiedAt() time.Time

GetModifiedAt returns CommonDataMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*CommonDataMetric) GetModifiedBy

func (v *CommonDataMetric) GetModifiedBy() string

GetModifiedBy returns CommonDataMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*CommonDataMetric) GetUniqueName

func (v *CommonDataMetric) GetUniqueName() string

GetUniqueName returns CommonDataMetric.UniqueName, and is useful for accessing the field via an interface.

type CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponse added in v1.1.0

type CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponse struct {
	// The AddColumnToDataPool Job that was just created.
	Job *CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob `json:"job"`
}

CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponse includes the requested fields of the GraphQL type AddColumnToDataPoolJobResponse. The GraphQL type's documentation follows.

The response returned by the Add Column Job.

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponse) GetJob added in v1.1.0

GetJob returns CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponse.Job, and is useful for accessing the field via an interface.

type CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob added in v1.1.0

type CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob struct {
	AddColumnToDataPoolJobData `json:"-"`
}

CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob includes the requested fields of the GraphQL type AddColumnToDataPoolJob. The GraphQL type's documentation follows.

AddColumnToDataPoolJob scheduled for a specific Data Pool.

The Add Column Job represents the asynchronous process of adding a column, given its name and type, to a Data Pool. It tracks the process of adding a column until it is finished, showing the progress and the outcome when it is finished.

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob) GetColumnName added in v1.1.0

GetColumnName returns CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob.ColumnName, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob) GetColumnType added in v1.1.0

GetColumnType returns CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob.ColumnType, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob) GetDataPool added in v1.1.0

GetDataPool returns CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob.DataPool, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob) GetError added in v1.1.0

GetError returns CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob.Error, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob) GetId added in v1.1.0

GetId returns CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob.Id, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob) GetStatus added in v1.1.0

GetStatus returns CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob.Status, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob) MarshalJSON added in v1.1.0

func (*CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponseJobAddColumnToDataPoolJob) UnmarshalJSON added in v1.1.0

type CreateAddColumnToDataPoolJobInput added in v1.1.0

type CreateAddColumnToDataPoolJobInput struct {
	// The Data Pool to which the column will be added.
	DataPool string `json:"dataPool"`
	// Name of the new column.
	ColumnName string `json:"columnName"`
	// Type of the new column.
	ColumnType ColumnType `json:"columnType"`
	// JSON property to which the new column corresponds.
	JsonProperty *string `json:"jsonProperty"`
}

The fields for creating an Add Column Job.

func (*CreateAddColumnToDataPoolJobInput) GetColumnName added in v1.1.0

func (v *CreateAddColumnToDataPoolJobInput) GetColumnName() string

GetColumnName returns CreateAddColumnToDataPoolJobInput.ColumnName, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobInput) GetColumnType added in v1.1.0

func (v *CreateAddColumnToDataPoolJobInput) GetColumnType() ColumnType

GetColumnType returns CreateAddColumnToDataPoolJobInput.ColumnType, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobInput) GetDataPool added in v1.1.0

func (v *CreateAddColumnToDataPoolJobInput) GetDataPool() string

GetDataPool returns CreateAddColumnToDataPoolJobInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateAddColumnToDataPoolJobInput) GetJsonProperty added in v1.1.0

func (v *CreateAddColumnToDataPoolJobInput) GetJsonProperty() *string

GetJsonProperty returns CreateAddColumnToDataPoolJobInput.JsonProperty, and is useful for accessing the field via an interface.

type CreateAddColumnToDataPoolJobResponse added in v1.1.0

type CreateAddColumnToDataPoolJobResponse struct {
	// Schedules a new AddColumnToDataPoolJob on the specified Data Pool.
	CreateAddColumnToDataPoolJob *CreateAddColumnToDataPoolJobCreateAddColumnToDataPoolJobAddColumnToDataPoolJobResponse `json:"createAddColumnToDataPoolJob"`
}

CreateAddColumnToDataPoolJobResponse is returned by CreateAddColumnToDataPoolJob on success.

func CreateAddColumnToDataPoolJob added in v1.1.0

func CreateAddColumnToDataPoolJob(
	ctx context.Context,
	client graphql.Client,
	input *CreateAddColumnToDataPoolJobInput,
) (*CreateAddColumnToDataPoolJobResponse, error)

func (*CreateAddColumnToDataPoolJobResponse) GetCreateAddColumnToDataPoolJob added in v1.1.0

GetCreateAddColumnToDataPoolJob returns CreateAddColumnToDataPoolJobResponse.CreateAddColumnToDataPoolJob, and is useful for accessing the field via an interface.

type CreateAverageMetricCreateAverageMetricMetricResponse added in v0.1.3

type CreateAverageMetricCreateAverageMetricMetricResponse struct {
	Typename *string `json:"__typename"`
	// The Metric which was created or modified.
	Metric *CreateAverageMetricCreateAverageMetricMetricResponseMetric `json:"metric"`
}

CreateAverageMetricCreateAverageMetricMetricResponse includes the requested fields of the GraphQL type MetricResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Metric.

func (*CreateAverageMetricCreateAverageMetricMetricResponse) GetMetric added in v0.1.3

GetMetric returns CreateAverageMetricCreateAverageMetricMetricResponse.Metric, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponse) GetTypename added in v0.1.3

GetTypename returns CreateAverageMetricCreateAverageMetricMetricResponse.Typename, and is useful for accessing the field via an interface.

type CreateAverageMetricCreateAverageMetricMetricResponseMetric added in v0.1.3

type CreateAverageMetricCreateAverageMetricMetricResponseMetric struct {
	MetricData `json:"-"`
}

CreateAverageMetricCreateAverageMetricMetricResponseMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetAccessControlEnabled added in v0.1.4

GetAccessControlEnabled returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetAccount added in v0.1.3

GetAccount returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Account, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetCreatedAt added in v0.1.3

GetCreatedAt returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetCreatedBy added in v0.1.3

GetCreatedBy returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetDataPool added in v0.1.3

GetDataPool returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.DataPool, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetDescription added in v0.1.3

GetDescription returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Description, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetDimensions added in v0.1.3

GetDimensions returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Dimensions, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetEnvironment added in v0.1.3

GetEnvironment returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Environment, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetId added in v0.1.3

GetId returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Id, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetMeasure added in v0.1.3

GetMeasure returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Measure, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetModifiedAt added in v0.1.3

GetModifiedAt returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetModifiedBy added in v0.1.3

GetModifiedBy returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetSettings added in v0.1.3

GetSettings returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Settings, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetTimestamp added in v0.1.3

GetTimestamp returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Timestamp, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetType added in v0.1.3

GetType returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.Type, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) GetUniqueName added in v0.1.3

GetUniqueName returns CreateAverageMetricCreateAverageMetricMetricResponseMetric.UniqueName, and is useful for accessing the field via an interface.

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) MarshalJSON added in v0.1.3

func (*CreateAverageMetricCreateAverageMetricMetricResponseMetric) UnmarshalJSON added in v0.1.3

type CreateAverageMetricInput added in v0.1.3

type CreateAverageMetricInput struct {
	// The Data Pool that powers this Metric.
	DataPool string `json:"dataPool"`
	// The Metric's unique name.
	UniqueName *string `json:"uniqueName"`
	// The Metric's description.
	Description *string `json:"description"`
	// The Metric's Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	Filters []*FilterInput `json:"filters,omitempty"`
	// The Metric's Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	FilterSql *string `json:"filterSql"`
	// The Metric's Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.
	Dimensions []*DimensionInput `json:"dimensions,omitempty"`
	// The column to be averaged.
	Measure *DimensionInput `json:"measure,omitempty"`
}

The fields for creating a new Average Metric.

func (*CreateAverageMetricInput) GetDataPool added in v0.1.3

func (v *CreateAverageMetricInput) GetDataPool() string

GetDataPool returns CreateAverageMetricInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateAverageMetricInput) GetDescription added in v0.1.3

func (v *CreateAverageMetricInput) GetDescription() *string

GetDescription returns CreateAverageMetricInput.Description, and is useful for accessing the field via an interface.

func (*CreateAverageMetricInput) GetDimensions added in v0.1.3

func (v *CreateAverageMetricInput) GetDimensions() []*DimensionInput

GetDimensions returns CreateAverageMetricInput.Dimensions, and is useful for accessing the field via an interface.

func (*CreateAverageMetricInput) GetFilterSql added in v1.2.1

func (v *CreateAverageMetricInput) GetFilterSql() *string

GetFilterSql returns CreateAverageMetricInput.FilterSql, and is useful for accessing the field via an interface.

func (*CreateAverageMetricInput) GetFilters added in v0.1.3

func (v *CreateAverageMetricInput) GetFilters() []*FilterInput

GetFilters returns CreateAverageMetricInput.Filters, and is useful for accessing the field via an interface.

func (*CreateAverageMetricInput) GetMeasure added in v0.1.3

func (v *CreateAverageMetricInput) GetMeasure() *DimensionInput

GetMeasure returns CreateAverageMetricInput.Measure, and is useful for accessing the field via an interface.

func (*CreateAverageMetricInput) GetUniqueName added in v0.1.3

func (v *CreateAverageMetricInput) GetUniqueName() *string

GetUniqueName returns CreateAverageMetricInput.UniqueName, and is useful for accessing the field via an interface.

type CreateAverageMetricResponse added in v0.1.3

type CreateAverageMetricResponse struct {
	// Creates a new Average Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).
	//
	// [Learn more about Metrics](https://www.propeldata.com/docs/metrics).
	CreateAverageMetric *CreateAverageMetricCreateAverageMetricMetricResponse `json:"createAverageMetric"`
}

CreateAverageMetricResponse is returned by CreateAverageMetric on success.

func CreateAverageMetric added in v0.1.3

func CreateAverageMetric(
	ctx context.Context,
	client graphql.Client,
	input *CreateAverageMetricInput,
) (*CreateAverageMetricResponse, error)

func (*CreateAverageMetricResponse) GetCreateAverageMetric added in v0.1.3

GetCreateAverageMetric returns CreateAverageMetricResponse.CreateAverageMetric, and is useful for accessing the field via an interface.

type CreateCountDistinctMetricCreateCountDistinctMetricMetricResponse

type CreateCountDistinctMetricCreateCountDistinctMetricMetricResponse struct {
	Typename *string `json:"__typename"`
	// The Metric which was created or modified.
	Metric *CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric `json:"metric"`
}

CreateCountDistinctMetricCreateCountDistinctMetricMetricResponse includes the requested fields of the GraphQL type MetricResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Metric.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponse) GetMetric

GetMetric returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponse.Metric, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponse) GetTypename

GetTypename returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponse.Typename, and is useful for accessing the field via an interface.

type CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric

type CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric struct {
	MetricData `json:"-"`
}

CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetAccessControlEnabled added in v0.1.4

GetAccessControlEnabled returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetAccount

GetAccount returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Account, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetCreatedAt

GetCreatedAt returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetCreatedBy

GetCreatedBy returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetDataPool

GetDataPool returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.DataPool, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetDescription

GetDescription returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Description, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetDimensions

GetDimensions returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Dimensions, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetEnvironment

GetEnvironment returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Environment, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetId

GetId returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Id, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetMeasure

GetMeasure returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Measure, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetModifiedAt

GetModifiedAt returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetModifiedBy

GetModifiedBy returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetSettings

GetSettings returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Settings, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetTimestamp

GetTimestamp returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Timestamp, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetType

GetType returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.Type, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) GetUniqueName

GetUniqueName returns CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric.UniqueName, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) MarshalJSON

func (*CreateCountDistinctMetricCreateCountDistinctMetricMetricResponseMetric) UnmarshalJSON

type CreateCountDistinctMetricInput

type CreateCountDistinctMetricInput struct {
	// The Data Pool that powers this Metric.
	DataPool string `json:"dataPool"`
	// The Metric's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
	// The Metric's description.
	Description *string `json:"description"`
	// The Metric's Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	Filters []*FilterInput `json:"filters,omitempty"`
	// The Metric's Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	FilterSql *string `json:"filterSql"`
	// The Metric's Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.
	Dimensions []*DimensionInput `json:"dimensions,omitempty"`
	// The Dimension over which the count distinct operation is going to be performed.
	Dimension *DimensionInput `json:"dimension,omitempty"`
}

The fields for creating a new Count Distinct Metric.

func (*CreateCountDistinctMetricInput) GetDataPool

func (v *CreateCountDistinctMetricInput) GetDataPool() string

GetDataPool returns CreateCountDistinctMetricInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricInput) GetDescription

func (v *CreateCountDistinctMetricInput) GetDescription() *string

GetDescription returns CreateCountDistinctMetricInput.Description, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricInput) GetDimension

GetDimension returns CreateCountDistinctMetricInput.Dimension, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricInput) GetDimensions

func (v *CreateCountDistinctMetricInput) GetDimensions() []*DimensionInput

GetDimensions returns CreateCountDistinctMetricInput.Dimensions, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricInput) GetFilterSql added in v1.2.1

func (v *CreateCountDistinctMetricInput) GetFilterSql() *string

GetFilterSql returns CreateCountDistinctMetricInput.FilterSql, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricInput) GetFilters

func (v *CreateCountDistinctMetricInput) GetFilters() []*FilterInput

GetFilters returns CreateCountDistinctMetricInput.Filters, and is useful for accessing the field via an interface.

func (*CreateCountDistinctMetricInput) GetUniqueName

func (v *CreateCountDistinctMetricInput) GetUniqueName() *string

GetUniqueName returns CreateCountDistinctMetricInput.UniqueName, and is useful for accessing the field via an interface.

type CreateCountDistinctMetricResponse

type CreateCountDistinctMetricResponse struct {
	// Creates a new Count Distinct Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).
	//
	// [Learn more about Metrics](https://www.propeldata.com/docs/metrics).
	CreateCountDistinctMetric *CreateCountDistinctMetricCreateCountDistinctMetricMetricResponse `json:"createCountDistinctMetric"`
}

CreateCountDistinctMetricResponse is returned by CreateCountDistinctMetric on success.

func (*CreateCountDistinctMetricResponse) GetCreateCountDistinctMetric

GetCreateCountDistinctMetric returns CreateCountDistinctMetricResponse.CreateCountDistinctMetric, and is useful for accessing the field via an interface.

type CreateCountMetricCreateCountMetricMetricResponse

type CreateCountMetricCreateCountMetricMetricResponse struct {
	Typename *string `json:"__typename"`
	// The Metric which was created or modified.
	Metric *CreateCountMetricCreateCountMetricMetricResponseMetric `json:"metric"`
}

CreateCountMetricCreateCountMetricMetricResponse includes the requested fields of the GraphQL type MetricResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Metric.

func (*CreateCountMetricCreateCountMetricMetricResponse) GetMetric

GetMetric returns CreateCountMetricCreateCountMetricMetricResponse.Metric, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponse) GetTypename

GetTypename returns CreateCountMetricCreateCountMetricMetricResponse.Typename, and is useful for accessing the field via an interface.

type CreateCountMetricCreateCountMetricMetricResponseMetric

type CreateCountMetricCreateCountMetricMetricResponseMetric struct {
	MetricData `json:"-"`
}

CreateCountMetricCreateCountMetricMetricResponseMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetAccessControlEnabled added in v0.1.4

func (v *CreateCountMetricCreateCountMetricMetricResponseMetric) GetAccessControlEnabled() bool

GetAccessControlEnabled returns CreateCountMetricCreateCountMetricMetricResponseMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetAccount

GetAccount returns CreateCountMetricCreateCountMetricMetricResponseMetric.Account, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetCreatedAt

GetCreatedAt returns CreateCountMetricCreateCountMetricMetricResponseMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetCreatedBy

GetCreatedBy returns CreateCountMetricCreateCountMetricMetricResponseMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetDataPool

GetDataPool returns CreateCountMetricCreateCountMetricMetricResponseMetric.DataPool, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetDescription

GetDescription returns CreateCountMetricCreateCountMetricMetricResponseMetric.Description, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetDimensions

GetDimensions returns CreateCountMetricCreateCountMetricMetricResponseMetric.Dimensions, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetEnvironment

GetEnvironment returns CreateCountMetricCreateCountMetricMetricResponseMetric.Environment, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetId

GetId returns CreateCountMetricCreateCountMetricMetricResponseMetric.Id, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetMeasure

GetMeasure returns CreateCountMetricCreateCountMetricMetricResponseMetric.Measure, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetModifiedAt

GetModifiedAt returns CreateCountMetricCreateCountMetricMetricResponseMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetModifiedBy

GetModifiedBy returns CreateCountMetricCreateCountMetricMetricResponseMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetSettings

GetSettings returns CreateCountMetricCreateCountMetricMetricResponseMetric.Settings, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetTimestamp

GetTimestamp returns CreateCountMetricCreateCountMetricMetricResponseMetric.Timestamp, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetType

GetType returns CreateCountMetricCreateCountMetricMetricResponseMetric.Type, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) GetUniqueName

GetUniqueName returns CreateCountMetricCreateCountMetricMetricResponseMetric.UniqueName, and is useful for accessing the field via an interface.

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) MarshalJSON

func (*CreateCountMetricCreateCountMetricMetricResponseMetric) UnmarshalJSON

type CreateCountMetricInput

type CreateCountMetricInput struct {
	// The Data Pool that powers this Metric.
	DataPool string `json:"dataPool"`
	// The Metric's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
	// The Metric's description.
	Description *string `json:"description"`
	// The Metric's Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	Filters []*FilterInput `json:"filters,omitempty"`
	// The Metric's Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	FilterSql *string `json:"filterSql"`
	// The Metric's Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.
	Dimensions []*DimensionInput `json:"dimensions,omitempty"`
}

The fields for creating a new Count Metric.

func (*CreateCountMetricInput) GetDataPool

func (v *CreateCountMetricInput) GetDataPool() string

GetDataPool returns CreateCountMetricInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateCountMetricInput) GetDescription

func (v *CreateCountMetricInput) GetDescription() *string

GetDescription returns CreateCountMetricInput.Description, and is useful for accessing the field via an interface.

func (*CreateCountMetricInput) GetDimensions

func (v *CreateCountMetricInput) GetDimensions() []*DimensionInput

GetDimensions returns CreateCountMetricInput.Dimensions, and is useful for accessing the field via an interface.

func (*CreateCountMetricInput) GetFilterSql added in v1.2.1

func (v *CreateCountMetricInput) GetFilterSql() *string

GetFilterSql returns CreateCountMetricInput.FilterSql, and is useful for accessing the field via an interface.

func (*CreateCountMetricInput) GetFilters

func (v *CreateCountMetricInput) GetFilters() []*FilterInput

GetFilters returns CreateCountMetricInput.Filters, and is useful for accessing the field via an interface.

func (*CreateCountMetricInput) GetUniqueName

func (v *CreateCountMetricInput) GetUniqueName() *string

GetUniqueName returns CreateCountMetricInput.UniqueName, and is useful for accessing the field via an interface.

type CreateCountMetricResponse

type CreateCountMetricResponse struct {
	// Creates a new Count Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).
	//
	// [Learn more about Metrics](https://www.propeldata.com/docs/metrics).
	CreateCountMetric *CreateCountMetricCreateCountMetricMetricResponse `json:"createCountMetric"`
}

CreateCountMetricResponse is returned by CreateCountMetric on success.

func CreateCountMetric

func CreateCountMetric(
	ctx context.Context,
	client graphql.Client,
	input *CreateCountMetricInput,
) (*CreateCountMetricResponse, error)

func (*CreateCountMetricResponse) GetCreateCountMetric

GetCreateCountMetric returns CreateCountMetricResponse.CreateCountMetric, and is useful for accessing the field via an interface.

type CreateCustomMetricCreateCustomMetricMetricResponse added in v0.1.6

type CreateCustomMetricCreateCustomMetricMetricResponse struct {
	Typename *string `json:"__typename"`
	// The Metric which was created or modified.
	Metric *CreateCustomMetricCreateCustomMetricMetricResponseMetric `json:"metric"`
}

CreateCustomMetricCreateCustomMetricMetricResponse includes the requested fields of the GraphQL type MetricResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Metric.

func (*CreateCustomMetricCreateCustomMetricMetricResponse) GetMetric added in v0.1.6

GetMetric returns CreateCustomMetricCreateCustomMetricMetricResponse.Metric, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponse) GetTypename added in v0.1.6

GetTypename returns CreateCustomMetricCreateCustomMetricMetricResponse.Typename, and is useful for accessing the field via an interface.

type CreateCustomMetricCreateCustomMetricMetricResponseMetric added in v0.1.6

type CreateCustomMetricCreateCustomMetricMetricResponseMetric struct {
	MetricData `json:"-"`
}

CreateCustomMetricCreateCustomMetricMetricResponseMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetAccessControlEnabled added in v0.1.6

GetAccessControlEnabled returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetAccount added in v0.1.6

GetAccount returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Account, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetCreatedAt added in v0.1.6

GetCreatedAt returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetCreatedBy added in v0.1.6

GetCreatedBy returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetDataPool added in v0.1.6

GetDataPool returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.DataPool, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetDescription added in v0.1.6

GetDescription returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Description, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetDimensions added in v0.1.6

GetDimensions returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Dimensions, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetEnvironment added in v0.1.6

GetEnvironment returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Environment, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetId added in v0.1.6

GetId returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Id, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetMeasure added in v0.1.6

GetMeasure returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Measure, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetModifiedAt added in v0.1.6

GetModifiedAt returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetModifiedBy added in v0.1.6

GetModifiedBy returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetSettings added in v0.1.6

GetSettings returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Settings, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetTimestamp added in v0.1.6

GetTimestamp returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Timestamp, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetType added in v0.1.6

GetType returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.Type, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) GetUniqueName added in v0.1.6

GetUniqueName returns CreateCustomMetricCreateCustomMetricMetricResponseMetric.UniqueName, and is useful for accessing the field via an interface.

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) MarshalJSON added in v0.1.6

func (*CreateCustomMetricCreateCustomMetricMetricResponseMetric) UnmarshalJSON added in v0.1.6

type CreateCustomMetricInput added in v0.1.6

type CreateCustomMetricInput struct {
	// The Data Pool that powers this Metric.
	DataPool string `json:"dataPool"`
	// The Metric's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
	// The Metric's description.
	Description *string `json:"description"`
	// The Metric's Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	Filters []*FilterInput `json:"filters,omitempty"`
	// The Metric's Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	FilterSql *string `json:"filterSql"`
	// The Metric's Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.
	Dimensions []*DimensionInput `json:"dimensions,omitempty"`
	// The expression that defines the aggregation function for this Metric.
	Expression string `json:"expression"`
}

The fields for creating a new Custom Metric.

func (*CreateCustomMetricInput) GetDataPool added in v0.1.6

func (v *CreateCustomMetricInput) GetDataPool() string

GetDataPool returns CreateCustomMetricInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateCustomMetricInput) GetDescription added in v0.1.6

func (v *CreateCustomMetricInput) GetDescription() *string

GetDescription returns CreateCustomMetricInput.Description, and is useful for accessing the field via an interface.

func (*CreateCustomMetricInput) GetDimensions added in v0.1.6

func (v *CreateCustomMetricInput) GetDimensions() []*DimensionInput

GetDimensions returns CreateCustomMetricInput.Dimensions, and is useful for accessing the field via an interface.

func (*CreateCustomMetricInput) GetExpression added in v0.1.6

func (v *CreateCustomMetricInput) GetExpression() string

GetExpression returns CreateCustomMetricInput.Expression, and is useful for accessing the field via an interface.

func (*CreateCustomMetricInput) GetFilterSql added in v1.2.1

func (v *CreateCustomMetricInput) GetFilterSql() *string

GetFilterSql returns CreateCustomMetricInput.FilterSql, and is useful for accessing the field via an interface.

func (*CreateCustomMetricInput) GetFilters added in v0.1.6

func (v *CreateCustomMetricInput) GetFilters() []*FilterInput

GetFilters returns CreateCustomMetricInput.Filters, and is useful for accessing the field via an interface.

func (*CreateCustomMetricInput) GetUniqueName added in v0.1.6

func (v *CreateCustomMetricInput) GetUniqueName() *string

GetUniqueName returns CreateCustomMetricInput.UniqueName, and is useful for accessing the field via an interface.

type CreateCustomMetricResponse added in v0.1.6

type CreateCustomMetricResponse struct {
	// Creates a new Custom Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).
	//
	// [Learn more about Metrics](https://www.propeldata.com/docs/metrics).
	CreateCustomMetric *CreateCustomMetricCreateCustomMetricMetricResponse `json:"createCustomMetric"`
}

CreateCustomMetricResponse is returned by CreateCustomMetric on success.

func CreateCustomMetric added in v0.1.6

func CreateCustomMetric(
	ctx context.Context,
	client graphql.Client,
	input *CreateCustomMetricInput,
) (*CreateCustomMetricResponse, error)

func (*CreateCustomMetricResponse) GetCreateCustomMetric added in v0.1.6

GetCreateCustomMetric returns CreateCustomMetricResponse.CreateCustomMetric, and is useful for accessing the field via an interface.

type CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponse added in v1.1.0

type CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponse struct {
	// The Data Pool Access Policy.
	DataPoolAccessPolicy *CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy `json:"dataPoolAccessPolicy"`
}

CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponse includes the requested fields of the GraphQL type DataPoolAccessPolicyResponse.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponse) GetDataPoolAccessPolicy added in v1.1.0

GetDataPoolAccessPolicy returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponse.DataPoolAccessPolicy, and is useful for accessing the field via an interface.

type CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy added in v1.1.0

type CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy struct {
	DataPoolAccessPolicyData `json:"-"`
}

CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy includes the requested fields of the GraphQL type DataPoolAccessPolicy.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetAccount added in v1.1.0

GetAccount returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Account, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetColumns added in v1.1.0

GetColumns returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Columns, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetCreatedAt added in v1.1.0

GetCreatedAt returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetCreatedBy added in v1.1.0

GetCreatedBy returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetDataPool added in v1.1.0

GetDataPool returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.DataPool, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetDescription added in v1.1.0

GetDescription returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Description, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetEnvironment added in v1.1.0

GetEnvironment returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Environment, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetId added in v1.1.0

GetId returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Id, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetModifiedAt added in v1.1.0

GetModifiedAt returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetModifiedBy added in v1.1.0

GetModifiedBy returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetRows added in v1.1.0

GetRows returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Rows, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetUniqueName added in v1.1.0

GetUniqueName returns CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.UniqueName, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) MarshalJSON added in v1.1.0

func (*CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) UnmarshalJSON added in v1.1.0

type CreateDataPoolAccessPolicyInput added in v1.1.0

type CreateDataPoolAccessPolicyInput struct {
	// The Data Pool Access Policy's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
	// The Data Pool Access Policy's description.
	Description *string `json:"description"`
	// The Data Pool to which the Access Policy belongs.
	DataPool string `json:"dataPool"`
	// Columns that the Access Policy makes available for querying.
	//
	// If set to `["*"]`, all columns will be available for querying.
	Columns []string `json:"columns"`
	// Row-level filters that the Access Policy applies before executing queries.
	Rows []*FilterInput `json:"rows,omitempty"`
	// Row-level filters that the Access Policy applies before executing queries, in the form of SQL.
	FilterSql *string `json:"filterSql"`
}

func (*CreateDataPoolAccessPolicyInput) GetColumns added in v1.1.0

func (v *CreateDataPoolAccessPolicyInput) GetColumns() []string

GetColumns returns CreateDataPoolAccessPolicyInput.Columns, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyInput) GetDataPool added in v1.1.0

func (v *CreateDataPoolAccessPolicyInput) GetDataPool() string

GetDataPool returns CreateDataPoolAccessPolicyInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyInput) GetDescription added in v1.1.0

func (v *CreateDataPoolAccessPolicyInput) GetDescription() *string

GetDescription returns CreateDataPoolAccessPolicyInput.Description, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyInput) GetFilterSql added in v1.2.1

func (v *CreateDataPoolAccessPolicyInput) GetFilterSql() *string

GetFilterSql returns CreateDataPoolAccessPolicyInput.FilterSql, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyInput) GetRows added in v1.1.0

GetRows returns CreateDataPoolAccessPolicyInput.Rows, and is useful for accessing the field via an interface.

func (*CreateDataPoolAccessPolicyInput) GetUniqueName added in v1.1.0

func (v *CreateDataPoolAccessPolicyInput) GetUniqueName() *string

GetUniqueName returns CreateDataPoolAccessPolicyInput.UniqueName, and is useful for accessing the field via an interface.

type CreateDataPoolAccessPolicyResponse added in v1.1.0

type CreateDataPoolAccessPolicyResponse struct {
	// Creates a Data Pool Access Policy for the specified Data Pool.
	//
	// [Learn more about Data Pool Access Policy](https://www.propeldata.com/docs/control-access).
	CreateDataPoolAccessPolicy *CreateDataPoolAccessPolicyCreateDataPoolAccessPolicyDataPoolAccessPolicyResponse `json:"createDataPoolAccessPolicy"`
}

CreateDataPoolAccessPolicyResponse is returned by CreateDataPoolAccessPolicy on success.

func CreateDataPoolAccessPolicy added in v1.1.0

func CreateDataPoolAccessPolicy(
	ctx context.Context,
	client graphql.Client,
	input *CreateDataPoolAccessPolicyInput,
) (*CreateDataPoolAccessPolicyResponse, error)

func (*CreateDataPoolAccessPolicyResponse) GetCreateDataPoolAccessPolicy added in v1.1.0

GetCreateDataPoolAccessPolicy returns CreateDataPoolAccessPolicyResponse.CreateDataPoolAccessPolicy, and is useful for accessing the field via an interface.

type CreateDataPoolCreateDataPoolV2DataPoolResponse

type CreateDataPoolCreateDataPoolV2DataPoolResponse struct {
	Typename *string `json:"__typename"`
	// The Data Pool which was created or modified.
	DataPool *CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool `json:"dataPool"`
}

CreateDataPoolCreateDataPoolV2DataPoolResponse includes the requested fields of the GraphQL type DataPoolResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Pool.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponse) GetDataPool

GetDataPool returns CreateDataPoolCreateDataPoolV2DataPoolResponse.DataPool, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponse) GetTypename

GetTypename returns CreateDataPoolCreateDataPoolV2DataPoolResponse.Typename, and is useful for accessing the field via an interface.

type CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool

type CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool struct {
	DataPoolData `json:"-"`
}

CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetAccessControlEnabled added in v1.1.0

func (v *CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetAccessControlEnabled() bool

GetAccessControlEnabled returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetAccount

GetAccount returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Account, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetAvailableMeasures

GetAvailableMeasures returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.AvailableMeasures, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetColumns

GetColumns returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Columns, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetCreatedAt

GetCreatedAt returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetCreatedBy

GetCreatedBy returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetDataPoolAccessPolicies added in v1.1.0

GetDataPoolAccessPolicies returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.DataPoolAccessPolicies, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetDataSource

GetDataSource returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.DataSource, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetDescription

GetDescription returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Description, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetEnvironment

GetEnvironment returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Environment, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetError

GetError returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Error, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetId

GetId returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Id, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetModifiedAt

GetModifiedAt returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetModifiedBy

GetModifiedBy returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetSetupTasks

GetSetupTasks returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.SetupTasks, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetStatus

GetStatus returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Status, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetSyncing added in v0.1.3

GetSyncing returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Syncing, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetSyncs

GetSyncs returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Syncs, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetTable

GetTable returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Table, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetTenant added in v1.2.1

GetTenant returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Tenant, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetTimestamp

GetTimestamp returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.Timestamp, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetUniqueId added in v1.0.0

GetUniqueId returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.UniqueId, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) GetUniqueName

GetUniqueName returns CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool.UniqueName, and is useful for accessing the field via an interface.

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) MarshalJSON

func (*CreateDataPoolCreateDataPoolV2DataPoolResponseDataPool) UnmarshalJSON

type CreateDataPoolInputV2

type CreateDataPoolInputV2 struct {
	// The Data Source that will be used to create the Data Pool.
	DataSource *string `json:"dataSource"`
	// The table that the Data Pool will sync from.
	Table *string `json:"table"`
	// The table's primary timestamp column.
	//
	// Propel uses the primary timestamp to order and partition your data in Data Pools. It's part of what makes Propel
	// fast for larger data sets. It will also serve as the time dimension for your Metrics.
	//
	// If you do not provide a primary timestamp column, you will need to supply an alternate timestamp when querying your
	// Data Pool or its Metrics using the TimeRangeInput.
	Timestamp *TimestampInput `json:"timestamp,omitempty"`
	// The Data Pool's unique name. If not specified, Propel will set the ID as the unique name.
	UniqueName *string `json:"uniqueName"`
	// The Data Pool's description.
	Description *string `json:"description"`
	// The list of columns.
	Columns []*DataPoolColumnInput `json:"columns,omitempty"`
	// The Data Pool's optional tenant ID column. The tenant ID column is used to control access to your data with access policies.
	Tenant *TenantInput `json:"tenant,omitempty"`
	// The Data Pool's unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.
	UniqueId *UniqueIdInput `json:"uniqueId,omitempty"`
	// The Data Pool's syncing settings.
	Syncing *DataPoolSyncingInput `json:"syncing,omitempty"`
	// Enables or disables access control for the Data Pool.
	//
	// If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
	// Policies in order to query the Data Pool and its Metrics.
	AccessControlEnabled *bool `json:"accessControlEnabled"`
	// Override the Data Pool's table settings. These describe how the Data Pool's table is created in ClickHouse, and a
	// default will be chosen based on the Data Pool's `timestamp` and `uniqueId` values, if any. You can override these
	// defaults in order to specify a custom table engine, custom ORDER BY, etc.
	TableSettings *TableSettingsInput `json:"tableSettings,omitempty"`
}

The fields for creating a Data Pool.

func (*CreateDataPoolInputV2) GetAccessControlEnabled added in v1.0.1

func (v *CreateDataPoolInputV2) GetAccessControlEnabled() *bool

GetAccessControlEnabled returns CreateDataPoolInputV2.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetColumns

func (v *CreateDataPoolInputV2) GetColumns() []*DataPoolColumnInput

GetColumns returns CreateDataPoolInputV2.Columns, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetDataSource

func (v *CreateDataPoolInputV2) GetDataSource() *string

GetDataSource returns CreateDataPoolInputV2.DataSource, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetDescription

func (v *CreateDataPoolInputV2) GetDescription() *string

GetDescription returns CreateDataPoolInputV2.Description, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetSyncing added in v0.1.2

GetSyncing returns CreateDataPoolInputV2.Syncing, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetTable

func (v *CreateDataPoolInputV2) GetTable() *string

GetTable returns CreateDataPoolInputV2.Table, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetTableSettings added in v1.2.1

func (v *CreateDataPoolInputV2) GetTableSettings() *TableSettingsInput

GetTableSettings returns CreateDataPoolInputV2.TableSettings, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetTenant

func (v *CreateDataPoolInputV2) GetTenant() *TenantInput

GetTenant returns CreateDataPoolInputV2.Tenant, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetTimestamp

func (v *CreateDataPoolInputV2) GetTimestamp() *TimestampInput

GetTimestamp returns CreateDataPoolInputV2.Timestamp, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetUniqueId added in v1.0.0

func (v *CreateDataPoolInputV2) GetUniqueId() *UniqueIdInput

GetUniqueId returns CreateDataPoolInputV2.UniqueId, and is useful for accessing the field via an interface.

func (*CreateDataPoolInputV2) GetUniqueName

func (v *CreateDataPoolInputV2) GetUniqueName() *string

GetUniqueName returns CreateDataPoolInputV2.UniqueName, and is useful for accessing the field via an interface.

type CreateDataPoolResponse

type CreateDataPoolResponse struct {
	// Creates a new Data Pool from the given Data Source based on the specified table and using a particular column as the timestamp.
	//
	// Returns the newly created Data Pool (or an error message if creating the Data Pool fails).
	//
	// [Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).
	CreateDataPoolV2 *CreateDataPoolCreateDataPoolV2DataPoolResponse `json:"createDataPoolV2"`
}

CreateDataPoolResponse is returned by CreateDataPool on success.

func CreateDataPool

func CreateDataPool(
	ctx context.Context,
	client graphql.Client,
	input *CreateDataPoolInputV2,
) (*CreateDataPoolResponse, error)

func (*CreateDataPoolResponse) GetCreateDataPoolV2

GetCreateDataPoolV2 returns CreateDataPoolResponse.CreateDataPoolV2, and is useful for accessing the field via an interface.

type CreateHttpDataSourceCreateHttpDataSourceDataSourceResponse

type CreateHttpDataSourceCreateHttpDataSourceDataSourceResponse struct {
	// The Data Source which was created or modified.
	DataSource *CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource `json:"dataSource"`
}

CreateHttpDataSourceCreateHttpDataSourceDataSourceResponse includes the requested fields of the GraphQL type DataSourceResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Source.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponse) GetDataSource

GetDataSource returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponse.DataSource, and is useful for accessing the field via an interface.

type CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource

type CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource struct {
	DataSourceData `json:"-"`
}

CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetAccount

GetAccount returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Account, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetChecks

GetChecks returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Checks, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetConnectionSettings

GetConnectionSettings returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetCreatedAt

GetCreatedAt returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetCreatedBy

GetCreatedBy returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetDataPools added in v1.0.1

GetDataPools returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.DataPools, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetDescription

GetDescription returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Description, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetEnvironment

GetEnvironment returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Environment, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetError

GetError returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Error, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetId

GetId returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Id, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetModifiedAt

GetModifiedAt returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetModifiedBy

GetModifiedBy returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetStatus

GetStatus returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Status, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetTableIntrospections

GetTableIntrospections returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetTables

GetTables returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Tables, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetType

GetType returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.Type, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) GetUniqueName

GetUniqueName returns CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) MarshalJSON

func (*CreateHttpDataSourceCreateHttpDataSourceDataSourceResponseDataSource) UnmarshalJSON

type CreateHttpDataSourceInput

type CreateHttpDataSourceInput struct {
	// The HTTP Data Source's connection settings
	ConnectionSettings *HttpConnectionSettingsInput `json:"connectionSettings,omitempty"`
	// The HTTP Data Source's description.
	Description *string `json:"description"`
	// The HTTP Data Source's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
}

func (*CreateHttpDataSourceInput) GetConnectionSettings

func (v *CreateHttpDataSourceInput) GetConnectionSettings() *HttpConnectionSettingsInput

GetConnectionSettings returns CreateHttpDataSourceInput.ConnectionSettings, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceInput) GetDescription

func (v *CreateHttpDataSourceInput) GetDescription() *string

GetDescription returns CreateHttpDataSourceInput.Description, and is useful for accessing the field via an interface.

func (*CreateHttpDataSourceInput) GetUniqueName

func (v *CreateHttpDataSourceInput) GetUniqueName() *string

GetUniqueName returns CreateHttpDataSourceInput.UniqueName, and is useful for accessing the field via an interface.

type CreateHttpDataSourceResponse

type CreateHttpDataSourceResponse struct {
	// Creates a new HTTP Data Source from the given settings.
	//
	// Returns the newly created Data Source (or an error message if creating the Data Source fails).
	CreateHttpDataSource *CreateHttpDataSourceCreateHttpDataSourceDataSourceResponse `json:"createHttpDataSource"`
}

CreateHttpDataSourceResponse is returned by CreateHttpDataSource on success.

func (*CreateHttpDataSourceResponse) GetCreateHttpDataSource

GetCreateHttpDataSource returns CreateHttpDataSourceResponse.CreateHttpDataSource, and is useful for accessing the field via an interface.

type CreateMaterializedViewCreateMaterializedViewMaterializedViewResponse added in v1.2.1

type CreateMaterializedViewCreateMaterializedViewMaterializedViewResponse struct {
	Typename *string `json:"__typename"`
	// The Materialized View which was created or modified.
	MaterializedView *CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView `json:"materializedView"`
}

CreateMaterializedViewCreateMaterializedViewMaterializedViewResponse includes the requested fields of the GraphQL type MaterializedViewResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Materialized View.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponse) GetMaterializedView added in v1.2.1

GetMaterializedView returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponse.MaterializedView, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponse) GetTypename added in v1.2.1

GetTypename returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponse.Typename, and is useful for accessing the field via an interface.

type CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView added in v1.2.1

type CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView struct {
	MaterializedViewData `json:"-"`
}

CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView includes the requested fields of the GraphQL type MaterializedView.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetAccount added in v1.2.1

GetAccount returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.Account, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetCreatedAt added in v1.2.1

GetCreatedAt returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetCreatedBy added in v1.2.1

GetCreatedBy returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetDescription added in v1.2.1

GetDescription returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.Description, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetDestination added in v1.2.1

GetDestination returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.Destination, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetEnvironment added in v1.2.1

GetEnvironment returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.Environment, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetId added in v1.2.1

GetId returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.Id, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetModifiedAt added in v1.2.1

GetModifiedAt returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetModifiedBy added in v1.2.1

GetModifiedBy returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetOthers added in v1.2.1

GetOthers returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.Others, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetSource added in v1.2.1

GetSource returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.Source, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetSql added in v1.2.1

GetSql returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.Sql, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) GetUniqueName added in v1.2.1

GetUniqueName returns CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView.UniqueName, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) MarshalJSON added in v1.2.1

func (*CreateMaterializedViewCreateMaterializedViewMaterializedViewResponseMaterializedView) UnmarshalJSON added in v1.2.1

type CreateMaterializedViewDestinationInput added in v1.2.1

type CreateMaterializedViewDestinationInput struct {
	// If specified, the Materialized View will target an existing Data Pool.
	// Ensure the Data Pool's schema is compatible with your Materialized View's SQL statement.
	ExistingDataPool *DataPoolInput `json:"existingDataPool,omitempty"`
	// If specified, the Materialized View will create and target a new Data Pool.
	// You can further customize the new Data Pool's engine settings.
	NewDataPool *CreateMaterializedViewDestinationNewDataPoolInput `json:"newDataPool,omitempty"`
}

The fields for targeting an existing Data Pool or a new Data Pool.

func (*CreateMaterializedViewDestinationInput) GetExistingDataPool added in v1.2.1

func (v *CreateMaterializedViewDestinationInput) GetExistingDataPool() *DataPoolInput

GetExistingDataPool returns CreateMaterializedViewDestinationInput.ExistingDataPool, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewDestinationInput) GetNewDataPool added in v1.2.1

GetNewDataPool returns CreateMaterializedViewDestinationInput.NewDataPool, and is useful for accessing the field via an interface.

type CreateMaterializedViewDestinationNewDataPoolInput added in v1.2.1

type CreateMaterializedViewDestinationNewDataPoolInput struct {
	// The Data Pool's unique name.
	UniqueName *string `json:"uniqueName"`
	// The Data Pool's description.
	Description *string `json:"description"`
	// Optionally specify the Data Pool's primary timestamp. This will influence the Data Pool's engine settings.
	Timestamp *TimestampInput `json:"timestamp,omitempty"`
	// Optionally specify the Data Pool's unique ID. This will influence the Data Pool's engine settings.
	UniqueId *UniqueIdInput `json:"uniqueId,omitempty"`
	// Enables or disables access control for the Data Pool.
	//
	// If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
	// Policies in order to query the Data Pool and its Metrics.
	AccessControlEnabled *bool `json:"accessControlEnabled"`
	// Override the Data Pool's table settings. These describe how the Data Pool's table is created in ClickHouse, and a
	// default will be chosen based on the Data Pool's `timestamp` and `uniqueId` values, if any. You can override these
	// defaults in order to specify a custom table engine, custom ORDER BY, etc.
	TableSettings *TableSettingsInput `json:"tableSettings,omitempty"`
}

The fields for customizing a new Data Pool that a Materialized View will target.

func (*CreateMaterializedViewDestinationNewDataPoolInput) GetAccessControlEnabled added in v1.2.1

func (v *CreateMaterializedViewDestinationNewDataPoolInput) GetAccessControlEnabled() *bool

GetAccessControlEnabled returns CreateMaterializedViewDestinationNewDataPoolInput.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewDestinationNewDataPoolInput) GetDescription added in v1.2.1

GetDescription returns CreateMaterializedViewDestinationNewDataPoolInput.Description, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewDestinationNewDataPoolInput) GetTableSettings added in v1.2.1

GetTableSettings returns CreateMaterializedViewDestinationNewDataPoolInput.TableSettings, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewDestinationNewDataPoolInput) GetTimestamp added in v1.2.1

GetTimestamp returns CreateMaterializedViewDestinationNewDataPoolInput.Timestamp, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewDestinationNewDataPoolInput) GetUniqueId added in v1.2.1

GetUniqueId returns CreateMaterializedViewDestinationNewDataPoolInput.UniqueId, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewDestinationNewDataPoolInput) GetUniqueName added in v1.2.1

GetUniqueName returns CreateMaterializedViewDestinationNewDataPoolInput.UniqueName, and is useful for accessing the field via an interface.

type CreateMaterializedViewInput added in v1.2.1

type CreateMaterializedViewInput struct {
	// The Materialized View's unique name. If not specified, Propel will set the ID as the unique name.
	UniqueName *string `json:"uniqueName"`
	// The Materialized View's description.
	Description *string `json:"description"`
	// The SQL that the Materialized View will execute.
	Sql string `json:"sql"`
	// By default, a destination Data Pool with default settings will be created for the Materialized View;
	// however, you can customize the destination Data Pool (or point to an existing Data Pool), by setting
	// this field. Use this to target an existing Data Pool or the engine settings of a new Data Pool.
	Destination *CreateMaterializedViewDestinationInput `json:"destination,omitempty"`
	// By default, a Materialized View only applies to records added after its creation. This option allows
	// to backfill all the data that was present before the Materialized View creation.
	BackfillOptions *BackfillOptionsInput `json:"backfillOptions,omitempty"`
}

The fields for creating a Materialized View.

func (*CreateMaterializedViewInput) GetBackfillOptions added in v1.2.1

func (v *CreateMaterializedViewInput) GetBackfillOptions() *BackfillOptionsInput

GetBackfillOptions returns CreateMaterializedViewInput.BackfillOptions, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewInput) GetDescription added in v1.2.1

func (v *CreateMaterializedViewInput) GetDescription() *string

GetDescription returns CreateMaterializedViewInput.Description, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewInput) GetDestination added in v1.2.1

GetDestination returns CreateMaterializedViewInput.Destination, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewInput) GetSql added in v1.2.1

func (v *CreateMaterializedViewInput) GetSql() string

GetSql returns CreateMaterializedViewInput.Sql, and is useful for accessing the field via an interface.

func (*CreateMaterializedViewInput) GetUniqueName added in v1.2.1

func (v *CreateMaterializedViewInput) GetUniqueName() *string

GetUniqueName returns CreateMaterializedViewInput.UniqueName, and is useful for accessing the field via an interface.

type CreateMaterializedViewResponse added in v1.2.1

type CreateMaterializedViewResponse struct {
	// Creates a new Materialized View.
	// Returns the newly created Materialized View (or an error message if creating the Materialized View fails).
	CreateMaterializedView *CreateMaterializedViewCreateMaterializedViewMaterializedViewResponse `json:"createMaterializedView"`
}

CreateMaterializedViewResponse is returned by CreateMaterializedView on success.

func CreateMaterializedView added in v1.2.1

func CreateMaterializedView(
	ctx context.Context,
	client graphql.Client,
	input *CreateMaterializedViewInput,
) (*CreateMaterializedViewResponse, error)

func (*CreateMaterializedViewResponse) GetCreateMaterializedView added in v1.2.1

GetCreateMaterializedView returns CreateMaterializedViewResponse.CreateMaterializedView, and is useful for accessing the field via an interface.

type CreateMaxMetricCreateMaxMetricMetricResponse added in v0.1.3

type CreateMaxMetricCreateMaxMetricMetricResponse struct {
	Typename *string `json:"__typename"`
	// The Metric which was created or modified.
	Metric *CreateMaxMetricCreateMaxMetricMetricResponseMetric `json:"metric"`
}

CreateMaxMetricCreateMaxMetricMetricResponse includes the requested fields of the GraphQL type MetricResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Metric.

func (*CreateMaxMetricCreateMaxMetricMetricResponse) GetMetric added in v0.1.3

GetMetric returns CreateMaxMetricCreateMaxMetricMetricResponse.Metric, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponse) GetTypename added in v0.1.3

GetTypename returns CreateMaxMetricCreateMaxMetricMetricResponse.Typename, and is useful for accessing the field via an interface.

type CreateMaxMetricCreateMaxMetricMetricResponseMetric added in v0.1.3

type CreateMaxMetricCreateMaxMetricMetricResponseMetric struct {
	MetricData `json:"-"`
}

CreateMaxMetricCreateMaxMetricMetricResponseMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetAccessControlEnabled added in v0.1.4

func (v *CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetAccessControlEnabled() bool

GetAccessControlEnabled returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetAccount added in v0.1.3

GetAccount returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Account, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetCreatedAt added in v0.1.3

GetCreatedAt returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetCreatedBy added in v0.1.3

GetCreatedBy returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetDataPool added in v0.1.3

GetDataPool returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.DataPool, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetDescription added in v0.1.3

GetDescription returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Description, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetDimensions added in v0.1.3

GetDimensions returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Dimensions, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetEnvironment added in v0.1.3

GetEnvironment returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Environment, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetId added in v0.1.3

GetId returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Id, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetMeasure added in v0.1.3

GetMeasure returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Measure, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetModifiedAt added in v0.1.3

GetModifiedAt returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetModifiedBy added in v0.1.3

GetModifiedBy returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetSettings added in v0.1.3

GetSettings returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Settings, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetTimestamp added in v0.1.3

GetTimestamp returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Timestamp, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetType added in v0.1.3

GetType returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.Type, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) GetUniqueName added in v0.1.3

GetUniqueName returns CreateMaxMetricCreateMaxMetricMetricResponseMetric.UniqueName, and is useful for accessing the field via an interface.

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) MarshalJSON added in v0.1.3

func (*CreateMaxMetricCreateMaxMetricMetricResponseMetric) UnmarshalJSON added in v0.1.3

type CreateMaxMetricInput added in v0.1.3

type CreateMaxMetricInput struct {
	// The Data Pool that powers this Metric.
	DataPool string `json:"dataPool"`
	// The Metric's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
	// The Metric's description.
	Description *string `json:"description"`
	// The Metric's Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	Filters []*FilterInput `json:"filters,omitempty"`
	// The Metric's Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	FilterSql *string `json:"filterSql"`
	// The Metric's Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.
	Dimensions []*DimensionInput `json:"dimensions,omitempty"`
	// The column to calculate the maximum from.
	Measure *DimensionInput `json:"measure,omitempty"`
}

The fields for creating a new Maximum (Max) Metric.

func (*CreateMaxMetricInput) GetDataPool added in v0.1.3

func (v *CreateMaxMetricInput) GetDataPool() string

GetDataPool returns CreateMaxMetricInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateMaxMetricInput) GetDescription added in v0.1.3

func (v *CreateMaxMetricInput) GetDescription() *string

GetDescription returns CreateMaxMetricInput.Description, and is useful for accessing the field via an interface.

func (*CreateMaxMetricInput) GetDimensions added in v0.1.3

func (v *CreateMaxMetricInput) GetDimensions() []*DimensionInput

GetDimensions returns CreateMaxMetricInput.Dimensions, and is useful for accessing the field via an interface.

func (*CreateMaxMetricInput) GetFilterSql added in v1.2.1

func (v *CreateMaxMetricInput) GetFilterSql() *string

GetFilterSql returns CreateMaxMetricInput.FilterSql, and is useful for accessing the field via an interface.

func (*CreateMaxMetricInput) GetFilters added in v0.1.3

func (v *CreateMaxMetricInput) GetFilters() []*FilterInput

GetFilters returns CreateMaxMetricInput.Filters, and is useful for accessing the field via an interface.

func (*CreateMaxMetricInput) GetMeasure added in v0.1.3

func (v *CreateMaxMetricInput) GetMeasure() *DimensionInput

GetMeasure returns CreateMaxMetricInput.Measure, and is useful for accessing the field via an interface.

func (*CreateMaxMetricInput) GetUniqueName added in v0.1.3

func (v *CreateMaxMetricInput) GetUniqueName() *string

GetUniqueName returns CreateMaxMetricInput.UniqueName, and is useful for accessing the field via an interface.

type CreateMaxMetricResponse added in v0.1.3

type CreateMaxMetricResponse struct {
	// Creates a new Max Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).
	//
	// [Learn more about Metrics](https://www.propeldata.com/docs/metrics).
	CreateMaxMetric *CreateMaxMetricCreateMaxMetricMetricResponse `json:"createMaxMetric"`
}

CreateMaxMetricResponse is returned by CreateMaxMetric on success.

func CreateMaxMetric added in v0.1.3

func CreateMaxMetric(
	ctx context.Context,
	client graphql.Client,
	input *CreateMaxMetricInput,
) (*CreateMaxMetricResponse, error)

func (*CreateMaxMetricResponse) GetCreateMaxMetric added in v0.1.3

GetCreateMaxMetric returns CreateMaxMetricResponse.CreateMaxMetric, and is useful for accessing the field via an interface.

type CreateMinMetricCreateMinMetricMetricResponse added in v0.1.3

type CreateMinMetricCreateMinMetricMetricResponse struct {
	Typename *string `json:"__typename"`
	// The Metric which was created or modified.
	Metric *CreateMinMetricCreateMinMetricMetricResponseMetric `json:"metric"`
}

CreateMinMetricCreateMinMetricMetricResponse includes the requested fields of the GraphQL type MetricResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Metric.

func (*CreateMinMetricCreateMinMetricMetricResponse) GetMetric added in v0.1.3

GetMetric returns CreateMinMetricCreateMinMetricMetricResponse.Metric, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponse) GetTypename added in v0.1.3

GetTypename returns CreateMinMetricCreateMinMetricMetricResponse.Typename, and is useful for accessing the field via an interface.

type CreateMinMetricCreateMinMetricMetricResponseMetric added in v0.1.3

type CreateMinMetricCreateMinMetricMetricResponseMetric struct {
	MetricData `json:"-"`
}

CreateMinMetricCreateMinMetricMetricResponseMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetAccessControlEnabled added in v0.1.4

func (v *CreateMinMetricCreateMinMetricMetricResponseMetric) GetAccessControlEnabled() bool

GetAccessControlEnabled returns CreateMinMetricCreateMinMetricMetricResponseMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetAccount added in v0.1.3

GetAccount returns CreateMinMetricCreateMinMetricMetricResponseMetric.Account, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetCreatedAt added in v0.1.3

GetCreatedAt returns CreateMinMetricCreateMinMetricMetricResponseMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetCreatedBy added in v0.1.3

GetCreatedBy returns CreateMinMetricCreateMinMetricMetricResponseMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetDataPool added in v0.1.3

GetDataPool returns CreateMinMetricCreateMinMetricMetricResponseMetric.DataPool, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetDescription added in v0.1.3

GetDescription returns CreateMinMetricCreateMinMetricMetricResponseMetric.Description, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetDimensions added in v0.1.3

GetDimensions returns CreateMinMetricCreateMinMetricMetricResponseMetric.Dimensions, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetEnvironment added in v0.1.3

GetEnvironment returns CreateMinMetricCreateMinMetricMetricResponseMetric.Environment, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetId added in v0.1.3

GetId returns CreateMinMetricCreateMinMetricMetricResponseMetric.Id, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetMeasure added in v0.1.3

GetMeasure returns CreateMinMetricCreateMinMetricMetricResponseMetric.Measure, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetModifiedAt added in v0.1.3

GetModifiedAt returns CreateMinMetricCreateMinMetricMetricResponseMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetModifiedBy added in v0.1.3

GetModifiedBy returns CreateMinMetricCreateMinMetricMetricResponseMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetSettings added in v0.1.3

GetSettings returns CreateMinMetricCreateMinMetricMetricResponseMetric.Settings, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetTimestamp added in v0.1.3

GetTimestamp returns CreateMinMetricCreateMinMetricMetricResponseMetric.Timestamp, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetType added in v0.1.3

GetType returns CreateMinMetricCreateMinMetricMetricResponseMetric.Type, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) GetUniqueName added in v0.1.3

GetUniqueName returns CreateMinMetricCreateMinMetricMetricResponseMetric.UniqueName, and is useful for accessing the field via an interface.

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) MarshalJSON added in v0.1.3

func (*CreateMinMetricCreateMinMetricMetricResponseMetric) UnmarshalJSON added in v0.1.3

type CreateMinMetricInput added in v0.1.3

type CreateMinMetricInput struct {
	// The Data Pool that powers this Metric.
	DataPool string `json:"dataPool"`
	// The Metric's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
	// The Metric's description.
	Description *string `json:"description"`
	// The Metric's Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	Filters []*FilterInput `json:"filters,omitempty"`
	// The Metric's Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	FilterSql *string `json:"filterSql"`
	// The Metric's Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.
	Dimensions []*DimensionInput `json:"dimensions,omitempty"`
	Measure    *DimensionInput   `json:"measure,omitempty"`
}

The fields for creating a new Minimum (Min) Metric.

func (*CreateMinMetricInput) GetDataPool added in v0.1.3

func (v *CreateMinMetricInput) GetDataPool() string

GetDataPool returns CreateMinMetricInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateMinMetricInput) GetDescription added in v0.1.3

func (v *CreateMinMetricInput) GetDescription() *string

GetDescription returns CreateMinMetricInput.Description, and is useful for accessing the field via an interface.

func (*CreateMinMetricInput) GetDimensions added in v0.1.3

func (v *CreateMinMetricInput) GetDimensions() []*DimensionInput

GetDimensions returns CreateMinMetricInput.Dimensions, and is useful for accessing the field via an interface.

func (*CreateMinMetricInput) GetFilterSql added in v1.2.1

func (v *CreateMinMetricInput) GetFilterSql() *string

GetFilterSql returns CreateMinMetricInput.FilterSql, and is useful for accessing the field via an interface.

func (*CreateMinMetricInput) GetFilters added in v0.1.3

func (v *CreateMinMetricInput) GetFilters() []*FilterInput

GetFilters returns CreateMinMetricInput.Filters, and is useful for accessing the field via an interface.

func (*CreateMinMetricInput) GetMeasure added in v0.1.3

func (v *CreateMinMetricInput) GetMeasure() *DimensionInput

GetMeasure returns CreateMinMetricInput.Measure, and is useful for accessing the field via an interface.

func (*CreateMinMetricInput) GetUniqueName added in v0.1.3

func (v *CreateMinMetricInput) GetUniqueName() *string

GetUniqueName returns CreateMinMetricInput.UniqueName, and is useful for accessing the field via an interface.

type CreateMinMetricResponse added in v0.1.3

type CreateMinMetricResponse struct {
	// Creates a new Min Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).
	//
	// [Learn more about Metrics](https://www.propeldata.com/docs/metrics).
	CreateMinMetric *CreateMinMetricCreateMinMetricMetricResponse `json:"createMinMetric"`
}

CreateMinMetricResponse is returned by CreateMinMetric on success.

func CreateMinMetric added in v0.1.3

func CreateMinMetric(
	ctx context.Context,
	client graphql.Client,
	input *CreateMinMetricInput,
) (*CreateMinMetricResponse, error)

func (*CreateMinMetricResponse) GetCreateMinMetric added in v0.1.3

GetCreateMinMetric returns CreateMinMetricResponse.CreateMinMetric, and is useful for accessing the field via an interface.

type CreatePolicyCreatePolicyPolicyResponse added in v0.1.4

type CreatePolicyCreatePolicyPolicyResponse struct {
	// The Policy which was created or modified.
	Policy *CreatePolicyCreatePolicyPolicyResponsePolicy `json:"policy"`
}

CreatePolicyCreatePolicyPolicyResponse includes the requested fields of the GraphQL type PolicyResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Policy.

func (*CreatePolicyCreatePolicyPolicyResponse) GetPolicy added in v0.1.4

GetPolicy returns CreatePolicyCreatePolicyPolicyResponse.Policy, and is useful for accessing the field via an interface.

type CreatePolicyCreatePolicyPolicyResponsePolicy added in v0.1.4

type CreatePolicyCreatePolicyPolicyResponsePolicy struct {
	PolicyData `json:"-"`
}

CreatePolicyCreatePolicyPolicyResponsePolicy includes the requested fields of the GraphQL type Policy. The GraphQL type's documentation follows.

The Policy type. It governs an Application's access to a Metric's data.

func (*CreatePolicyCreatePolicyPolicyResponsePolicy) GetApplication added in v0.1.4

GetApplication returns CreatePolicyCreatePolicyPolicyResponsePolicy.Application, and is useful for accessing the field via an interface.

func (*CreatePolicyCreatePolicyPolicyResponsePolicy) GetId added in v0.1.4

GetId returns CreatePolicyCreatePolicyPolicyResponsePolicy.Id, and is useful for accessing the field via an interface.

func (*CreatePolicyCreatePolicyPolicyResponsePolicy) GetMetric added in v0.1.4

GetMetric returns CreatePolicyCreatePolicyPolicyResponsePolicy.Metric, and is useful for accessing the field via an interface.

func (*CreatePolicyCreatePolicyPolicyResponsePolicy) GetType added in v0.1.4

GetType returns CreatePolicyCreatePolicyPolicyResponsePolicy.Type, and is useful for accessing the field via an interface.

func (*CreatePolicyCreatePolicyPolicyResponsePolicy) MarshalJSON added in v0.1.4

func (*CreatePolicyCreatePolicyPolicyResponsePolicy) UnmarshalJSON added in v0.1.4

type CreatePolicyInput added in v0.1.4

type CreatePolicyInput struct {
	// The Metric to which the Policy will be applied.
	Metric string `json:"metric"`
	// The type of Policy to create.
	Type PolicyType `json:"type"`
	// The Application that will be granted access to the Metric.
	Application string `json:"application"`
}

The fields for creating a Policy.

func (*CreatePolicyInput) GetApplication added in v0.1.4

func (v *CreatePolicyInput) GetApplication() string

GetApplication returns CreatePolicyInput.Application, and is useful for accessing the field via an interface.

func (*CreatePolicyInput) GetMetric added in v0.1.4

func (v *CreatePolicyInput) GetMetric() string

GetMetric returns CreatePolicyInput.Metric, and is useful for accessing the field via an interface.

func (*CreatePolicyInput) GetType added in v0.1.4

func (v *CreatePolicyInput) GetType() PolicyType

GetType returns CreatePolicyInput.Type, and is useful for accessing the field via an interface.

type CreatePolicyResponse added in v0.1.4

type CreatePolicyResponse struct {
	// Creates a new Policy granting an Application access to a Metric's data.
	CreatePolicy *CreatePolicyCreatePolicyPolicyResponse `json:"createPolicy"`
}

CreatePolicyResponse is returned by CreatePolicy on success.

func CreatePolicy added in v0.1.4

func CreatePolicy(
	ctx context.Context,
	client graphql.Client,
	input *CreatePolicyInput,
) (*CreatePolicyResponse, error)

func (*CreatePolicyResponse) GetCreatePolicy added in v0.1.4

GetCreatePolicy returns CreatePolicyResponse.CreatePolicy, and is useful for accessing the field via an interface.

type CreateS3DataSourceCreateS3DataSourceDataSourceResponse

type CreateS3DataSourceCreateS3DataSourceDataSourceResponse struct {
	// The Data Source which was created or modified.
	DataSource *CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource `json:"dataSource"`
}

CreateS3DataSourceCreateS3DataSourceDataSourceResponse includes the requested fields of the GraphQL type DataSourceResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Source.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponse) GetDataSource

GetDataSource returns CreateS3DataSourceCreateS3DataSourceDataSourceResponse.DataSource, and is useful for accessing the field via an interface.

type CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource

type CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource struct {
	DataSourceData `json:"-"`
}

CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetAccount

GetAccount returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Account, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetChecks

GetChecks returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Checks, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetConnectionSettings

GetConnectionSettings returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetCreatedAt

GetCreatedAt returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetCreatedBy

GetCreatedBy returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetDataPools added in v1.0.1

GetDataPools returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.DataPools, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetDescription

GetDescription returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Description, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetEnvironment

GetEnvironment returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Environment, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetError

GetError returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Error, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetId

GetId returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Id, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetModifiedAt

GetModifiedAt returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetModifiedBy

GetModifiedBy returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetStatus

GetStatus returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Status, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetTableIntrospections

GetTableIntrospections returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetTables

GetTables returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Tables, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetType

GetType returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.Type, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) GetUniqueName

GetUniqueName returns CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) MarshalJSON

func (*CreateS3DataSourceCreateS3DataSourceDataSourceResponseDataSource) UnmarshalJSON

type CreateS3DataSourceInput

type CreateS3DataSourceInput struct {
	// The S3 Data Source's connection settings
	ConnectionSettings *S3ConnectionSettingsInput `json:"connectionSettings,omitempty"`
	// The S3 Data Source's description.
	Description *string `json:"description"`
	// The S3 Data Source's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
}

func (*CreateS3DataSourceInput) GetConnectionSettings

func (v *CreateS3DataSourceInput) GetConnectionSettings() *S3ConnectionSettingsInput

GetConnectionSettings returns CreateS3DataSourceInput.ConnectionSettings, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceInput) GetDescription

func (v *CreateS3DataSourceInput) GetDescription() *string

GetDescription returns CreateS3DataSourceInput.Description, and is useful for accessing the field via an interface.

func (*CreateS3DataSourceInput) GetUniqueName

func (v *CreateS3DataSourceInput) GetUniqueName() *string

GetUniqueName returns CreateS3DataSourceInput.UniqueName, and is useful for accessing the field via an interface.

type CreateS3DataSourceResponse

type CreateS3DataSourceResponse struct {
	// Creates a new Amazon S3 Data Source pointed at the specified S3 bucket.
	//
	// Returns the newly created Data Source (or an error message if creating the Data Source fails).
	CreateS3DataSource *CreateS3DataSourceCreateS3DataSourceDataSourceResponse `json:"createS3DataSource"`
}

CreateS3DataSourceResponse is returned by CreateS3DataSource on success.

func (*CreateS3DataSourceResponse) GetCreateS3DataSource

GetCreateS3DataSource returns CreateS3DataSourceResponse.CreateS3DataSource, and is useful for accessing the field via an interface.

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceOrFailureResponse

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceOrFailureResponse interface {

	// GetTypename returns the receiver's concrete GraphQL type-name (see interface doc for possible values).
	GetTypename() *string
	// contains filtered or unexported methods
}

CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceOrFailureResponse includes the requested fields of the GraphQL interface DataSourceOrFailureResponse.

CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceOrFailureResponse is implemented by the following types: CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponse CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponse The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a DataSource.

If successful, an `DataSourceResponse` will be returned; otherwise, a `FailureResponse` will be returned.

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponse

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponse struct {
	Typename *string `json:"__typename"`
	// The Data Source which was created or modified.
	DataSource *CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource `json:"dataSource"`
}

CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponse includes the requested fields of the GraphQL type DataSourceResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Source.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponse) GetDataSource

GetDataSource returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponse.DataSource, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponse) GetTypename

GetTypename returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponse.Typename, and is useful for accessing the field via an interface.

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource struct {
	DataSourceData `json:"-"`
}

CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetAccount

GetAccount returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Account, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetChecks

GetChecks returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Checks, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetConnectionSettings

GetConnectionSettings returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetCreatedAt

GetCreatedAt returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetCreatedBy

GetCreatedBy returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetDataPools added in v1.0.1

GetDataPools returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.DataPools, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetDescription

GetDescription returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Description, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetEnvironment

GetEnvironment returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Environment, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetError

GetError returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Error, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetId

GetId returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Id, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetModifiedAt

GetModifiedAt returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetModifiedBy

GetModifiedBy returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetStatus

GetStatus returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Status, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetTableIntrospections

GetTableIntrospections returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetTables

GetTables returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Tables, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetType

GetType returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.Type, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) GetUniqueName

GetUniqueName returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) MarshalJSON

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceResponseDataSource) UnmarshalJSON

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponse

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponse struct {
	Typename *string `json:"__typename"`
	// The error that caused the failure.
	Error *CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError `json:"error"`
}

CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponse includes the requested fields of the GraphQL type FailureResponse. The GraphQL type's documentation follows.

The failure response object.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponse) GetError

GetError returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponse.Error, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponse) GetTypename

GetTypename returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponse.Typename, and is useful for accessing the field via an interface.

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError

type CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError struct {
	GqlError `json:"-"`
}

CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError) GetCode

GetCode returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError.Code, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError) GetMessage

GetMessage returns CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError.Message, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError) MarshalJSON

func (*CreateSnowflakeDataSourceCreateSnowflakeDataSourceFailureResponseError) UnmarshalJSON

type CreateSnowflakeDataSourceInput

type CreateSnowflakeDataSourceInput struct {
	// The Data Source's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
	// The Data Source's description.
	Description *string `json:"description"`
	// The Data Source's connection settings.
	ConnectionSettings *SnowflakeConnectionSettingsInput `json:"connectionSettings,omitempty"`
}

The fields for creating a Snowflake Data Source.

func (*CreateSnowflakeDataSourceInput) GetConnectionSettings

GetConnectionSettings returns CreateSnowflakeDataSourceInput.ConnectionSettings, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceInput) GetDescription

func (v *CreateSnowflakeDataSourceInput) GetDescription() *string

GetDescription returns CreateSnowflakeDataSourceInput.Description, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceInput) GetUniqueName

func (v *CreateSnowflakeDataSourceInput) GetUniqueName() *string

GetUniqueName returns CreateSnowflakeDataSourceInput.UniqueName, and is useful for accessing the field via an interface.

type CreateSnowflakeDataSourceResponse

type CreateSnowflakeDataSourceResponse struct {
	// Creates a new Data Source from the given Snowflake database using the specified Snowflake account, warehouse, schema, username, and role.
	//
	// Returns the newly created Data Source (or an error message if creating the Data Source fails).
	CreateSnowflakeDataSource *CreateSnowflakeDataSourceCreateSnowflakeDataSourceDataSourceOrFailureResponse `json:"-"`
}

CreateSnowflakeDataSourceResponse is returned by CreateSnowflakeDataSource on success.

func (*CreateSnowflakeDataSourceResponse) GetCreateSnowflakeDataSource

GetCreateSnowflakeDataSource returns CreateSnowflakeDataSourceResponse.CreateSnowflakeDataSource, and is useful for accessing the field via an interface.

func (*CreateSnowflakeDataSourceResponse) MarshalJSON

func (v *CreateSnowflakeDataSourceResponse) MarshalJSON() ([]byte, error)

func (*CreateSnowflakeDataSourceResponse) UnmarshalJSON

func (v *CreateSnowflakeDataSourceResponse) UnmarshalJSON(b []byte) error

type CreateSumMetricCreateSumMetricMetricResponse

type CreateSumMetricCreateSumMetricMetricResponse struct {
	Typename *string `json:"__typename"`
	// The Metric which was created or modified.
	Metric *CreateSumMetricCreateSumMetricMetricResponseMetric `json:"metric"`
}

CreateSumMetricCreateSumMetricMetricResponse includes the requested fields of the GraphQL type MetricResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Metric.

func (*CreateSumMetricCreateSumMetricMetricResponse) GetMetric

GetMetric returns CreateSumMetricCreateSumMetricMetricResponse.Metric, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponse) GetTypename

GetTypename returns CreateSumMetricCreateSumMetricMetricResponse.Typename, and is useful for accessing the field via an interface.

type CreateSumMetricCreateSumMetricMetricResponseMetric

type CreateSumMetricCreateSumMetricMetricResponseMetric struct {
	MetricData `json:"-"`
}

CreateSumMetricCreateSumMetricMetricResponseMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetAccessControlEnabled added in v0.1.4

func (v *CreateSumMetricCreateSumMetricMetricResponseMetric) GetAccessControlEnabled() bool

GetAccessControlEnabled returns CreateSumMetricCreateSumMetricMetricResponseMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetAccount

GetAccount returns CreateSumMetricCreateSumMetricMetricResponseMetric.Account, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetCreatedAt

GetCreatedAt returns CreateSumMetricCreateSumMetricMetricResponseMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetCreatedBy

GetCreatedBy returns CreateSumMetricCreateSumMetricMetricResponseMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetDataPool

GetDataPool returns CreateSumMetricCreateSumMetricMetricResponseMetric.DataPool, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetDescription

GetDescription returns CreateSumMetricCreateSumMetricMetricResponseMetric.Description, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetDimensions

GetDimensions returns CreateSumMetricCreateSumMetricMetricResponseMetric.Dimensions, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetEnvironment

GetEnvironment returns CreateSumMetricCreateSumMetricMetricResponseMetric.Environment, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetId

GetId returns CreateSumMetricCreateSumMetricMetricResponseMetric.Id, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetMeasure

GetMeasure returns CreateSumMetricCreateSumMetricMetricResponseMetric.Measure, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetModifiedAt

GetModifiedAt returns CreateSumMetricCreateSumMetricMetricResponseMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetModifiedBy

GetModifiedBy returns CreateSumMetricCreateSumMetricMetricResponseMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetSettings

GetSettings returns CreateSumMetricCreateSumMetricMetricResponseMetric.Settings, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetTimestamp

GetTimestamp returns CreateSumMetricCreateSumMetricMetricResponseMetric.Timestamp, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetType

GetType returns CreateSumMetricCreateSumMetricMetricResponseMetric.Type, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) GetUniqueName

GetUniqueName returns CreateSumMetricCreateSumMetricMetricResponseMetric.UniqueName, and is useful for accessing the field via an interface.

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) MarshalJSON

func (*CreateSumMetricCreateSumMetricMetricResponseMetric) UnmarshalJSON

type CreateSumMetricInput

type CreateSumMetricInput struct {
	// The Data Pool that powers this Metric.
	DataPool string `json:"dataPool"`
	// The Metric's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
	// The Metric's description.
	Description *string `json:"description"`
	// The Metric's Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	Filters []*FilterInput `json:"filters,omitempty"`
	// The Metric's Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
	FilterSql *string `json:"filterSql"`
	// The Metric's Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.
	Dimensions []*DimensionInput `json:"dimensions,omitempty"`
	// The column to be summed.
	Measure *DimensionInput `json:"measure,omitempty"`
}

The fields for creating a new Sum Metric.

func (*CreateSumMetricInput) GetDataPool

func (v *CreateSumMetricInput) GetDataPool() string

GetDataPool returns CreateSumMetricInput.DataPool, and is useful for accessing the field via an interface.

func (*CreateSumMetricInput) GetDescription

func (v *CreateSumMetricInput) GetDescription() *string

GetDescription returns CreateSumMetricInput.Description, and is useful for accessing the field via an interface.

func (*CreateSumMetricInput) GetDimensions

func (v *CreateSumMetricInput) GetDimensions() []*DimensionInput

GetDimensions returns CreateSumMetricInput.Dimensions, and is useful for accessing the field via an interface.

func (*CreateSumMetricInput) GetFilterSql added in v1.2.1

func (v *CreateSumMetricInput) GetFilterSql() *string

GetFilterSql returns CreateSumMetricInput.FilterSql, and is useful for accessing the field via an interface.

func (*CreateSumMetricInput) GetFilters

func (v *CreateSumMetricInput) GetFilters() []*FilterInput

GetFilters returns CreateSumMetricInput.Filters, and is useful for accessing the field via an interface.

func (*CreateSumMetricInput) GetMeasure

func (v *CreateSumMetricInput) GetMeasure() *DimensionInput

GetMeasure returns CreateSumMetricInput.Measure, and is useful for accessing the field via an interface.

func (*CreateSumMetricInput) GetUniqueName

func (v *CreateSumMetricInput) GetUniqueName() *string

GetUniqueName returns CreateSumMetricInput.UniqueName, and is useful for accessing the field via an interface.

type CreateSumMetricResponse

type CreateSumMetricResponse struct {
	// Creates a new Sum Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).
	//
	// [Learn more about Metrics](https://www.propeldata.com/docs/metrics).
	CreateSumMetric *CreateSumMetricCreateSumMetricMetricResponse `json:"createSumMetric"`
}

CreateSumMetricResponse is returned by CreateSumMetric on success.

func CreateSumMetric

func CreateSumMetric(
	ctx context.Context,
	client graphql.Client,
	input *CreateSumMetricInput,
) (*CreateSumMetricResponse, error)

func (*CreateSumMetricResponse) GetCreateSumMetric

GetCreateSumMetric returns CreateSumMetricResponse.CreateSumMetric, and is useful for accessing the field via an interface.

type CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponse added in v1.0.1

type CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponse struct {
	// The Data Source which was created or modified.
	DataSource *CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource `json:"dataSource"`
}

CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponse includes the requested fields of the GraphQL type DataSourceResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Source.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponse) GetDataSource added in v1.0.1

GetDataSource returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponse.DataSource, and is useful for accessing the field via an interface.

type CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource added in v1.0.1

type CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource struct {
	DataSourceData `json:"-"`
}

CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetAccount added in v1.0.1

GetAccount returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Account, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetChecks added in v1.0.1

GetChecks returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Checks, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetConnectionSettings added in v1.0.1

GetConnectionSettings returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetCreatedAt added in v1.0.1

GetCreatedAt returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetCreatedBy added in v1.0.1

GetCreatedBy returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetDataPools added in v1.0.1

GetDataPools returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.DataPools, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetDescription added in v1.0.1

GetDescription returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Description, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetEnvironment added in v1.0.1

GetEnvironment returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Environment, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetError added in v1.0.1

GetError returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Error, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetId added in v1.0.1

GetId returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Id, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetModifiedAt added in v1.0.1

GetModifiedAt returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetModifiedBy added in v1.0.1

GetModifiedBy returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetStatus added in v1.0.1

GetStatus returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Status, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetTableIntrospections added in v1.0.1

GetTableIntrospections returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetTables added in v1.0.1

GetTables returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Tables, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetType added in v1.0.1

GetType returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.Type, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) GetUniqueName added in v1.0.1

GetUniqueName returns CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) MarshalJSON added in v1.0.1

func (*CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponseDataSource) UnmarshalJSON added in v1.0.1

type CreateWebhookDataSourceInput added in v1.0.1

type CreateWebhookDataSourceInput struct {
	// The Webhook Data Source's connection settings
	ConnectionSettings *WebhookConnectionSettingsInput `json:"connectionSettings,omitempty"`
	// The Webhook Data Source's description.
	Description *string `json:"description"`
	// The Webhook Data Source's unique name. If not specified, Propel will set the ID as unique name.
	UniqueName *string `json:"uniqueName"`
}

func (*CreateWebhookDataSourceInput) GetConnectionSettings added in v1.0.1

GetConnectionSettings returns CreateWebhookDataSourceInput.ConnectionSettings, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceInput) GetDescription added in v1.0.1

func (v *CreateWebhookDataSourceInput) GetDescription() *string

GetDescription returns CreateWebhookDataSourceInput.Description, and is useful for accessing the field via an interface.

func (*CreateWebhookDataSourceInput) GetUniqueName added in v1.0.1

func (v *CreateWebhookDataSourceInput) GetUniqueName() *string

GetUniqueName returns CreateWebhookDataSourceInput.UniqueName, and is useful for accessing the field via an interface.

type CreateWebhookDataSourceResponse added in v1.0.1

type CreateWebhookDataSourceResponse struct {
	// Creates a new Webhook Data Source from the given settings.
	//
	// Returns the newly created Data Source (or an error message if creating the Data Source fails).
	CreateWebhookDataSource *CreateWebhookDataSourceCreateWebhookDataSourceDataSourceResponse `json:"createWebhookDataSource"`
}

CreateWebhookDataSourceResponse is returned by CreateWebhookDataSource on success.

func CreateWebhookDataSource added in v1.0.1

func CreateWebhookDataSource(
	ctx context.Context,
	client graphql.Client,
	input *CreateWebhookDataSourceInput,
) (*CreateWebhookDataSourceResponse, error)

func (*CreateWebhookDataSourceResponse) GetCreateWebhookDataSource added in v1.0.1

GetCreateWebhookDataSource returns CreateWebhookDataSourceResponse.CreateWebhookDataSource, and is useful for accessing the field via an interface.

type DataPoolAccessPolicyData added in v1.1.0

type DataPoolAccessPolicyData struct {
	// The ID of the Data Pool Access Policy.
	Id                             string `json:"id"`
	CommonDataDataPoolAccessPolicy `json:"-"`
	// Columns that the Access Policy makes available for querying.
	Columns []string `json:"columns"`
	// Row-level filters that the Access Policy applies before executing queries.
	Rows []*DataPoolAccessPolicyDataRowsFilter `json:"rows"`
	// The Data Pool to which the Access Policy belongs.
	DataPool *DataPoolAccessPolicyDataDataPool `json:"dataPool"`
}

DataPoolAccessPolicyData includes the GraphQL fields of DataPoolAccessPolicy requested by the fragment DataPoolAccessPolicyData.

func (*DataPoolAccessPolicyData) GetAccount added in v1.1.0

GetAccount returns DataPoolAccessPolicyData.Account, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetColumns added in v1.1.0

func (v *DataPoolAccessPolicyData) GetColumns() []string

GetColumns returns DataPoolAccessPolicyData.Columns, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetCreatedAt added in v1.1.0

func (v *DataPoolAccessPolicyData) GetCreatedAt() time.Time

GetCreatedAt returns DataPoolAccessPolicyData.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetCreatedBy added in v1.1.0

func (v *DataPoolAccessPolicyData) GetCreatedBy() string

GetCreatedBy returns DataPoolAccessPolicyData.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetDataPool added in v1.1.0

GetDataPool returns DataPoolAccessPolicyData.DataPool, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetDescription added in v1.1.0

func (v *DataPoolAccessPolicyData) GetDescription() string

GetDescription returns DataPoolAccessPolicyData.Description, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetEnvironment added in v1.1.0

func (v *DataPoolAccessPolicyData) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns DataPoolAccessPolicyData.Environment, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetId added in v1.1.0

func (v *DataPoolAccessPolicyData) GetId() string

GetId returns DataPoolAccessPolicyData.Id, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetModifiedAt added in v1.1.0

func (v *DataPoolAccessPolicyData) GetModifiedAt() time.Time

GetModifiedAt returns DataPoolAccessPolicyData.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetModifiedBy added in v1.1.0

func (v *DataPoolAccessPolicyData) GetModifiedBy() string

GetModifiedBy returns DataPoolAccessPolicyData.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetRows added in v1.1.0

GetRows returns DataPoolAccessPolicyData.Rows, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) GetUniqueName added in v1.1.0

func (v *DataPoolAccessPolicyData) GetUniqueName() string

GetUniqueName returns DataPoolAccessPolicyData.UniqueName, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyData) MarshalJSON added in v1.1.0

func (v *DataPoolAccessPolicyData) MarshalJSON() ([]byte, error)

func (*DataPoolAccessPolicyData) UnmarshalJSON added in v1.1.0

func (v *DataPoolAccessPolicyData) UnmarshalJSON(b []byte) error

type DataPoolAccessPolicyDataDataPool added in v1.1.0

type DataPoolAccessPolicyDataDataPool struct {
	// The Data Pool's unique identifier.
	Id string `json:"id"`
}

DataPoolAccessPolicyDataDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*DataPoolAccessPolicyDataDataPool) GetId added in v1.1.0

GetId returns DataPoolAccessPolicyDataDataPool.Id, and is useful for accessing the field via an interface.

type DataPoolAccessPolicyDataPoolAccessPolicy added in v1.1.0

type DataPoolAccessPolicyDataPoolAccessPolicy struct {
	DataPoolAccessPolicyData `json:"-"`
	// Applications that are assigned to this Data Pool Access Policy.
	Applications *DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnection `json:"applications"`
}

DataPoolAccessPolicyDataPoolAccessPolicy includes the requested fields of the GraphQL type DataPoolAccessPolicy.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetAccount added in v1.1.0

GetAccount returns DataPoolAccessPolicyDataPoolAccessPolicy.Account, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetApplications added in v1.1.0

GetApplications returns DataPoolAccessPolicyDataPoolAccessPolicy.Applications, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetColumns added in v1.1.0

GetColumns returns DataPoolAccessPolicyDataPoolAccessPolicy.Columns, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetCreatedAt added in v1.1.0

GetCreatedAt returns DataPoolAccessPolicyDataPoolAccessPolicy.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetCreatedBy added in v1.1.0

GetCreatedBy returns DataPoolAccessPolicyDataPoolAccessPolicy.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetDataPool added in v1.1.0

GetDataPool returns DataPoolAccessPolicyDataPoolAccessPolicy.DataPool, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetDescription added in v1.1.0

GetDescription returns DataPoolAccessPolicyDataPoolAccessPolicy.Description, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetEnvironment added in v1.1.0

GetEnvironment returns DataPoolAccessPolicyDataPoolAccessPolicy.Environment, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetId added in v1.1.0

GetId returns DataPoolAccessPolicyDataPoolAccessPolicy.Id, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetModifiedAt added in v1.1.0

GetModifiedAt returns DataPoolAccessPolicyDataPoolAccessPolicy.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetModifiedBy added in v1.1.0

GetModifiedBy returns DataPoolAccessPolicyDataPoolAccessPolicy.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetRows added in v1.1.0

GetRows returns DataPoolAccessPolicyDataPoolAccessPolicy.Rows, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) GetUniqueName added in v1.1.0

GetUniqueName returns DataPoolAccessPolicyDataPoolAccessPolicy.UniqueName, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataPoolAccessPolicy) MarshalJSON added in v1.1.0

func (v *DataPoolAccessPolicyDataPoolAccessPolicy) MarshalJSON() ([]byte, error)

func (*DataPoolAccessPolicyDataPoolAccessPolicy) UnmarshalJSON added in v1.1.0

func (v *DataPoolAccessPolicyDataPoolAccessPolicy) UnmarshalJSON(b []byte) error

type DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnection added in v1.1.0

type DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnection struct {
	// The Application connection's nodes.
	Nodes []*DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnectionNodesApplication `json:"nodes"`
}

DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnection includes the requested fields of the GraphQL type ApplicationConnection. The GraphQL type's documentation follows.

The Application connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnection) GetNodes added in v1.1.0

GetNodes returns DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnection.Nodes, and is useful for accessing the field via an interface.

type DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnectionNodesApplication added in v1.1.0

type DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnectionNodesApplication struct {
	// The Application's unique identifier.
	Id string `json:"id"`
}

DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnectionNodesApplication includes the requested fields of the GraphQL type Application. The GraphQL type's documentation follows.

The Application object.

Propel Applications represent the web or mobile app you are building. They provide the API credentials that allow your client- or server-side app to access the Propel API. The Application's Propeller determines the speed and cost of your Metric Queries.

[Learn more about Applications](https://www.propeldata.com/docs/applications).

func (*DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnectionNodesApplication) GetId added in v1.1.0

GetId returns DataPoolAccessPolicyDataPoolAccessPolicyApplicationsApplicationConnectionNodesApplication.Id, and is useful for accessing the field via an interface.

type DataPoolAccessPolicyDataRowsFilter added in v1.1.0

type DataPoolAccessPolicyDataRowsFilter struct {
	FilterData `json:"-"`
}

DataPoolAccessPolicyDataRowsFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*DataPoolAccessPolicyDataRowsFilter) GetAnd added in v1.1.0

GetAnd returns DataPoolAccessPolicyDataRowsFilter.And, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataRowsFilter) GetColumn added in v1.1.0

GetColumn returns DataPoolAccessPolicyDataRowsFilter.Column, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataRowsFilter) GetOperator added in v1.1.0

GetOperator returns DataPoolAccessPolicyDataRowsFilter.Operator, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataRowsFilter) GetOr added in v1.1.0

GetOr returns DataPoolAccessPolicyDataRowsFilter.Or, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataRowsFilter) GetValue added in v1.1.0

GetValue returns DataPoolAccessPolicyDataRowsFilter.Value, and is useful for accessing the field via an interface.

func (*DataPoolAccessPolicyDataRowsFilter) MarshalJSON added in v1.1.0

func (v *DataPoolAccessPolicyDataRowsFilter) MarshalJSON() ([]byte, error)

func (*DataPoolAccessPolicyDataRowsFilter) UnmarshalJSON added in v1.1.0

func (v *DataPoolAccessPolicyDataRowsFilter) UnmarshalJSON(b []byte) error

type DataPoolAccessPolicyResponse added in v1.1.0

type DataPoolAccessPolicyResponse struct {
	// This query returns the Data Pool Access Policy specified by the given ID.
	//
	// A Data Pool Access Policy limits the data that Applications can access within a Data Pool.
	DataPoolAccessPolicy *DataPoolAccessPolicyDataPoolAccessPolicy `json:"dataPoolAccessPolicy"`
}

DataPoolAccessPolicyResponse is returned by DataPoolAccessPolicy on success.

func DataPoolAccessPolicy added in v1.1.0

func DataPoolAccessPolicy(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DataPoolAccessPolicyResponse, error)

func (*DataPoolAccessPolicyResponse) GetDataPoolAccessPolicy added in v1.1.0

GetDataPoolAccessPolicy returns DataPoolAccessPolicyResponse.DataPoolAccessPolicy, and is useful for accessing the field via an interface.

type DataPoolByNameDataPool

type DataPoolByNameDataPool struct {
	DataPoolData `json:"-"`
}

DataPoolByNameDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*DataPoolByNameDataPool) GetAccessControlEnabled added in v1.1.0

func (v *DataPoolByNameDataPool) GetAccessControlEnabled() bool

GetAccessControlEnabled returns DataPoolByNameDataPool.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetAccount

func (v *DataPoolByNameDataPool) GetAccount() *CommonDataAccount

GetAccount returns DataPoolByNameDataPool.Account, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetAvailableMeasures

GetAvailableMeasures returns DataPoolByNameDataPool.AvailableMeasures, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetColumns

GetColumns returns DataPoolByNameDataPool.Columns, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetCreatedAt

func (v *DataPoolByNameDataPool) GetCreatedAt() time.Time

GetCreatedAt returns DataPoolByNameDataPool.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetCreatedBy

func (v *DataPoolByNameDataPool) GetCreatedBy() string

GetCreatedBy returns DataPoolByNameDataPool.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetDataPoolAccessPolicies added in v1.1.0

GetDataPoolAccessPolicies returns DataPoolByNameDataPool.DataPoolAccessPolicies, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetDataSource

func (v *DataPoolByNameDataPool) GetDataSource() *DataPoolDataDataSource

GetDataSource returns DataPoolByNameDataPool.DataSource, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetDescription

func (v *DataPoolByNameDataPool) GetDescription() string

GetDescription returns DataPoolByNameDataPool.Description, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetEnvironment

func (v *DataPoolByNameDataPool) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns DataPoolByNameDataPool.Environment, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetError

GetError returns DataPoolByNameDataPool.Error, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetId

func (v *DataPoolByNameDataPool) GetId() string

GetId returns DataPoolByNameDataPool.Id, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetModifiedAt

func (v *DataPoolByNameDataPool) GetModifiedAt() time.Time

GetModifiedAt returns DataPoolByNameDataPool.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetModifiedBy

func (v *DataPoolByNameDataPool) GetModifiedBy() string

GetModifiedBy returns DataPoolByNameDataPool.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetSetupTasks

GetSetupTasks returns DataPoolByNameDataPool.SetupTasks, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetStatus

func (v *DataPoolByNameDataPool) GetStatus() DataPoolStatus

GetStatus returns DataPoolByNameDataPool.Status, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetSyncing added in v0.1.3

GetSyncing returns DataPoolByNameDataPool.Syncing, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetSyncs

GetSyncs returns DataPoolByNameDataPool.Syncs, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetTable

func (v *DataPoolByNameDataPool) GetTable() string

GetTable returns DataPoolByNameDataPool.Table, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetTenant added in v1.2.1

GetTenant returns DataPoolByNameDataPool.Tenant, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetTimestamp

func (v *DataPoolByNameDataPool) GetTimestamp() *DataPoolDataTimestamp

GetTimestamp returns DataPoolByNameDataPool.Timestamp, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetUniqueId added in v1.0.0

func (v *DataPoolByNameDataPool) GetUniqueId() *DataPoolDataUniqueId

GetUniqueId returns DataPoolByNameDataPool.UniqueId, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) GetUniqueName

func (v *DataPoolByNameDataPool) GetUniqueName() string

GetUniqueName returns DataPoolByNameDataPool.UniqueName, and is useful for accessing the field via an interface.

func (*DataPoolByNameDataPool) MarshalJSON

func (v *DataPoolByNameDataPool) MarshalJSON() ([]byte, error)

func (*DataPoolByNameDataPool) UnmarshalJSON

func (v *DataPoolByNameDataPool) UnmarshalJSON(b []byte) error

type DataPoolByNameResponse

type DataPoolByNameResponse struct {
	// This query returns the Data Pool specified by the given unique name.
	//
	// A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries.
	DataPool *DataPoolByNameDataPool `json:"dataPool"`
}

DataPoolByNameResponse is returned by DataPoolByName on success.

func DataPoolByName

func DataPoolByName(
	ctx context.Context,
	client graphql.Client,
	uniqueName string,
) (*DataPoolByNameResponse, error)

func (*DataPoolByNameResponse) GetDataPool

GetDataPool returns DataPoolByNameResponse.DataPool, and is useful for accessing the field via an interface.

type DataPoolColumnData

type DataPoolColumnData struct {
	// The name of the Data Source column that this Data Pool column derives from.
	ColumnName string `json:"columnName"`
	// The Data Pool column's type. This may differ from the corresponding Data Source column's type.
	Type ColumnType `json:"type"`
	// Whether the column is nullable, meaning whether it accepts a null value.
	IsNullable bool `json:"isNullable"`
}

DataPoolColumnData includes the GraphQL fields of DataPoolColumn requested by the fragment DataPoolColumnData.

func (*DataPoolColumnData) GetColumnName

func (v *DataPoolColumnData) GetColumnName() string

GetColumnName returns DataPoolColumnData.ColumnName, and is useful for accessing the field via an interface.

func (*DataPoolColumnData) GetIsNullable

func (v *DataPoolColumnData) GetIsNullable() bool

GetIsNullable returns DataPoolColumnData.IsNullable, and is useful for accessing the field via an interface.

func (*DataPoolColumnData) GetType

func (v *DataPoolColumnData) GetType() ColumnType

GetType returns DataPoolColumnData.Type, and is useful for accessing the field via an interface.

type DataPoolColumnInput

type DataPoolColumnInput struct {
	// The name of the Data Source column that this Data Pool column derives from.
	ColumnName string `json:"columnName"`
	// The Data Pool column's type. This may differ from the corresponding Data Source column's type.
	Type ColumnType `json:"type"`
	// The ClickHouse type to use when `type` is set to `CLICKHOUSE`.
	ClickHouseType *string `json:"clickHouseType"`
	// Whether the column is nullable, meaning whether it accepts a null value.
	IsNullable bool `json:"isNullable"`
}

func (*DataPoolColumnInput) GetClickHouseType added in v1.2.1

func (v *DataPoolColumnInput) GetClickHouseType() *string

GetClickHouseType returns DataPoolColumnInput.ClickHouseType, and is useful for accessing the field via an interface.

func (*DataPoolColumnInput) GetColumnName

func (v *DataPoolColumnInput) GetColumnName() string

GetColumnName returns DataPoolColumnInput.ColumnName, and is useful for accessing the field via an interface.

func (*DataPoolColumnInput) GetIsNullable

func (v *DataPoolColumnInput) GetIsNullable() bool

GetIsNullable returns DataPoolColumnInput.IsNullable, and is useful for accessing the field via an interface.

func (*DataPoolColumnInput) GetType

func (v *DataPoolColumnInput) GetType() ColumnType

GetType returns DataPoolColumnInput.Type, and is useful for accessing the field via an interface.

type DataPoolData

type DataPoolData struct {
	// The Data Pool's unique identifier.
	Id                 string `json:"id"`
	CommonDataDataPool `json:"-"`
	// The Data Pool's Data Source.
	DataSource *DataPoolDataDataSource `json:"dataSource"`
	// The Data Pool's status.
	Status DataPoolStatus     `json:"status"`
	Error  *DataPoolDataError `json:"error"`
	// The name of the Data Pool's table.
	Table string `json:"table"`
	// The Data Pool's tenant ID, if configured.
	Tenant *DataPoolDataTenant `json:"tenant"`
	// The Data Pool's primary timestamp column, if any.
	Timestamp *DataPoolDataTimestamp `json:"timestamp"`
	// The Data Pool's columns.
	Columns *DataPoolDataColumnsDataPoolColumnConnection `json:"columns"`
	// The Data Pool's unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.
	UniqueId *DataPoolDataUniqueId `json:"uniqueId"`
	// Settings related to Data Pool syncing.
	Syncing *DataPoolDataSyncingDataPoolSyncing `json:"syncing"`
	// The list of measures (numeric columns) in the Data Pool.
	AvailableMeasures *DataPoolDataAvailableMeasuresDataPoolColumnConnection `json:"availableMeasures"`
	// A list of setup tasks performed on the Data Pool during its most recent setup attempt.
	SetupTasks []*DataPoolDataSetupTasksDataPoolSetupTask `json:"setupTasks"`
	// The list of Syncs of the Data Pool.
	Syncs *DataPoolDataSyncsSyncConnection `json:"syncs"`
	// A paginated list of Data Pool Access Policies available on the Data Pool.
	DataPoolAccessPolicies *DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnection `json:"dataPoolAccessPolicies"`
	// Whether the Data Pool has access control enabled or not.
	//
	// If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
	// Policies in order to query the Data Pool and its Metrics.
	AccessControlEnabled bool `json:"accessControlEnabled"`
}

DataPoolData includes the GraphQL fields of DataPool requested by the fragment DataPoolData. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*DataPoolData) GetAccessControlEnabled added in v1.1.0

func (v *DataPoolData) GetAccessControlEnabled() bool

GetAccessControlEnabled returns DataPoolData.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*DataPoolData) GetAccount

func (v *DataPoolData) GetAccount() *CommonDataAccount

GetAccount returns DataPoolData.Account, and is useful for accessing the field via an interface.

func (*DataPoolData) GetAvailableMeasures

GetAvailableMeasures returns DataPoolData.AvailableMeasures, and is useful for accessing the field via an interface.

func (*DataPoolData) GetColumns

GetColumns returns DataPoolData.Columns, and is useful for accessing the field via an interface.

func (*DataPoolData) GetCreatedAt

func (v *DataPoolData) GetCreatedAt() time.Time

GetCreatedAt returns DataPoolData.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolData) GetCreatedBy

func (v *DataPoolData) GetCreatedBy() string

GetCreatedBy returns DataPoolData.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolData) GetDataPoolAccessPolicies added in v1.1.0

GetDataPoolAccessPolicies returns DataPoolData.DataPoolAccessPolicies, and is useful for accessing the field via an interface.

func (*DataPoolData) GetDataSource

func (v *DataPoolData) GetDataSource() *DataPoolDataDataSource

GetDataSource returns DataPoolData.DataSource, and is useful for accessing the field via an interface.

func (*DataPoolData) GetDescription

func (v *DataPoolData) GetDescription() string

GetDescription returns DataPoolData.Description, and is useful for accessing the field via an interface.

func (*DataPoolData) GetEnvironment

func (v *DataPoolData) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns DataPoolData.Environment, and is useful for accessing the field via an interface.

func (*DataPoolData) GetError

func (v *DataPoolData) GetError() *DataPoolDataError

GetError returns DataPoolData.Error, and is useful for accessing the field via an interface.

func (*DataPoolData) GetId

func (v *DataPoolData) GetId() string

GetId returns DataPoolData.Id, and is useful for accessing the field via an interface.

func (*DataPoolData) GetModifiedAt

func (v *DataPoolData) GetModifiedAt() time.Time

GetModifiedAt returns DataPoolData.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolData) GetModifiedBy

func (v *DataPoolData) GetModifiedBy() string

GetModifiedBy returns DataPoolData.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolData) GetSetupTasks

GetSetupTasks returns DataPoolData.SetupTasks, and is useful for accessing the field via an interface.

func (*DataPoolData) GetStatus

func (v *DataPoolData) GetStatus() DataPoolStatus

GetStatus returns DataPoolData.Status, and is useful for accessing the field via an interface.

func (*DataPoolData) GetSyncing added in v0.1.3

GetSyncing returns DataPoolData.Syncing, and is useful for accessing the field via an interface.

func (*DataPoolData) GetSyncs

GetSyncs returns DataPoolData.Syncs, and is useful for accessing the field via an interface.

func (*DataPoolData) GetTable

func (v *DataPoolData) GetTable() string

GetTable returns DataPoolData.Table, and is useful for accessing the field via an interface.

func (*DataPoolData) GetTenant added in v1.2.1

func (v *DataPoolData) GetTenant() *DataPoolDataTenant

GetTenant returns DataPoolData.Tenant, and is useful for accessing the field via an interface.

func (*DataPoolData) GetTimestamp

func (v *DataPoolData) GetTimestamp() *DataPoolDataTimestamp

GetTimestamp returns DataPoolData.Timestamp, and is useful for accessing the field via an interface.

func (*DataPoolData) GetUniqueId added in v1.0.0

func (v *DataPoolData) GetUniqueId() *DataPoolDataUniqueId

GetUniqueId returns DataPoolData.UniqueId, and is useful for accessing the field via an interface.

func (*DataPoolData) GetUniqueName

func (v *DataPoolData) GetUniqueName() string

GetUniqueName returns DataPoolData.UniqueName, and is useful for accessing the field via an interface.

func (*DataPoolData) MarshalJSON

func (v *DataPoolData) MarshalJSON() ([]byte, error)

func (*DataPoolData) UnmarshalJSON

func (v *DataPoolData) UnmarshalJSON(b []byte) error

type DataPoolDataAvailableMeasuresDataPoolColumnConnection

type DataPoolDataAvailableMeasuresDataPoolColumnConnection struct {
	// The Data Pool column connection's nodes.
	Nodes []*DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn `json:"nodes"`
}

DataPoolDataAvailableMeasuresDataPoolColumnConnection includes the requested fields of the GraphQL type DataPoolColumnConnection. The GraphQL type's documentation follows.

The Data Pool column connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataPoolDataAvailableMeasuresDataPoolColumnConnection) GetNodes

GetNodes returns DataPoolDataAvailableMeasuresDataPoolColumnConnection.Nodes, and is useful for accessing the field via an interface.

type DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn

type DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn struct {
	DataPoolColumnData `json:"-"`
}

DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn includes the requested fields of the GraphQL type DataPoolColumn.

func (*DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn) GetColumnName

GetColumnName returns DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn.ColumnName, and is useful for accessing the field via an interface.

func (*DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn) GetIsNullable

GetIsNullable returns DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn.IsNullable, and is useful for accessing the field via an interface.

func (*DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn) GetType

GetType returns DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn.Type, and is useful for accessing the field via an interface.

func (*DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn) MarshalJSON

func (*DataPoolDataAvailableMeasuresDataPoolColumnConnectionNodesDataPoolColumn) UnmarshalJSON

type DataPoolDataColumnsDataPoolColumnConnection

type DataPoolDataColumnsDataPoolColumnConnection struct {
	// The Data Pool column connection's nodes.
	Nodes []*DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn `json:"nodes"`
}

DataPoolDataColumnsDataPoolColumnConnection includes the requested fields of the GraphQL type DataPoolColumnConnection. The GraphQL type's documentation follows.

The Data Pool column connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataPoolDataColumnsDataPoolColumnConnection) GetNodes

GetNodes returns DataPoolDataColumnsDataPoolColumnConnection.Nodes, and is useful for accessing the field via an interface.

type DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn

type DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn struct {
	DataPoolColumnData `json:"-"`
}

DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn includes the requested fields of the GraphQL type DataPoolColumn.

func (*DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn) GetColumnName

GetColumnName returns DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn.ColumnName, and is useful for accessing the field via an interface.

func (*DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn) GetIsNullable

GetIsNullable returns DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn.IsNullable, and is useful for accessing the field via an interface.

func (*DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn) GetType

GetType returns DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn.Type, and is useful for accessing the field via an interface.

func (*DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn) MarshalJSON

func (*DataPoolDataColumnsDataPoolColumnConnectionNodesDataPoolColumn) UnmarshalJSON

type DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnection added in v1.1.0

type DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnection struct {
	// The Data Pool Access Policy connection's nodes.
	Nodes []*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy `json:"nodes"`
}

DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnection includes the requested fields of the GraphQL type DataPoolAccessPolicyConnection. The GraphQL type's documentation follows.

The Data Pool Access Policy connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnection) GetNodes added in v1.1.0

GetNodes returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnection.Nodes, and is useful for accessing the field via an interface.

type DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy added in v1.1.0

type DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy struct {
	DataPoolAccessPolicyData `json:"-"`
}

DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy includes the requested fields of the GraphQL type DataPoolAccessPolicy.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetAccount added in v1.1.0

GetAccount returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.Account, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetColumns added in v1.1.0

GetColumns returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.Columns, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetCreatedAt added in v1.1.0

GetCreatedAt returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetCreatedBy added in v1.1.0

GetCreatedBy returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetDataPool added in v1.1.0

GetDataPool returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.DataPool, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetDescription added in v1.1.0

GetDescription returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.Description, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetEnvironment added in v1.1.0

GetEnvironment returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.Environment, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetId added in v1.1.0

GetId returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.Id, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetModifiedAt added in v1.1.0

GetModifiedAt returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetModifiedBy added in v1.1.0

GetModifiedBy returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetRows added in v1.1.0

GetRows returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.Rows, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) GetUniqueName added in v1.1.0

GetUniqueName returns DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy.UniqueName, and is useful for accessing the field via an interface.

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) MarshalJSON added in v1.1.0

func (*DataPoolDataDataPoolAccessPoliciesDataPoolAccessPolicyConnectionNodesDataPoolAccessPolicy) UnmarshalJSON added in v1.1.0

type DataPoolDataDataSource

type DataPoolDataDataSource struct {
	DataSourceData `json:"-"`
}

DataPoolDataDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*DataPoolDataDataSource) GetAccount

func (v *DataPoolDataDataSource) GetAccount() *CommonDataAccount

GetAccount returns DataPoolDataDataSource.Account, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetChecks

GetChecks returns DataPoolDataDataSource.Checks, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetConnectionSettings

func (v *DataPoolDataDataSource) GetConnectionSettings() DataSourceDataConnectionSettings

GetConnectionSettings returns DataPoolDataDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetCreatedAt

func (v *DataPoolDataDataSource) GetCreatedAt() time.Time

GetCreatedAt returns DataPoolDataDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetCreatedBy

func (v *DataPoolDataDataSource) GetCreatedBy() string

GetCreatedBy returns DataPoolDataDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetDataPools added in v1.0.1

GetDataPools returns DataPoolDataDataSource.DataPools, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetDescription

func (v *DataPoolDataDataSource) GetDescription() string

GetDescription returns DataPoolDataDataSource.Description, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetEnvironment

func (v *DataPoolDataDataSource) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns DataPoolDataDataSource.Environment, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetError

GetError returns DataPoolDataDataSource.Error, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetId

func (v *DataPoolDataDataSource) GetId() string

GetId returns DataPoolDataDataSource.Id, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetModifiedAt

func (v *DataPoolDataDataSource) GetModifiedAt() time.Time

GetModifiedAt returns DataPoolDataDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetModifiedBy

func (v *DataPoolDataDataSource) GetModifiedBy() string

GetModifiedBy returns DataPoolDataDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetStatus

GetStatus returns DataPoolDataDataSource.Status, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetTableIntrospections

GetTableIntrospections returns DataPoolDataDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetTables

GetTables returns DataPoolDataDataSource.Tables, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetType

GetType returns DataPoolDataDataSource.Type, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) GetUniqueName

func (v *DataPoolDataDataSource) GetUniqueName() string

GetUniqueName returns DataPoolDataDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*DataPoolDataDataSource) MarshalJSON

func (v *DataPoolDataDataSource) MarshalJSON() ([]byte, error)

func (*DataPoolDataDataSource) UnmarshalJSON

func (v *DataPoolDataDataSource) UnmarshalJSON(b []byte) error

type DataPoolDataError

type DataPoolDataError struct {
	// The error message.
	Message string `json:"message"`
}

DataPoolDataError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*DataPoolDataError) GetMessage

func (v *DataPoolDataError) GetMessage() string

GetMessage returns DataPoolDataError.Message, and is useful for accessing the field via an interface.

type DataPoolDataPool

type DataPoolDataPool struct {
	DataPoolData `json:"-"`
}

DataPoolDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*DataPoolDataPool) GetAccessControlEnabled added in v1.1.0

func (v *DataPoolDataPool) GetAccessControlEnabled() bool

GetAccessControlEnabled returns DataPoolDataPool.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetAccount

func (v *DataPoolDataPool) GetAccount() *CommonDataAccount

GetAccount returns DataPoolDataPool.Account, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetAvailableMeasures

GetAvailableMeasures returns DataPoolDataPool.AvailableMeasures, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetColumns

GetColumns returns DataPoolDataPool.Columns, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetCreatedAt

func (v *DataPoolDataPool) GetCreatedAt() time.Time

GetCreatedAt returns DataPoolDataPool.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetCreatedBy

func (v *DataPoolDataPool) GetCreatedBy() string

GetCreatedBy returns DataPoolDataPool.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetDataPoolAccessPolicies added in v1.1.0

GetDataPoolAccessPolicies returns DataPoolDataPool.DataPoolAccessPolicies, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetDataSource

func (v *DataPoolDataPool) GetDataSource() *DataPoolDataDataSource

GetDataSource returns DataPoolDataPool.DataSource, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetDescription

func (v *DataPoolDataPool) GetDescription() string

GetDescription returns DataPoolDataPool.Description, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetEnvironment

func (v *DataPoolDataPool) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns DataPoolDataPool.Environment, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetError

func (v *DataPoolDataPool) GetError() *DataPoolDataError

GetError returns DataPoolDataPool.Error, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetId

func (v *DataPoolDataPool) GetId() string

GetId returns DataPoolDataPool.Id, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetModifiedAt

func (v *DataPoolDataPool) GetModifiedAt() time.Time

GetModifiedAt returns DataPoolDataPool.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetModifiedBy

func (v *DataPoolDataPool) GetModifiedBy() string

GetModifiedBy returns DataPoolDataPool.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetSetupTasks

GetSetupTasks returns DataPoolDataPool.SetupTasks, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetStatus

func (v *DataPoolDataPool) GetStatus() DataPoolStatus

GetStatus returns DataPoolDataPool.Status, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetSyncing added in v0.1.3

GetSyncing returns DataPoolDataPool.Syncing, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetSyncs

GetSyncs returns DataPoolDataPool.Syncs, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetTable

func (v *DataPoolDataPool) GetTable() string

GetTable returns DataPoolDataPool.Table, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetTenant added in v1.2.1

func (v *DataPoolDataPool) GetTenant() *DataPoolDataTenant

GetTenant returns DataPoolDataPool.Tenant, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetTimestamp

func (v *DataPoolDataPool) GetTimestamp() *DataPoolDataTimestamp

GetTimestamp returns DataPoolDataPool.Timestamp, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetUniqueId added in v1.0.0

func (v *DataPoolDataPool) GetUniqueId() *DataPoolDataUniqueId

GetUniqueId returns DataPoolDataPool.UniqueId, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) GetUniqueName

func (v *DataPoolDataPool) GetUniqueName() string

GetUniqueName returns DataPoolDataPool.UniqueName, and is useful for accessing the field via an interface.

func (*DataPoolDataPool) MarshalJSON

func (v *DataPoolDataPool) MarshalJSON() ([]byte, error)

func (*DataPoolDataPool) UnmarshalJSON

func (v *DataPoolDataPool) UnmarshalJSON(b []byte) error

type DataPoolDataSetupTasksDataPoolSetupTask

type DataPoolDataSetupTasksDataPoolSetupTask struct {
	// The name of the Data Pool Setup Task to be performed.
	Name string `json:"name"`
	// A description of the Data Pool Setup Task to be performed.
	Description *string `json:"description"`
	// The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).
	Status DataPoolSetupTaskStatus `json:"status"`
	// If the Data Pool Setup Task failed, this field includes a descriptive error message.
	Error *DataPoolDataSetupTasksDataPoolSetupTaskError `json:"error"`
	// The time at which the Data Pool Setup Task was completed.
	CompletedAt *time.Time `json:"completedAt"`
}

DataPoolDataSetupTasksDataPoolSetupTask includes the requested fields of the GraphQL type DataPoolSetupTask. The GraphQL type's documentation follows.

The Data Pool Setup Task object.

Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.

The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.

func (*DataPoolDataSetupTasksDataPoolSetupTask) GetCompletedAt

func (v *DataPoolDataSetupTasksDataPoolSetupTask) GetCompletedAt() *time.Time

GetCompletedAt returns DataPoolDataSetupTasksDataPoolSetupTask.CompletedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataSetupTasksDataPoolSetupTask) GetDescription

func (v *DataPoolDataSetupTasksDataPoolSetupTask) GetDescription() *string

GetDescription returns DataPoolDataSetupTasksDataPoolSetupTask.Description, and is useful for accessing the field via an interface.

func (*DataPoolDataSetupTasksDataPoolSetupTask) GetError

GetError returns DataPoolDataSetupTasksDataPoolSetupTask.Error, and is useful for accessing the field via an interface.

func (*DataPoolDataSetupTasksDataPoolSetupTask) GetName

GetName returns DataPoolDataSetupTasksDataPoolSetupTask.Name, and is useful for accessing the field via an interface.

func (*DataPoolDataSetupTasksDataPoolSetupTask) GetStatus

GetStatus returns DataPoolDataSetupTasksDataPoolSetupTask.Status, and is useful for accessing the field via an interface.

type DataPoolDataSetupTasksDataPoolSetupTaskError

type DataPoolDataSetupTasksDataPoolSetupTaskError struct {
	// The error code.
	Code *int `json:"code"`
	// The error message.
	Message string `json:"message"`
}

DataPoolDataSetupTasksDataPoolSetupTaskError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*DataPoolDataSetupTasksDataPoolSetupTaskError) GetCode

GetCode returns DataPoolDataSetupTasksDataPoolSetupTaskError.Code, and is useful for accessing the field via an interface.

func (*DataPoolDataSetupTasksDataPoolSetupTaskError) GetMessage

GetMessage returns DataPoolDataSetupTasksDataPoolSetupTaskError.Message, and is useful for accessing the field via an interface.

type DataPoolDataSyncingDataPoolSyncing added in v0.1.3

type DataPoolDataSyncingDataPoolSyncing struct {
	DataPoolSyncingData `json:"-"`
}

DataPoolDataSyncingDataPoolSyncing includes the requested fields of the GraphQL type DataPoolSyncing. The GraphQL type's documentation follows.

Settings related to Data Pool syncing.

func (*DataPoolDataSyncingDataPoolSyncing) GetInterval added in v0.1.3

GetInterval returns DataPoolDataSyncingDataPoolSyncing.Interval, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncingDataPoolSyncing) GetLastSyncedAt added in v0.1.3

func (v *DataPoolDataSyncingDataPoolSyncing) GetLastSyncedAt() *time.Time

GetLastSyncedAt returns DataPoolDataSyncingDataPoolSyncing.LastSyncedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncingDataPoolSyncing) GetStatus added in v0.1.3

GetStatus returns DataPoolDataSyncingDataPoolSyncing.Status, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncingDataPoolSyncing) MarshalJSON added in v0.1.3

func (v *DataPoolDataSyncingDataPoolSyncing) MarshalJSON() ([]byte, error)

func (*DataPoolDataSyncingDataPoolSyncing) UnmarshalJSON added in v0.1.3

func (v *DataPoolDataSyncingDataPoolSyncing) UnmarshalJSON(b []byte) error

type DataPoolDataSyncsSyncConnection

type DataPoolDataSyncsSyncConnection struct {
	// The Sync connection's nodes.
	Nodes []*DataPoolDataSyncsSyncConnectionNodesSync `json:"nodes"`
}

DataPoolDataSyncsSyncConnection includes the requested fields of the GraphQL type SyncConnection. The GraphQL type's documentation follows.

The Sync connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataPoolDataSyncsSyncConnection) GetNodes

GetNodes returns DataPoolDataSyncsSyncConnection.Nodes, and is useful for accessing the field via an interface.

type DataPoolDataSyncsSyncConnectionNodesSync

type DataPoolDataSyncsSyncConnectionNodesSync struct {
	SyncData `json:"-"`
}

DataPoolDataSyncsSyncConnectionNodesSync includes the requested fields of the GraphQL type Sync. The GraphQL type's documentation follows.

The Sync object.

This represents the process of syncing data from your Data Source (for example, a Snowflake data warehouse) to your Data Pool.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetCreatedAt

GetCreatedAt returns DataPoolDataSyncsSyncConnectionNodesSync.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetCreatedBy

GetCreatedBy returns DataPoolDataSyncsSyncConnectionNodesSync.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetDeletedRecords

func (v *DataPoolDataSyncsSyncConnectionNodesSync) GetDeletedRecords() *string

GetDeletedRecords returns DataPoolDataSyncsSyncConnectionNodesSync.DeletedRecords, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetError

GetError returns DataPoolDataSyncsSyncConnectionNodesSync.Error, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetFailedAt

GetFailedAt returns DataPoolDataSyncsSyncConnectionNodesSync.FailedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetId

GetId returns DataPoolDataSyncsSyncConnectionNodesSync.Id, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetInvalidRecords

func (v *DataPoolDataSyncsSyncConnectionNodesSync) GetInvalidRecords() *string

GetInvalidRecords returns DataPoolDataSyncsSyncConnectionNodesSync.InvalidRecords, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetModifiedAt

GetModifiedAt returns DataPoolDataSyncsSyncConnectionNodesSync.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetModifiedBy

GetModifiedBy returns DataPoolDataSyncsSyncConnectionNodesSync.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetNewRecords

GetNewRecords returns DataPoolDataSyncsSyncConnectionNodesSync.NewRecords, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetStartedAt

GetStartedAt returns DataPoolDataSyncsSyncConnectionNodesSync.StartedAt, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetStatus

GetStatus returns DataPoolDataSyncsSyncConnectionNodesSync.Status, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetSucceededAt

func (v *DataPoolDataSyncsSyncConnectionNodesSync) GetSucceededAt() *time.Time

GetSucceededAt returns DataPoolDataSyncsSyncConnectionNodesSync.SucceededAt, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) GetUpdatedRecords

func (v *DataPoolDataSyncsSyncConnectionNodesSync) GetUpdatedRecords() *string

GetUpdatedRecords returns DataPoolDataSyncsSyncConnectionNodesSync.UpdatedRecords, and is useful for accessing the field via an interface.

func (*DataPoolDataSyncsSyncConnectionNodesSync) MarshalJSON

func (v *DataPoolDataSyncsSyncConnectionNodesSync) MarshalJSON() ([]byte, error)

func (*DataPoolDataSyncsSyncConnectionNodesSync) UnmarshalJSON

func (v *DataPoolDataSyncsSyncConnectionNodesSync) UnmarshalJSON(b []byte) error

type DataPoolDataTenant added in v1.2.1

type DataPoolDataTenant struct {
	TenantData `json:"-"`
}

DataPoolDataTenant includes the requested fields of the GraphQL type Tenant. The GraphQL type's documentation follows.

A Data Pool's tenant ID column. The tenant ID column is used to control access to your data with access policies.

func (*DataPoolDataTenant) GetColumnName added in v1.2.1

func (v *DataPoolDataTenant) GetColumnName() string

GetColumnName returns DataPoolDataTenant.ColumnName, and is useful for accessing the field via an interface.

func (*DataPoolDataTenant) GetType added in v1.2.1

func (v *DataPoolDataTenant) GetType() string

GetType returns DataPoolDataTenant.Type, and is useful for accessing the field via an interface.

func (*DataPoolDataTenant) MarshalJSON added in v1.2.1

func (v *DataPoolDataTenant) MarshalJSON() ([]byte, error)

func (*DataPoolDataTenant) UnmarshalJSON added in v1.2.1

func (v *DataPoolDataTenant) UnmarshalJSON(b []byte) error

type DataPoolDataTimestamp

type DataPoolDataTimestamp struct {
	TimestampData `json:"-"`
}

DataPoolDataTimestamp includes the requested fields of the GraphQL type Timestamp. The GraphQL type's documentation follows.

A Data Pool's primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

func (*DataPoolDataTimestamp) GetColumnName

func (v *DataPoolDataTimestamp) GetColumnName() string

GetColumnName returns DataPoolDataTimestamp.ColumnName, and is useful for accessing the field via an interface.

func (*DataPoolDataTimestamp) GetType

func (v *DataPoolDataTimestamp) GetType() string

GetType returns DataPoolDataTimestamp.Type, and is useful for accessing the field via an interface.

func (*DataPoolDataTimestamp) MarshalJSON

func (v *DataPoolDataTimestamp) MarshalJSON() ([]byte, error)

func (*DataPoolDataTimestamp) UnmarshalJSON

func (v *DataPoolDataTimestamp) UnmarshalJSON(b []byte) error

type DataPoolDataUniqueId added in v1.0.0

type DataPoolDataUniqueId struct {
	// The name of the column that represents the unique ID.
	ColumnName string `json:"columnName"`
}

DataPoolDataUniqueId includes the requested fields of the GraphQL type UniqueId. The GraphQL type's documentation follows.

A Data Pool's unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

func (*DataPoolDataUniqueId) GetColumnName added in v1.0.0

func (v *DataPoolDataUniqueId) GetColumnName() string

GetColumnName returns DataPoolDataUniqueId.ColumnName, and is useful for accessing the field via an interface.

type DataPoolInput added in v1.2.1

type DataPoolInput struct {
	// The ID of the Data Pool.
	Id *string `json:"id"`
	// The name of the Data Pool.
	Name *string `json:"name"`
}

func (*DataPoolInput) GetId added in v1.2.1

func (v *DataPoolInput) GetId() *string

GetId returns DataPoolInput.Id, and is useful for accessing the field via an interface.

func (*DataPoolInput) GetName added in v1.2.1

func (v *DataPoolInput) GetName() *string

GetName returns DataPoolInput.Name, and is useful for accessing the field via an interface.

type DataPoolResponse

type DataPoolResponse struct {
	// This query returns the Data Pool specified by the given ID.
	//
	// A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries.
	DataPool *DataPoolDataPool `json:"dataPool"`
}

DataPoolResponse is returned by DataPool on success.

func DataPool

func DataPool(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DataPoolResponse, error)

func (*DataPoolResponse) GetDataPool

func (v *DataPoolResponse) GetDataPool() *DataPoolDataPool

GetDataPool returns DataPoolResponse.DataPool, and is useful for accessing the field via an interface.

type DataPoolSetupTaskStatus

type DataPoolSetupTaskStatus string

The status of a Data Pool Setup Task.

const (
	// The Data Pool Setup Task has not been started yet.
	DataPoolSetupTaskStatusNotStarted DataPoolSetupTaskStatus = "NOT_STARTED"
	// The Data Pool Setup Task has completed successfully.
	DataPoolSetupTaskStatusSucceeded DataPoolSetupTaskStatus = "SUCCEEDED"
	// The Data Pool Setup Task has failed.
	DataPoolSetupTaskStatusFailed DataPoolSetupTaskStatus = "FAILED"
)

type DataPoolStatus

type DataPoolStatus string

The status of a Data Pool.

const (
	// The Data Pool has been created and will be set up soon.
	DataPoolStatusCreated DataPoolStatus = "CREATED"
	// Propel is attempting to set up the Data Pool.
	DataPoolStatusPending DataPoolStatus = "PENDING"
	// The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.
	DataPoolStatusLive DataPoolStatus = "LIVE"
	// The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.
	DataPoolStatusSetupFailed DataPoolStatus = "SETUP_FAILED"
	DataPoolStatusConnecting  DataPoolStatus = "CONNECTING"
	DataPoolStatusConnected   DataPoolStatus = "CONNECTED"
	DataPoolStatusBroken      DataPoolStatus = "BROKEN"
	DataPoolStatusPausing     DataPoolStatus = "PAUSING"
	DataPoolStatusPaused      DataPoolStatus = "PAUSED"
	// Propel is deleting the Data Pool and all of its associated data.
	DataPoolStatusDeleting DataPoolStatus = "DELETING"
)

type DataPoolSyncInterval added in v0.1.2

type DataPoolSyncInterval string

The available Data Pool sync intervals. Specify unit of time between attempts to sync data from your data warehouse.

Note that the syncing interval is approximate. For example, setting the syncing interval to `EVERY_1_HOUR` does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes `LIVE`, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.

const (
	DataPoolSyncIntervalEvery1Minute   DataPoolSyncInterval = "EVERY_1_MINUTE"
	DataPoolSyncIntervalEvery5Minutes  DataPoolSyncInterval = "EVERY_5_MINUTES"
	DataPoolSyncIntervalEvery15Minutes DataPoolSyncInterval = "EVERY_15_MINUTES"
	DataPoolSyncIntervalEvery30Minutes DataPoolSyncInterval = "EVERY_30_MINUTES"
	DataPoolSyncIntervalEvery1Hour     DataPoolSyncInterval = "EVERY_1_HOUR"
	DataPoolSyncIntervalEvery4Hours    DataPoolSyncInterval = "EVERY_4_HOURS"
	DataPoolSyncIntervalEvery12Hours   DataPoolSyncInterval = "EVERY_12_HOURS"
	DataPoolSyncIntervalEvery24Hours   DataPoolSyncInterval = "EVERY_24_HOURS"
)

type DataPoolSyncStatus added in v0.1.3

type DataPoolSyncStatus string

The Data Pool Sync Status. It indicates whether a Data Pool is syncing data or not.

const (
	// Syncing is enabled for the Data Pool.
	DataPoolSyncStatusEnabled DataPoolSyncStatus = "ENABLED"
	// Propel is disabling syncing for the Data Pool.
	DataPoolSyncStatusDisabling DataPoolSyncStatus = "DISABLING"
	// Syncing is disabled for the Data Pool.
	DataPoolSyncStatusDisabled DataPoolSyncStatus = "DISABLED"
)

type DataPoolSyncingData added in v0.1.3

type DataPoolSyncingData struct {
	// Indicates whether syncing is enabled or disabled.
	Status DataPoolSyncStatus `json:"status"`
	// The syncing interval.
	//
	// Note that the syncing interval is approximate. For example, setting the syncing interval to `EVERY_1_HOUR`
	// does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to
	// when the Data Pool goes `LIVE`, and Propel will attempt to sync approximately every hour. Additionally,
	// if you pause or resume syncing, this too can shift the syncing interval around.
	Interval *DataPoolSyncInterval `json:"interval"`
	// The date and time of the most recent Sync in UTC.
	LastSyncedAt *time.Time `json:"lastSyncedAt"`
}

DataPoolSyncingData includes the GraphQL fields of DataPoolSyncing requested by the fragment DataPoolSyncingData. The GraphQL type's documentation follows.

Settings related to Data Pool syncing.

func (*DataPoolSyncingData) GetInterval added in v0.1.3

func (v *DataPoolSyncingData) GetInterval() *DataPoolSyncInterval

GetInterval returns DataPoolSyncingData.Interval, and is useful for accessing the field via an interface.

func (*DataPoolSyncingData) GetLastSyncedAt added in v0.1.3

func (v *DataPoolSyncingData) GetLastSyncedAt() *time.Time

GetLastSyncedAt returns DataPoolSyncingData.LastSyncedAt, and is useful for accessing the field via an interface.

func (*DataPoolSyncingData) GetStatus added in v0.1.3

func (v *DataPoolSyncingData) GetStatus() DataPoolSyncStatus

GetStatus returns DataPoolSyncingData.Status, and is useful for accessing the field via an interface.

type DataPoolSyncingInput added in v0.1.2

type DataPoolSyncingInput struct {
	Interval DataPoolSyncInterval `json:"interval"`
}

The fields for modifying the Data Pool syncing.

func (*DataPoolSyncingInput) GetInterval added in v0.1.2

func (v *DataPoolSyncingInput) GetInterval() DataPoolSyncInterval

GetInterval returns DataPoolSyncingInput.Interval, and is useful for accessing the field via an interface.

type DataPoolsDataPoolsDataPoolConnection

type DataPoolsDataPoolsDataPoolConnection struct {
	// The Data Pool connection's page info.
	PageInfo *DataPoolsDataPoolsDataPoolConnectionPageInfo `json:"pageInfo"`
	// The Data Pool connection's edges.
	Edges []*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdge `json:"edges"`
}

DataPoolsDataPoolsDataPoolConnection includes the requested fields of the GraphQL type DataPoolConnection. The GraphQL type's documentation follows.

The Data Pool connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataPoolsDataPoolsDataPoolConnection) GetEdges

GetEdges returns DataPoolsDataPoolsDataPoolConnection.Edges, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnection) GetPageInfo

GetPageInfo returns DataPoolsDataPoolsDataPoolConnection.PageInfo, and is useful for accessing the field via an interface.

type DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdge

type DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdge struct {
	// The edge's node.
	Node *DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool `json:"node"`
}

DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdge includes the requested fields of the GraphQL type DataPoolEdge. The GraphQL type's documentation follows.

The Data Pool edge object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdge) GetNode

GetNode returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdge.Node, and is useful for accessing the field via an interface.

type DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool

type DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool struct {
	DataPoolData `json:"-"`
}

DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetAccessControlEnabled added in v1.1.0

GetAccessControlEnabled returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetAccount

GetAccount returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Account, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetAvailableMeasures

GetAvailableMeasures returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.AvailableMeasures, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetColumns

GetColumns returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Columns, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetCreatedAt

GetCreatedAt returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.CreatedAt, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetCreatedBy

GetCreatedBy returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.CreatedBy, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetDataPoolAccessPolicies added in v1.1.0

GetDataPoolAccessPolicies returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.DataPoolAccessPolicies, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetDataSource

GetDataSource returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.DataSource, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetDescription

GetDescription returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Description, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetEnvironment

GetEnvironment returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Environment, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetError

GetError returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Error, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetId

GetId returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Id, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetModifiedAt

GetModifiedAt returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetModifiedBy

GetModifiedBy returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetSetupTasks

GetSetupTasks returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.SetupTasks, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetStatus

GetStatus returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Status, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetSyncing added in v0.1.3

GetSyncing returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Syncing, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetSyncs

GetSyncs returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Syncs, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetTable

GetTable returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Table, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetTenant added in v1.2.1

GetTenant returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Tenant, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetTimestamp

GetTimestamp returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.Timestamp, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetUniqueId added in v1.0.0

GetUniqueId returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.UniqueId, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) GetUniqueName

GetUniqueName returns DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool.UniqueName, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) MarshalJSON

func (*DataPoolsDataPoolsDataPoolConnectionEdgesDataPoolEdgeNodeDataPool) UnmarshalJSON

type DataPoolsDataPoolsDataPoolConnectionPageInfo

type DataPoolsDataPoolsDataPoolConnectionPageInfo struct {
	PageInfoData `json:"-"`
}

DataPoolsDataPoolsDataPoolConnectionPageInfo includes the requested fields of the GraphQL type PageInfo. The GraphQL type's documentation follows.

The page info object used for pagination.

func (*DataPoolsDataPoolsDataPoolConnectionPageInfo) GetEndCursor

GetEndCursor returns DataPoolsDataPoolsDataPoolConnectionPageInfo.EndCursor, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionPageInfo) GetHasNextPage

GetHasNextPage returns DataPoolsDataPoolsDataPoolConnectionPageInfo.HasNextPage, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionPageInfo) GetHasPreviousPage

func (v *DataPoolsDataPoolsDataPoolConnectionPageInfo) GetHasPreviousPage() bool

GetHasPreviousPage returns DataPoolsDataPoolsDataPoolConnectionPageInfo.HasPreviousPage, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionPageInfo) GetStartCursor

GetStartCursor returns DataPoolsDataPoolsDataPoolConnectionPageInfo.StartCursor, and is useful for accessing the field via an interface.

func (*DataPoolsDataPoolsDataPoolConnectionPageInfo) MarshalJSON

func (*DataPoolsDataPoolsDataPoolConnectionPageInfo) UnmarshalJSON

type DataPoolsResponse

type DataPoolsResponse struct {
	// This query returns the Data Pools within the Environment.
	//
	// A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.
	//
	// The `dataPools` query uses [cursor-based pagination](/docs/api/pagination) typical of GraphQL APIs. You can use the pairs of parameters `first` and `after` or `last` and `before` to page forward or backward through the results, respectively.
	//
	// For forward pagination, the `first` parameter defines the number of results to return, and the `after` parameter defines the cursor to continue from. You should pass the cursor for the _last_ result of the current page to `after`.
	//
	// For backward pagination, the `last` parameter defines the number of results to return, and the `before` parameter defines the cursor to continue from. You should pass the cursor for the _first_ result of the current page to `before`.
	DataPools *DataPoolsDataPoolsDataPoolConnection `json:"dataPools"`
}

DataPoolsResponse is returned by DataPools on success.

func DataPools

func DataPools(
	ctx context.Context,
	client graphql.Client,
	first *int,
	last *int,
	after *string,
	before *string,
) (*DataPoolsResponse, error)

func (*DataPoolsResponse) GetDataPools

GetDataPools returns DataPoolsResponse.DataPools, and is useful for accessing the field via an interface.

type DataSourceByNameDataSource

type DataSourceByNameDataSource struct {
	DataSourceData `json:"-"`
}

DataSourceByNameDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*DataSourceByNameDataSource) GetAccount

GetAccount returns DataSourceByNameDataSource.Account, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetChecks

GetChecks returns DataSourceByNameDataSource.Checks, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetConnectionSettings

GetConnectionSettings returns DataSourceByNameDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetCreatedAt

func (v *DataSourceByNameDataSource) GetCreatedAt() time.Time

GetCreatedAt returns DataSourceByNameDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetCreatedBy

func (v *DataSourceByNameDataSource) GetCreatedBy() string

GetCreatedBy returns DataSourceByNameDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetDataPools added in v1.0.1

GetDataPools returns DataSourceByNameDataSource.DataPools, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetDescription

func (v *DataSourceByNameDataSource) GetDescription() string

GetDescription returns DataSourceByNameDataSource.Description, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetEnvironment

GetEnvironment returns DataSourceByNameDataSource.Environment, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetError

GetError returns DataSourceByNameDataSource.Error, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetId

GetId returns DataSourceByNameDataSource.Id, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetModifiedAt

func (v *DataSourceByNameDataSource) GetModifiedAt() time.Time

GetModifiedAt returns DataSourceByNameDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetModifiedBy

func (v *DataSourceByNameDataSource) GetModifiedBy() string

GetModifiedBy returns DataSourceByNameDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetStatus

GetStatus returns DataSourceByNameDataSource.Status, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetTableIntrospections

GetTableIntrospections returns DataSourceByNameDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetTables

GetTables returns DataSourceByNameDataSource.Tables, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetType

GetType returns DataSourceByNameDataSource.Type, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) GetUniqueName

func (v *DataSourceByNameDataSource) GetUniqueName() string

GetUniqueName returns DataSourceByNameDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*DataSourceByNameDataSource) MarshalJSON

func (v *DataSourceByNameDataSource) MarshalJSON() ([]byte, error)

func (*DataSourceByNameDataSource) UnmarshalJSON

func (v *DataSourceByNameDataSource) UnmarshalJSON(b []byte) error

type DataSourceByNameResponse

type DataSourceByNameResponse struct {
	// This query returns the Data Source specified by the given unique name.
	//
	// A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.
	DataSource *DataSourceByNameDataSource `json:"dataSource"`
}

DataSourceByNameResponse is returned by DataSourceByName on success.

func DataSourceByName

func DataSourceByName(
	ctx context.Context,
	client graphql.Client,
	uniqueName string,
) (*DataSourceByNameResponse, error)

func (*DataSourceByNameResponse) GetDataSource

GetDataSource returns DataSourceByNameResponse.DataSource, and is useful for accessing the field via an interface.

type DataSourceCheckStatus

type DataSourceCheckStatus string

The status of a Data Source Check.

const (
	// The Check has not started.
	DataSourceCheckStatusNotStarted DataSourceCheckStatus = "NOT_STARTED"
	// The Check succeeded.
	DataSourceCheckStatusSucceeded DataSourceCheckStatus = "SUCCEEDED"
	// The Check failed.
	DataSourceCheckStatusFailed DataSourceCheckStatus = "FAILED"
)

type DataSourceData

type DataSourceData struct {
	// The Data Source's unique identifier.
	Id                   string `json:"id"`
	CommonDataDataSource `json:"-"`
	// The Data Source's type.
	Type DataSourceType `json:"type"`
	// The Data Source's status.
	Status DataSourceStatus     `json:"status"`
	Error  *DataSourceDataError `json:"error"`
	// If you list Data Pools via the `dataPools` field on a Data Source, you will get Data Pools for the Data Source.
	//
	// The `dataPools` field uses [cursor-based pagination](/docs/api/pagination) typical of GraphQL APIs. You can use the pairs of parameters `first` and `after` or `last` and `before` to page forward or backward through the results, respectively.
	//
	// For forward pagination, the `first` parameter defines the number of results to return, and the `after` parameter defines the cursor to continue from. You should pass the cursor for the _last_ result of the current page to `after`.
	//
	// For backward pagination, the `last` parameter defines the number of results to return, and the `before` parameter defines the cursor to continue from. You should pass the cursor for the _first_ result of the current page to `before`.
	DataPools *DataSourceDataDataPoolsDataPoolConnection `json:"dataPools"`
	// The Data Source's connection settings.
	ConnectionSettings DataSourceDataConnectionSettings `json:"-"`
	// The tables contained within the Data Source, according to the most recent table introspection.
	Tables *DataSourceDataTablesTableConnection `json:"tables"`
	// A list of checks performed on the Data Source during its most recent connection attempt.
	Checks []*DataSourceDataChecksDataSourceCheck `json:"checks"`
	// A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.
	TableIntrospections *DataSourceDataTableIntrospectionsTableIntrospectionConnection `json:"tableIntrospections"`
}

DataSourceData includes the GraphQL fields of DataSource requested by the fragment DataSourceData. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*DataSourceData) GetAccount

func (v *DataSourceData) GetAccount() *CommonDataAccount

GetAccount returns DataSourceData.Account, and is useful for accessing the field via an interface.

func (*DataSourceData) GetChecks

GetChecks returns DataSourceData.Checks, and is useful for accessing the field via an interface.

func (*DataSourceData) GetConnectionSettings

func (v *DataSourceData) GetConnectionSettings() DataSourceDataConnectionSettings

GetConnectionSettings returns DataSourceData.ConnectionSettings, and is useful for accessing the field via an interface.

func (*DataSourceData) GetCreatedAt

func (v *DataSourceData) GetCreatedAt() time.Time

GetCreatedAt returns DataSourceData.CreatedAt, and is useful for accessing the field via an interface.

func (*DataSourceData) GetCreatedBy

func (v *DataSourceData) GetCreatedBy() string

GetCreatedBy returns DataSourceData.CreatedBy, and is useful for accessing the field via an interface.

func (*DataSourceData) GetDataPools added in v1.0.1

GetDataPools returns DataSourceData.DataPools, and is useful for accessing the field via an interface.

func (*DataSourceData) GetDescription

func (v *DataSourceData) GetDescription() string

GetDescription returns DataSourceData.Description, and is useful for accessing the field via an interface.

func (*DataSourceData) GetEnvironment

func (v *DataSourceData) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns DataSourceData.Environment, and is useful for accessing the field via an interface.

func (*DataSourceData) GetError

func (v *DataSourceData) GetError() *DataSourceDataError

GetError returns DataSourceData.Error, and is useful for accessing the field via an interface.

func (*DataSourceData) GetId

func (v *DataSourceData) GetId() string

GetId returns DataSourceData.Id, and is useful for accessing the field via an interface.

func (*DataSourceData) GetModifiedAt

func (v *DataSourceData) GetModifiedAt() time.Time

GetModifiedAt returns DataSourceData.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataSourceData) GetModifiedBy

func (v *DataSourceData) GetModifiedBy() string

GetModifiedBy returns DataSourceData.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataSourceData) GetStatus

func (v *DataSourceData) GetStatus() DataSourceStatus

GetStatus returns DataSourceData.Status, and is useful for accessing the field via an interface.

func (*DataSourceData) GetTableIntrospections

GetTableIntrospections returns DataSourceData.TableIntrospections, and is useful for accessing the field via an interface.

func (*DataSourceData) GetTables

GetTables returns DataSourceData.Tables, and is useful for accessing the field via an interface.

func (*DataSourceData) GetType

func (v *DataSourceData) GetType() DataSourceType

GetType returns DataSourceData.Type, and is useful for accessing the field via an interface.

func (*DataSourceData) GetUniqueName

func (v *DataSourceData) GetUniqueName() string

GetUniqueName returns DataSourceData.UniqueName, and is useful for accessing the field via an interface.

func (*DataSourceData) MarshalJSON

func (v *DataSourceData) MarshalJSON() ([]byte, error)

func (*DataSourceData) UnmarshalJSON

func (v *DataSourceData) UnmarshalJSON(b []byte) error

type DataSourceDataChecksDataSourceCheck

type DataSourceDataChecksDataSourceCheck struct {
	// The name of the Data Source Check to be performed.
	Name string `json:"name"`
	// A description of the Data Source Check to be performed.
	Description *string `json:"description"`
	// The status of the Data Source Check (all checks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).
	Status DataSourceCheckStatus `json:"status"`
	// If the Data Source Check failed, this field includes a descriptive error message.
	Error *DataSourceDataChecksDataSourceCheckError `json:"error"`
	// The time at which the Data Source Check was performed.
	CheckedAt *time.Time `json:"checkedAt"`
}

DataSourceDataChecksDataSourceCheck includes the requested fields of the GraphQL type DataSourceCheck. The GraphQL type's documentation follows.

The Data Source Check object.

Data Source Checks are executed when setting up your Data Source. They check that Propel will be able to receive data and setup Data Pools.

The exact Checks to perform vary by Data Source. For example, Snowflake-backed Data Sources will have their own specific Checks.

func (*DataSourceDataChecksDataSourceCheck) GetCheckedAt

func (v *DataSourceDataChecksDataSourceCheck) GetCheckedAt() *time.Time

GetCheckedAt returns DataSourceDataChecksDataSourceCheck.CheckedAt, and is useful for accessing the field via an interface.

func (*DataSourceDataChecksDataSourceCheck) GetDescription

func (v *DataSourceDataChecksDataSourceCheck) GetDescription() *string

GetDescription returns DataSourceDataChecksDataSourceCheck.Description, and is useful for accessing the field via an interface.

func (*DataSourceDataChecksDataSourceCheck) GetError

GetError returns DataSourceDataChecksDataSourceCheck.Error, and is useful for accessing the field via an interface.

func (*DataSourceDataChecksDataSourceCheck) GetName

GetName returns DataSourceDataChecksDataSourceCheck.Name, and is useful for accessing the field via an interface.

func (*DataSourceDataChecksDataSourceCheck) GetStatus

GetStatus returns DataSourceDataChecksDataSourceCheck.Status, and is useful for accessing the field via an interface.

type DataSourceDataChecksDataSourceCheckError

type DataSourceDataChecksDataSourceCheckError struct {
	// The error code.
	Code *int `json:"code"`
	// The error message.
	Message string `json:"message"`
}

DataSourceDataChecksDataSourceCheckError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*DataSourceDataChecksDataSourceCheckError) GetCode

GetCode returns DataSourceDataChecksDataSourceCheckError.Code, and is useful for accessing the field via an interface.

func (*DataSourceDataChecksDataSourceCheckError) GetMessage

GetMessage returns DataSourceDataChecksDataSourceCheckError.Message, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettings

type DataSourceDataConnectionSettings interface {

	// GetTypename returns the receiver's concrete GraphQL type-name (see interface doc for possible values).
	GetTypename() *string
	// contains filtered or unexported methods
}

DataSourceDataConnectionSettings includes the requested fields of the GraphQL interface ConnectionSettings.

DataSourceDataConnectionSettings is implemented by the following types: DataSourceDataConnectionSettingsHttpConnectionSettings DataSourceDataConnectionSettingsInternalConnectionSettings DataSourceDataConnectionSettingsKafkaConnectionSettings DataSourceDataConnectionSettingsS3ConnectionSettings DataSourceDataConnectionSettingsSnowflakeConnectionSettings DataSourceDataConnectionSettingsWebhookConnectionSettings

type DataSourceDataConnectionSettingsHttpConnectionSettings

type DataSourceDataConnectionSettingsHttpConnectionSettings struct {
	Typename *string `json:"__typename"`
	// The HTTP Basic authentication settings for uploading new data.
	//
	// If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it's OK to test without HTTP Basic authentication, we recommend enabling it.
	BasicAuth *DataSourceDataConnectionSettingsHttpConnectionSettingsBasicAuthHttpBasicAuthSettings `json:"basicAuth"`
	// The HTTP Data Source's tables.
	Tables []*DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable `json:"tables"`
}

DataSourceDataConnectionSettingsHttpConnectionSettings includes the requested fields of the GraphQL type HttpConnectionSettings. The GraphQL type's documentation follows.

The HTTP Data Source connection settings.

func (*DataSourceDataConnectionSettingsHttpConnectionSettings) GetBasicAuth

GetBasicAuth returns DataSourceDataConnectionSettingsHttpConnectionSettings.BasicAuth, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsHttpConnectionSettings) GetTables added in v0.1.3

GetTables returns DataSourceDataConnectionSettingsHttpConnectionSettings.Tables, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsHttpConnectionSettings) GetTypename

GetTypename returns DataSourceDataConnectionSettingsHttpConnectionSettings.Typename, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsHttpConnectionSettingsBasicAuthHttpBasicAuthSettings

type DataSourceDataConnectionSettingsHttpConnectionSettingsBasicAuthHttpBasicAuthSettings struct {
	// Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.
	Username string `json:"username"`
	// Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.
	Password string `json:"password"`
}

DataSourceDataConnectionSettingsHttpConnectionSettingsBasicAuthHttpBasicAuthSettings includes the requested fields of the GraphQL type HttpBasicAuthSettings. The GraphQL type's documentation follows.

The HTTP Basic authentication settings.

func (*DataSourceDataConnectionSettingsHttpConnectionSettingsBasicAuthHttpBasicAuthSettings) GetPassword

GetPassword returns DataSourceDataConnectionSettingsHttpConnectionSettingsBasicAuthHttpBasicAuthSettings.Password, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsHttpConnectionSettingsBasicAuthHttpBasicAuthSettings) GetUsername

GetUsername returns DataSourceDataConnectionSettingsHttpConnectionSettingsBasicAuthHttpBasicAuthSettings.Username, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable added in v0.1.3

type DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable struct {
	// The ID of the table
	Id string `json:"id"`
	// The name of the table
	Name string `json:"name"`
	// All the columns present in the table
	Columns []*DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn `json:"columns"`
}

DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable includes the requested fields of the GraphQL type HttpDataSourceTable. The GraphQL type's documentation follows.

An HTTP Data Source's table.

func (*DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable) GetColumns added in v0.1.3

GetColumns returns DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable.Columns, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable) GetId added in v0.1.3

GetId returns DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable.Id, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable) GetName added in v0.1.3

GetName returns DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTable.Name, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn added in v0.1.3

type DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn struct {
	// The column name. It has to be unique within a Table.
	Name string `json:"name"`
	// The column type.
	Type ColumnType `json:"type"`
	// Whether the column's type is nullable or not.
	Nullable bool `json:"nullable"`
}

DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn includes the requested fields of the GraphQL type HttpDataSourceColumn. The GraphQL type's documentation follows.

A column in an HTTP Data Source's table.

func (*DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn) GetName added in v0.1.3

GetName returns DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn.Name, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn) GetNullable added in v0.1.3

GetNullable returns DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn.Nullable, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn) GetType added in v0.1.3

GetType returns DataSourceDataConnectionSettingsHttpConnectionSettingsTablesHttpDataSourceTableColumnsHttpDataSourceColumn.Type, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsInternalConnectionSettings added in v1.2.1

type DataSourceDataConnectionSettingsInternalConnectionSettings struct {
	Typename *string `json:"__typename"`
}

DataSourceDataConnectionSettingsInternalConnectionSettings includes the requested fields of the GraphQL type InternalConnectionSettings.

func (*DataSourceDataConnectionSettingsInternalConnectionSettings) GetTypename added in v1.2.1

GetTypename returns DataSourceDataConnectionSettingsInternalConnectionSettings.Typename, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsKafkaConnectionSettings added in v1.2.1

type DataSourceDataConnectionSettingsKafkaConnectionSettings struct {
	Typename *string `json:"__typename"`
}

DataSourceDataConnectionSettingsKafkaConnectionSettings includes the requested fields of the GraphQL type KafkaConnectionSettings. The GraphQL type's documentation follows.

The Kafka Data Source connection settings.

func (*DataSourceDataConnectionSettingsKafkaConnectionSettings) GetTypename added in v1.2.1

GetTypename returns DataSourceDataConnectionSettingsKafkaConnectionSettings.Typename, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsS3ConnectionSettings

type DataSourceDataConnectionSettingsS3ConnectionSettings struct {
	Typename *string `json:"__typename"`
	// The name of the S3 bucket.
	Bucket string `json:"bucket"`
	// The AWS access key ID for an IAM user with sufficient access to the S3 bucket.
	AwsAccessKeyId string `json:"awsAccessKeyId"`
	// The S3 Data Source's tables.
	Tables []*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable `json:"tables"`
}

DataSourceDataConnectionSettingsS3ConnectionSettings includes the requested fields of the GraphQL type S3ConnectionSettings. The GraphQL type's documentation follows.

The connection settings for an S3 Data Source. These include the S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.

func (*DataSourceDataConnectionSettingsS3ConnectionSettings) GetAwsAccessKeyId

GetAwsAccessKeyId returns DataSourceDataConnectionSettingsS3ConnectionSettings.AwsAccessKeyId, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsS3ConnectionSettings) GetBucket

GetBucket returns DataSourceDataConnectionSettingsS3ConnectionSettings.Bucket, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsS3ConnectionSettings) GetTables added in v0.1.3

GetTables returns DataSourceDataConnectionSettingsS3ConnectionSettings.Tables, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsS3ConnectionSettings) GetTypename

GetTypename returns DataSourceDataConnectionSettingsS3ConnectionSettings.Typename, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable added in v0.1.3

type DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable struct {
	// The ID of the table
	Id string `json:"id"`
	// The name of the table
	Name string `json:"name"`
	// The path to the table's files in S3.
	Path *string `json:"path"`
	// All the columns present in the table
	Columns []*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn `json:"columns"`
}

DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable includes the requested fields of the GraphQL type S3DataSourceTable. The GraphQL type's documentation follows.

An S3 Data Source's table.

func (*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable) GetColumns added in v0.1.3

GetColumns returns DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable.Columns, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable) GetId added in v0.1.3

GetId returns DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable.Id, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable) GetName added in v0.1.3

GetName returns DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable.Name, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable) GetPath added in v0.1.4

GetPath returns DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTable.Path, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn added in v0.1.3

type DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn struct {
	// The column name.
	Name string `json:"name"`
	// The column type.
	Type ColumnType `json:"type"`
	// Whether the column's type is nullable or not.
	Nullable bool `json:"nullable"`
}

DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn includes the requested fields of the GraphQL type S3DataSourceColumn. The GraphQL type's documentation follows.

A column in an S3 Data Source's table.

func (*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn) GetName added in v0.1.3

GetName returns DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn.Name, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn) GetNullable added in v0.1.3

GetNullable returns DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn.Nullable, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn) GetType added in v0.1.3

GetType returns DataSourceDataConnectionSettingsS3ConnectionSettingsTablesS3DataSourceTableColumnsS3DataSourceColumn.Type, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsSnowflakeConnectionSettings

type DataSourceDataConnectionSettingsSnowflakeConnectionSettings struct {
	Typename *string `json:"__typename"`
	// The Snowflake account. This is the part before the "snowflakecomputing.com" part of your Snowflake URL.
	Account string `json:"account"`
	// The Snowflake database name.
	Database string `json:"database"`
	// The Snowflake warehouse name. It should be "PROPELLING" if you used the default name in the setup script.
	Warehouse string `json:"warehouse"`
	// The Snowflake schema.
	Schema string `json:"schema"`
	// The Snowflake username. It should be "PROPEL" if you used the default name in the setup script.
	Username string `json:"username"`
	// The Snowflake role. It should be "PROPELLER" if you used the default name in the setup script.
	Role string `json:"role"`
}

DataSourceDataConnectionSettingsSnowflakeConnectionSettings includes the requested fields of the GraphQL type SnowflakeConnectionSettings. The GraphQL type's documentation follows.

The Snowflake Data Source connection settings.

func (*DataSourceDataConnectionSettingsSnowflakeConnectionSettings) GetAccount

GetAccount returns DataSourceDataConnectionSettingsSnowflakeConnectionSettings.Account, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsSnowflakeConnectionSettings) GetDatabase

GetDatabase returns DataSourceDataConnectionSettingsSnowflakeConnectionSettings.Database, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsSnowflakeConnectionSettings) GetRole

GetRole returns DataSourceDataConnectionSettingsSnowflakeConnectionSettings.Role, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsSnowflakeConnectionSettings) GetSchema

GetSchema returns DataSourceDataConnectionSettingsSnowflakeConnectionSettings.Schema, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsSnowflakeConnectionSettings) GetTypename

GetTypename returns DataSourceDataConnectionSettingsSnowflakeConnectionSettings.Typename, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsSnowflakeConnectionSettings) GetUsername

GetUsername returns DataSourceDataConnectionSettingsSnowflakeConnectionSettings.Username, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsSnowflakeConnectionSettings) GetWarehouse

GetWarehouse returns DataSourceDataConnectionSettingsSnowflakeConnectionSettings.Warehouse, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsWebhookConnectionSettings added in v1.0.1

type DataSourceDataConnectionSettingsWebhookConnectionSettings struct {
	Typename *string `json:"__typename"`
	// The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it's OK to test without HTTP Basic authentication, we recommend enabling it.
	BasicAuth *DataSourceDataConnectionSettingsWebhookConnectionSettingsBasicAuthHttpBasicAuthSettings `json:"basicAuth"`
	// The additional columns for the Webhook Data Source table.
	Columns []*DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn `json:"columns"`
	// The tenant ID column, if any.
	Tenant *string `json:"tenant"`
	// The primary timestamp column, if any.
	Timestamp *string `json:"timestamp"`
	// The unique ID column, if any. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated.
	UniqueId *string `json:"uniqueId"`
	// The Webhook URL for posting JSON events
	WebhookUrl string `json:"webhookUrl"`
}

DataSourceDataConnectionSettingsWebhookConnectionSettings includes the requested fields of the GraphQL type WebhookConnectionSettings. The GraphQL type's documentation follows.

The Webhook Data Source connection settings.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettings) GetBasicAuth added in v1.0.1

GetBasicAuth returns DataSourceDataConnectionSettingsWebhookConnectionSettings.BasicAuth, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettings) GetColumns added in v1.0.1

GetColumns returns DataSourceDataConnectionSettingsWebhookConnectionSettings.Columns, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettings) GetTenant added in v1.0.1

GetTenant returns DataSourceDataConnectionSettingsWebhookConnectionSettings.Tenant, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettings) GetTimestamp added in v1.0.1

GetTimestamp returns DataSourceDataConnectionSettingsWebhookConnectionSettings.Timestamp, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettings) GetTypename added in v1.0.1

GetTypename returns DataSourceDataConnectionSettingsWebhookConnectionSettings.Typename, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettings) GetUniqueId added in v1.0.1

GetUniqueId returns DataSourceDataConnectionSettingsWebhookConnectionSettings.UniqueId, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettings) GetWebhookUrl added in v1.0.1

GetWebhookUrl returns DataSourceDataConnectionSettingsWebhookConnectionSettings.WebhookUrl, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsWebhookConnectionSettingsBasicAuthHttpBasicAuthSettings added in v1.0.1

type DataSourceDataConnectionSettingsWebhookConnectionSettingsBasicAuthHttpBasicAuthSettings struct {
	// Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.
	Username string `json:"username"`
	// Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.
	Password string `json:"password"`
}

DataSourceDataConnectionSettingsWebhookConnectionSettingsBasicAuthHttpBasicAuthSettings includes the requested fields of the GraphQL type HttpBasicAuthSettings. The GraphQL type's documentation follows.

The HTTP Basic authentication settings.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettingsBasicAuthHttpBasicAuthSettings) GetPassword added in v1.0.1

GetPassword returns DataSourceDataConnectionSettingsWebhookConnectionSettingsBasicAuthHttpBasicAuthSettings.Password, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettingsBasicAuthHttpBasicAuthSettings) GetUsername added in v1.0.1

GetUsername returns DataSourceDataConnectionSettingsWebhookConnectionSettingsBasicAuthHttpBasicAuthSettings.Username, and is useful for accessing the field via an interface.

type DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn added in v1.0.1

type DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn struct {
	// The column name.
	Name string `json:"name"`
	// The column type.
	Type ColumnType `json:"type"`
	// The JSON property that the column will be derived from. For example, if you POST a JSON event like this:
	// “`json
	// { "greeting": { "message": "hello, world" } }
	// “`
	// Then you can use the JSON property "greeting.message" to extract "hello, world" to a column.
	JsonProperty string `json:"jsonProperty"`
	// Whether the column's type is nullable or not.
	Nullable bool `json:"nullable"`
}

DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn includes the requested fields of the GraphQL type WebhookDataSourceColumn. The GraphQL type's documentation follows.

A column in the Webhook Data Source's table.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn) GetJsonProperty added in v1.0.1

GetJsonProperty returns DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn.JsonProperty, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn) GetName added in v1.0.1

GetName returns DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn.Name, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn) GetNullable added in v1.0.1

GetNullable returns DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn.Nullable, and is useful for accessing the field via an interface.

func (*DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn) GetType added in v1.0.1

GetType returns DataSourceDataConnectionSettingsWebhookConnectionSettingsColumnsWebhookDataSourceColumn.Type, and is useful for accessing the field via an interface.

type DataSourceDataDataPoolsDataPoolConnection added in v1.0.1

type DataSourceDataDataPoolsDataPoolConnection struct {
	// The Data Pool connection's nodes.
	Nodes []*DataSourceDataDataPoolsDataPoolConnectionNodesDataPool `json:"nodes"`
}

DataSourceDataDataPoolsDataPoolConnection includes the requested fields of the GraphQL type DataPoolConnection. The GraphQL type's documentation follows.

The Data Pool connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataSourceDataDataPoolsDataPoolConnection) GetNodes added in v1.0.1

GetNodes returns DataSourceDataDataPoolsDataPoolConnection.Nodes, and is useful for accessing the field via an interface.

type DataSourceDataDataPoolsDataPoolConnectionNodesDataPool added in v1.0.1

type DataSourceDataDataPoolsDataPoolConnectionNodesDataPool struct {
	// The Data Pool's unique identifier.
	Id string `json:"id"`
	// Whether the Data Pool has access control enabled or not.
	//
	// If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
	// Policies in order to query the Data Pool and its Metrics.
	AccessControlEnabled bool `json:"accessControlEnabled"`
}

DataSourceDataDataPoolsDataPoolConnectionNodesDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*DataSourceDataDataPoolsDataPoolConnectionNodesDataPool) GetAccessControlEnabled added in v1.1.0

func (v *DataSourceDataDataPoolsDataPoolConnectionNodesDataPool) GetAccessControlEnabled() bool

GetAccessControlEnabled returns DataSourceDataDataPoolsDataPoolConnectionNodesDataPool.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*DataSourceDataDataPoolsDataPoolConnectionNodesDataPool) GetId added in v1.0.1

GetId returns DataSourceDataDataPoolsDataPoolConnectionNodesDataPool.Id, and is useful for accessing the field via an interface.

type DataSourceDataError

type DataSourceDataError struct {
	// The error message.
	Message string `json:"message"`
}

DataSourceDataError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*DataSourceDataError) GetMessage

func (v *DataSourceDataError) GetMessage() string

GetMessage returns DataSourceDataError.Message, and is useful for accessing the field via an interface.

type DataSourceDataSource

type DataSourceDataSource struct {
	DataSourceData `json:"-"`
}

DataSourceDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*DataSourceDataSource) GetAccount

func (v *DataSourceDataSource) GetAccount() *CommonDataAccount

GetAccount returns DataSourceDataSource.Account, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetChecks

GetChecks returns DataSourceDataSource.Checks, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetConnectionSettings

func (v *DataSourceDataSource) GetConnectionSettings() DataSourceDataConnectionSettings

GetConnectionSettings returns DataSourceDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetCreatedAt

func (v *DataSourceDataSource) GetCreatedAt() time.Time

GetCreatedAt returns DataSourceDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetCreatedBy

func (v *DataSourceDataSource) GetCreatedBy() string

GetCreatedBy returns DataSourceDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetDataPools added in v1.0.1

GetDataPools returns DataSourceDataSource.DataPools, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetDescription

func (v *DataSourceDataSource) GetDescription() string

GetDescription returns DataSourceDataSource.Description, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetEnvironment

func (v *DataSourceDataSource) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns DataSourceDataSource.Environment, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetError

GetError returns DataSourceDataSource.Error, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetId

func (v *DataSourceDataSource) GetId() string

GetId returns DataSourceDataSource.Id, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetModifiedAt

func (v *DataSourceDataSource) GetModifiedAt() time.Time

GetModifiedAt returns DataSourceDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetModifiedBy

func (v *DataSourceDataSource) GetModifiedBy() string

GetModifiedBy returns DataSourceDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetStatus

func (v *DataSourceDataSource) GetStatus() DataSourceStatus

GetStatus returns DataSourceDataSource.Status, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetTableIntrospections

GetTableIntrospections returns DataSourceDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetTables

GetTables returns DataSourceDataSource.Tables, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetType

func (v *DataSourceDataSource) GetType() DataSourceType

GetType returns DataSourceDataSource.Type, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) GetUniqueName

func (v *DataSourceDataSource) GetUniqueName() string

GetUniqueName returns DataSourceDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*DataSourceDataSource) MarshalJSON

func (v *DataSourceDataSource) MarshalJSON() ([]byte, error)

func (*DataSourceDataSource) UnmarshalJSON

func (v *DataSourceDataSource) UnmarshalJSON(b []byte) error

type DataSourceDataTableIntrospectionsTableIntrospectionConnection

type DataSourceDataTableIntrospectionsTableIntrospectionConnection struct {
	// The table introspection connection's nodes.
	Nodes []*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection `json:"nodes"`
}

DataSourceDataTableIntrospectionsTableIntrospectionConnection includes the requested fields of the GraphQL type TableIntrospectionConnection. The GraphQL type's documentation follows.

The table introspection connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnection) GetNodes

GetNodes returns DataSourceDataTableIntrospectionsTableIntrospectionConnection.Nodes, and is useful for accessing the field via an interface.

type DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection

type DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection struct {
	TableIntrospectionData `json:"-"`
}

DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection includes the requested fields of the GraphQL type TableIntrospection. The GraphQL type's documentation follows.

The table introspection object.

When setting up a Data Source, Propel may need to introspect tables in order to determine what tables and columns are available to create Data Pools from. The table introspection represents the lifecycle of this operation (whether it's in-progress, succeeded, or failed) and the resulting tables and columns. These will be captured as table and column objects, respectively.

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) GetCreatedAt

GetCreatedAt returns DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection.CreatedAt, and is useful for accessing the field via an interface.

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) GetCreatedBy

GetCreatedBy returns DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection.CreatedBy, and is useful for accessing the field via an interface.

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) GetDataSource

GetDataSource returns DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection.DataSource, and is useful for accessing the field via an interface.

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) GetModifiedAt

GetModifiedAt returns DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) GetModifiedBy

GetModifiedBy returns DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) GetNumTables

GetNumTables returns DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection.NumTables, and is useful for accessing the field via an interface.

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) GetStatus

GetStatus returns DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection.Status, and is useful for accessing the field via an interface.

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) MarshalJSON

func (*DataSourceDataTableIntrospectionsTableIntrospectionConnectionNodesTableIntrospection) UnmarshalJSON

type DataSourceDataTablesTableConnection

type DataSourceDataTablesTableConnection struct {
	// The table connection's nodes.
	Nodes []*DataSourceDataTablesTableConnectionNodesTable `json:"nodes"`
}

DataSourceDataTablesTableConnection includes the requested fields of the GraphQL type TableConnection. The GraphQL type's documentation follows.

The table connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataSourceDataTablesTableConnection) GetNodes

GetNodes returns DataSourceDataTablesTableConnection.Nodes, and is useful for accessing the field via an interface.

type DataSourceDataTablesTableConnectionNodesTable

type DataSourceDataTablesTableConnectionNodesTable struct {
	// The table's ID.
	Id string `json:"id"`
	// The table's name.
	Name string `json:"name"`
	// The table's columns.
	Columns *DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnection `json:"columns"`
}

DataSourceDataTablesTableConnectionNodesTable includes the requested fields of the GraphQL type Table. The GraphQL type's documentation follows.

The table object.

Once a table introspection succeeds, it creates a new table object for every table it introspected.

func (*DataSourceDataTablesTableConnectionNodesTable) GetColumns

GetColumns returns DataSourceDataTablesTableConnectionNodesTable.Columns, and is useful for accessing the field via an interface.

func (*DataSourceDataTablesTableConnectionNodesTable) GetId added in v0.1.2

GetId returns DataSourceDataTablesTableConnectionNodesTable.Id, and is useful for accessing the field via an interface.

func (*DataSourceDataTablesTableConnectionNodesTable) GetName

GetName returns DataSourceDataTablesTableConnectionNodesTable.Name, and is useful for accessing the field via an interface.

type DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnection

type DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnection struct {
	// The column connection's nodes.
	Nodes []*DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn `json:"nodes"`
}

DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnection includes the requested fields of the GraphQL type ColumnConnection. The GraphQL type's documentation follows.

The column connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnection) GetNodes

GetNodes returns DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnection.Nodes, and is useful for accessing the field via an interface.

type DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn

type DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn struct {
	ColumnData `json:"-"`
}

DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn includes the requested fields of the GraphQL type Column. The GraphQL type's documentation follows.

The column object.

Once a table introspection succeeds, it creates a new table object for every table it introspected. Within each table object, it also creates a column object for every column it introspected.

func (*DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn) GetIsNullable

GetIsNullable returns DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn.IsNullable, and is useful for accessing the field via an interface.

func (*DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn) GetName

GetName returns DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn.Name, and is useful for accessing the field via an interface.

func (*DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn) GetType

GetType returns DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn.Type, and is useful for accessing the field via an interface.

func (*DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn) MarshalJSON

func (*DataSourceDataTablesTableConnectionNodesTableColumnsColumnConnectionNodesColumn) UnmarshalJSON

type DataSourceResponse

type DataSourceResponse struct {
	// This query returns the Data Source specified by the given ID.
	//
	// A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.
	DataSource *DataSourceDataSource `json:"dataSource"`
}

DataSourceResponse is returned by DataSource on success.

func DataSource

func DataSource(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DataSourceResponse, error)

func (*DataSourceResponse) GetDataSource

func (v *DataSourceResponse) GetDataSource() *DataSourceDataSource

GetDataSource returns DataSourceResponse.DataSource, and is useful for accessing the field via an interface.

type DataSourceStatus

type DataSourceStatus string

The status of a Data Source.

const (
	// The Data Source has been created, but it is not connected yet.
	DataSourceStatusCreated DataSourceStatus = "CREATED"
	// Propel is attempting to connect the Data Source.
	DataSourceStatusConnecting DataSourceStatus = "CONNECTING"
	// The Data Source is connected.
	DataSourceStatusConnected DataSourceStatus = "CONNECTED"
	// The Data Source failed to connect.
	DataSourceStatusBroken DataSourceStatus = "BROKEN"
	// Propel is deleting the Data Source.
	DataSourceStatusDeleting DataSourceStatus = "DELETING"
)

type DataSourceType

type DataSourceType string

The types of Data Sources.

const (
	// Indicates a Webhook Data Source.
	DataSourceTypeWebhook DataSourceType = "WEBHOOK"
	// Indicates an S3 Data Source.
	DataSourceTypeS3 DataSourceType = "S3"
	// Indicates a Redshift Data Source.
	DataSourceTypeRedshift DataSourceType = "Redshift"
	// Indicates a Kafka Data Source.
	DataSourceTypeKafka DataSourceType = "KAFKA"
	// Indicates an Http Data Source.
	DataSourceTypeHttp DataSourceType = "Http"
	// Indicates a ClickHouse Data Source.
	DataSourceTypeClickhouse DataSourceType = "CLICKHOUSE"
	// Indicates a BigQuery Data Source.
	DataSourceTypeBigquery DataSourceType = "BIGQUERY"
	// Indicates a Snowflake Data Source.
	DataSourceTypeSnowflake DataSourceType = "Snowflake"
	// Indicates an internal Data Source.
	DataSourceTypeInternal DataSourceType = "INTERNAL"
)

type DataSourcesDataSourcesDataSourceConnection

type DataSourcesDataSourcesDataSourceConnection struct {
	// The Data Source connection's page info.
	PageInfo *DataSourcesDataSourcesDataSourceConnectionPageInfo `json:"pageInfo"`
	// The Data Source connection's edges.
	Edges []*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdge `json:"edges"`
}

DataSourcesDataSourcesDataSourceConnection includes the requested fields of the GraphQL type DataSourceConnection. The GraphQL type's documentation follows.

The Data Source connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataSourcesDataSourcesDataSourceConnection) GetEdges

GetEdges returns DataSourcesDataSourcesDataSourceConnection.Edges, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnection) GetPageInfo

GetPageInfo returns DataSourcesDataSourcesDataSourceConnection.PageInfo, and is useful for accessing the field via an interface.

type DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdge

type DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdge struct {
	// The edge's node.
	Node *DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource `json:"node"`
}

DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdge includes the requested fields of the GraphQL type DataSourceEdge. The GraphQL type's documentation follows.

The Data Source edge object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdge) GetNode

GetNode returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdge.Node, and is useful for accessing the field via an interface.

type DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource

type DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource struct {
	DataSourceData `json:"-"`
}

DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetAccount

GetAccount returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Account, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetChecks

GetChecks returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Checks, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetConnectionSettings

GetConnectionSettings returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetCreatedAt

GetCreatedAt returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetCreatedBy

GetCreatedBy returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetDataPools added in v1.0.1

GetDataPools returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.DataPools, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetDescription

GetDescription returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Description, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetEnvironment

GetEnvironment returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Environment, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetError

GetError returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Error, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetId

GetId returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Id, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetModifiedAt

GetModifiedAt returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetModifiedBy

GetModifiedBy returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetStatus

GetStatus returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Status, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetTableIntrospections

GetTableIntrospections returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetTables

GetTables returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Tables, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetType

GetType returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.Type, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) GetUniqueName

GetUniqueName returns DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) MarshalJSON

func (*DataSourcesDataSourcesDataSourceConnectionEdgesDataSourceEdgeNodeDataSource) UnmarshalJSON

type DataSourcesDataSourcesDataSourceConnectionPageInfo

type DataSourcesDataSourcesDataSourceConnectionPageInfo struct {
	PageInfoData `json:"-"`
}

DataSourcesDataSourcesDataSourceConnectionPageInfo includes the requested fields of the GraphQL type PageInfo. The GraphQL type's documentation follows.

The page info object used for pagination.

func (*DataSourcesDataSourcesDataSourceConnectionPageInfo) GetEndCursor

GetEndCursor returns DataSourcesDataSourcesDataSourceConnectionPageInfo.EndCursor, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionPageInfo) GetHasNextPage

GetHasNextPage returns DataSourcesDataSourcesDataSourceConnectionPageInfo.HasNextPage, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionPageInfo) GetHasPreviousPage

GetHasPreviousPage returns DataSourcesDataSourcesDataSourceConnectionPageInfo.HasPreviousPage, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionPageInfo) GetStartCursor

GetStartCursor returns DataSourcesDataSourcesDataSourceConnectionPageInfo.StartCursor, and is useful for accessing the field via an interface.

func (*DataSourcesDataSourcesDataSourceConnectionPageInfo) MarshalJSON

func (*DataSourcesDataSourcesDataSourceConnectionPageInfo) UnmarshalJSON

type DataSourcesResponse

type DataSourcesResponse struct {
	// This query returns the Data Sources within the Environment.
	//
	// A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.
	//
	// The `dataSources` query uses [cursor-based pagination](/docs/api/pagination) typical of GraphQL APIs. You can use the pairs of parameters `first` and `after` or `last` and `before` to page forward or backward through the results, respectively.
	//
	// For forward pagination, the `first` parameter defines the number of results to return, and the `after` parameter defines the cursor to continue from. You should pass the cursor for the _last_ result of the current page to `after`.
	//
	// For backward pagination, the `last` parameter defines the number of results to return, and the `before` parameter defines the cursor to continue from. You should pass the cursor for the _first_ result of the current page to `before`.
	DataSources *DataSourcesDataSourcesDataSourceConnection `json:"dataSources"`
}

DataSourcesResponse is returned by DataSources on success.

func DataSources

func DataSources(
	ctx context.Context,
	client graphql.Client,
	first *int,
	last *int,
	after *string,
	before *string,
) (*DataSourcesResponse, error)

func (*DataSourcesResponse) GetDataSources

GetDataSources returns DataSourcesResponse.DataSources, and is useful for accessing the field via an interface.

type DeleteDataPoolAccessPolicyResponse added in v1.1.0

type DeleteDataPoolAccessPolicyResponse struct {
	// Deletes a Data Pool Access Policy by ID and returns its ID if the Data Pool Access Policy was deleted successfully.
	//
	// [Learn more about Data Pool Access Policy](https://www.propeldata.com/docs/control-access).
	DeleteDataPoolAccessPolicy *string `json:"deleteDataPoolAccessPolicy"`
}

DeleteDataPoolAccessPolicyResponse is returned by DeleteDataPoolAccessPolicy on success.

func DeleteDataPoolAccessPolicy added in v1.1.0

func DeleteDataPoolAccessPolicy(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DeleteDataPoolAccessPolicyResponse, error)

func (*DeleteDataPoolAccessPolicyResponse) GetDeleteDataPoolAccessPolicy added in v1.1.0

func (v *DeleteDataPoolAccessPolicyResponse) GetDeleteDataPoolAccessPolicy() *string

GetDeleteDataPoolAccessPolicy returns DeleteDataPoolAccessPolicyResponse.DeleteDataPoolAccessPolicy, and is useful for accessing the field via an interface.

type DeleteDataPoolByNameResponse

type DeleteDataPoolByNameResponse struct {
	// Deletes a Data Pool by unique name and returns its ID if the Data Pool was deleted successfully.
	DeleteDataPoolByName *string `json:"deleteDataPoolByName"`
}

DeleteDataPoolByNameResponse is returned by DeleteDataPoolByName on success.

func DeleteDataPoolByName

func DeleteDataPoolByName(
	ctx context.Context,
	client graphql.Client,
	uniqueName string,
) (*DeleteDataPoolByNameResponse, error)

func (*DeleteDataPoolByNameResponse) GetDeleteDataPoolByName

func (v *DeleteDataPoolByNameResponse) GetDeleteDataPoolByName() *string

GetDeleteDataPoolByName returns DeleteDataPoolByNameResponse.DeleteDataPoolByName, and is useful for accessing the field via an interface.

type DeleteDataPoolResponse

type DeleteDataPoolResponse struct {
	// Deletes a Data Pool by ID and returns its ID if the Data Pool was deleted successfully.
	DeleteDataPool *string `json:"deleteDataPool"`
}

DeleteDataPoolResponse is returned by DeleteDataPool on success.

func DeleteDataPool

func DeleteDataPool(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DeleteDataPoolResponse, error)

func (*DeleteDataPoolResponse) GetDeleteDataPool

func (v *DeleteDataPoolResponse) GetDeleteDataPool() *string

GetDeleteDataPool returns DeleteDataPoolResponse.DeleteDataPool, and is useful for accessing the field via an interface.

type DeleteDataSourceByNameResponse

type DeleteDataSourceByNameResponse struct {
	// Deletes a Data Source by unique name and returns its ID if the Data Source was deleted successfully.
	DeleteDataSourceByName *string `json:"deleteDataSourceByName"`
}

DeleteDataSourceByNameResponse is returned by DeleteDataSourceByName on success.

func DeleteDataSourceByName

func DeleteDataSourceByName(
	ctx context.Context,
	client graphql.Client,
	uniqueName string,
) (*DeleteDataSourceByNameResponse, error)

func (*DeleteDataSourceByNameResponse) GetDeleteDataSourceByName

func (v *DeleteDataSourceByNameResponse) GetDeleteDataSourceByName() *string

GetDeleteDataSourceByName returns DeleteDataSourceByNameResponse.DeleteDataSourceByName, and is useful for accessing the field via an interface.

type DeleteDataSourceResponse

type DeleteDataSourceResponse struct {
	// Deletes a Data Source by ID and returns its ID if the Data Source was deleted successfully.
	DeleteDataSource *string `json:"deleteDataSource"`
}

DeleteDataSourceResponse is returned by DeleteDataSource on success.

func DeleteDataSource

func DeleteDataSource(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DeleteDataSourceResponse, error)

func (*DeleteDataSourceResponse) GetDeleteDataSource

func (v *DeleteDataSourceResponse) GetDeleteDataSource() *string

GetDeleteDataSource returns DeleteDataSourceResponse.DeleteDataSource, and is useful for accessing the field via an interface.

type DeleteMaterializedViewResponse added in v1.2.1

type DeleteMaterializedViewResponse struct {
	// Deletes a Materialized View and returns its ID if the Materialized View was deleted successfully.
	// Note that deleting a Materialized View does not delete its target Data Pool. If you want to delete its target
	// Data Pool, you must use the `deleteDataPool` mutation.
	DeleteMaterializedView *string `json:"deleteMaterializedView"`
}

DeleteMaterializedViewResponse is returned by DeleteMaterializedView on success.

func DeleteMaterializedView added in v1.2.1

func DeleteMaterializedView(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DeleteMaterializedViewResponse, error)

func (*DeleteMaterializedViewResponse) GetDeleteMaterializedView added in v1.2.1

func (v *DeleteMaterializedViewResponse) GetDeleteMaterializedView() *string

GetDeleteMaterializedView returns DeleteMaterializedViewResponse.DeleteMaterializedView, and is useful for accessing the field via an interface.

type DeleteMetricByNameResponse

type DeleteMetricByNameResponse struct {
	// Deletes a Metric by unique name and returns its ID if the Metric was deleted successfully.
	DeleteMetricByName *string `json:"deleteMetricByName"`
}

DeleteMetricByNameResponse is returned by DeleteMetricByName on success.

func DeleteMetricByName

func DeleteMetricByName(
	ctx context.Context,
	client graphql.Client,
	uniqueName string,
) (*DeleteMetricByNameResponse, error)

func (*DeleteMetricByNameResponse) GetDeleteMetricByName

func (v *DeleteMetricByNameResponse) GetDeleteMetricByName() *string

GetDeleteMetricByName returns DeleteMetricByNameResponse.DeleteMetricByName, and is useful for accessing the field via an interface.

type DeleteMetricResponse

type DeleteMetricResponse struct {
	// Deletes a Metric by ID and returns its ID if the Metric was deleted successfully.
	DeleteMetric *string `json:"deleteMetric"`
}

DeleteMetricResponse is returned by DeleteMetric on success.

func DeleteMetric

func DeleteMetric(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DeleteMetricResponse, error)

func (*DeleteMetricResponse) GetDeleteMetric

func (v *DeleteMetricResponse) GetDeleteMetric() *string

GetDeleteMetric returns DeleteMetricResponse.DeleteMetric, and is useful for accessing the field via an interface.

type DeletePolicyResponse added in v0.1.4

type DeletePolicyResponse struct {
	// Deletes a Policy. The associated Application will no longer have access to the Metric's data.
	DeletePolicy *string `json:"deletePolicy"`
}

DeletePolicyResponse is returned by DeletePolicy on success.

func DeletePolicy added in v0.1.4

func DeletePolicy(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*DeletePolicyResponse, error)

func (*DeletePolicyResponse) GetDeletePolicy added in v0.1.4

func (v *DeletePolicyResponse) GetDeletePolicy() *string

GetDeletePolicy returns DeletePolicyResponse.DeletePolicy, and is useful for accessing the field via an interface.

type DimensionData

type DimensionData struct {
	// The column name it represents.
	ColumnName string `json:"columnName"`
	// The column data type.
	Type string `json:"type"`
	// Whether the column is nullable.
	IsNullable *bool `json:"isNullable"`
	// Whether the column is a unique key.
	IsUniqueKey *bool `json:"isUniqueKey"`
}

DimensionData includes the GraphQL fields of Dimension requested by the fragment DimensionData. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*DimensionData) GetColumnName

func (v *DimensionData) GetColumnName() string

GetColumnName returns DimensionData.ColumnName, and is useful for accessing the field via an interface.

func (*DimensionData) GetIsNullable

func (v *DimensionData) GetIsNullable() *bool

GetIsNullable returns DimensionData.IsNullable, and is useful for accessing the field via an interface.

func (*DimensionData) GetIsUniqueKey

func (v *DimensionData) GetIsUniqueKey() *bool

GetIsUniqueKey returns DimensionData.IsUniqueKey, and is useful for accessing the field via an interface.

func (*DimensionData) GetType

func (v *DimensionData) GetType() string

GetType returns DimensionData.Type, and is useful for accessing the field via an interface.

type DimensionInput

type DimensionInput struct {
	// The name of the column to create the Dimension from.
	ColumnName string `json:"columnName"`
}

The fields for creating or modifying a Dimension.

func (*DimensionInput) GetColumnName

func (v *DimensionInput) GetColumnName() string

GetColumnName returns DimensionInput.ColumnName, and is useful for accessing the field via an interface.

type FilterData

type FilterData struct {
	// The name of the column to filter on.
	Column string `json:"column"`
	// The operation to perform when comparing the column and filter values.
	Operator FilterOperator `json:"operator"`
	// The value to compare the column to.
	Value *string `json:"value"`
	// Additional filters to AND with this one. AND takes precedence over OR.
	And []*FilterDataAndFilter `json:"and"`
	// Additional filters to OR with this one. AND takes precedence over OR.
	Or []*FilterDataOrFilter `json:"or"`
}

FilterData includes the GraphQL fields of Filter requested by the fragment FilterData. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*FilterData) GetAnd added in v1.0.1

func (v *FilterData) GetAnd() []*FilterDataAndFilter

GetAnd returns FilterData.And, and is useful for accessing the field via an interface.

func (*FilterData) GetColumn

func (v *FilterData) GetColumn() string

GetColumn returns FilterData.Column, and is useful for accessing the field via an interface.

func (*FilterData) GetOperator

func (v *FilterData) GetOperator() FilterOperator

GetOperator returns FilterData.Operator, and is useful for accessing the field via an interface.

func (*FilterData) GetOr added in v1.0.1

func (v *FilterData) GetOr() []*FilterDataOrFilter

GetOr returns FilterData.Or, and is useful for accessing the field via an interface.

func (*FilterData) GetValue

func (v *FilterData) GetValue() *string

GetValue returns FilterData.Value, and is useful for accessing the field via an interface.

type FilterDataAndFilter added in v1.0.1

type FilterDataAndFilter struct {
	// The name of the column to filter on.
	Column string `json:"column"`
	// The operation to perform when comparing the column and filter values.
	Operator FilterOperator `json:"operator"`
	// The value to compare the column to.
	Value *string `json:"value"`
}

FilterDataAndFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*FilterDataAndFilter) GetColumn added in v1.0.1

func (v *FilterDataAndFilter) GetColumn() string

GetColumn returns FilterDataAndFilter.Column, and is useful for accessing the field via an interface.

func (*FilterDataAndFilter) GetOperator added in v1.0.1

func (v *FilterDataAndFilter) GetOperator() FilterOperator

GetOperator returns FilterDataAndFilter.Operator, and is useful for accessing the field via an interface.

func (*FilterDataAndFilter) GetValue added in v1.0.1

func (v *FilterDataAndFilter) GetValue() *string

GetValue returns FilterDataAndFilter.Value, and is useful for accessing the field via an interface.

type FilterDataOrFilter added in v1.0.1

type FilterDataOrFilter struct {
	// The name of the column to filter on.
	Column string `json:"column"`
	// The operation to perform when comparing the column and filter values.
	Operator FilterOperator `json:"operator"`
	// The value to compare the column to.
	Value *string `json:"value"`
}

FilterDataOrFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*FilterDataOrFilter) GetColumn added in v1.0.1

func (v *FilterDataOrFilter) GetColumn() string

GetColumn returns FilterDataOrFilter.Column, and is useful for accessing the field via an interface.

func (*FilterDataOrFilter) GetOperator added in v1.0.1

func (v *FilterDataOrFilter) GetOperator() FilterOperator

GetOperator returns FilterDataOrFilter.Operator, and is useful for accessing the field via an interface.

func (*FilterDataOrFilter) GetValue added in v1.0.1

func (v *FilterDataOrFilter) GetValue() *string

GetValue returns FilterDataOrFilter.Value, and is useful for accessing the field via an interface.

type FilterInput

type FilterInput struct {
	// The name of the column to filter on.
	Column string `json:"column"`
	// The operation to perform when comparing the column and filter values.
	Operator FilterOperator `json:"operator"`
	// The value to compare the column to.
	Value *string `json:"value"`
	// Additional filters to AND with this one. AND takes precedence over OR.
	And []*FilterInput `json:"and,omitempty"`
	// Additional filters to OR with this one. AND takes precedence over OR.
	Or []*FilterInput `json:"or,omitempty"`
}

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*FilterInput) GetAnd added in v0.1.3

func (v *FilterInput) GetAnd() []*FilterInput

GetAnd returns FilterInput.And, and is useful for accessing the field via an interface.

func (*FilterInput) GetColumn

func (v *FilterInput) GetColumn() string

GetColumn returns FilterInput.Column, and is useful for accessing the field via an interface.

func (*FilterInput) GetOperator

func (v *FilterInput) GetOperator() FilterOperator

GetOperator returns FilterInput.Operator, and is useful for accessing the field via an interface.

func (*FilterInput) GetOr added in v0.1.3

func (v *FilterInput) GetOr() []*FilterInput

GetOr returns FilterInput.Or, and is useful for accessing the field via an interface.

func (*FilterInput) GetValue

func (v *FilterInput) GetValue() *string

GetValue returns FilterInput.Value, and is useful for accessing the field via an interface.

type FilterOperator

type FilterOperator string

The available Filter operators.

const (
	// Selects values that are equal to the specified value.
	FilterOperatorEquals FilterOperator = "EQUALS"
	// Selects values that are not equal to the specified value.
	FilterOperatorNotEquals FilterOperator = "NOT_EQUALS"
	// Selects values that are greater than the specified value.
	FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"
	// Selects values that are greater or equal to the specified value.
	FilterOperatorGreaterThanOrEqualTo FilterOperator = "GREATER_THAN_OR_EQUAL_TO"
	// Selects values that are less than the specified value.
	FilterOperatorLessThan FilterOperator = "LESS_THAN"
	// Selects values that are less or equal to the specified value.
	FilterOperatorLessThanOrEqualTo FilterOperator = "LESS_THAN_OR_EQUAL_TO"
	// Selects values that are null. This operator does not accept a value.
	FilterOperatorIsNull FilterOperator = "IS_NULL"
	// Selects values that are not null. This operator does not accept a value.
	FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"
	// Selects values that match the specified pattern.
	FilterOperatorLike FilterOperator = "LIKE"
	// "Selects values that do not match the specified pattern.
	FilterOperatorNotLike FilterOperator = "NOT_LIKE"
)

type GqlError

type GqlError struct {
	// The error code.
	Code *int `json:"code"`
	// The error message.
	Message string `json:"message"`
}

GqlError includes the GraphQL fields of Error requested by the fragment GqlError. The GraphQL type's documentation follows.

The error object.

func (*GqlError) GetCode

func (v *GqlError) GetCode() *int

GetCode returns GqlError.Code, and is useful for accessing the field via an interface.

func (*GqlError) GetMessage

func (v *GqlError) GetMessage() string

GetMessage returns GqlError.Message, and is useful for accessing the field via an interface.

type HttpBasicAuthInput

type HttpBasicAuthInput struct {
	// The username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.
	Username string `json:"username"`
	// The password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.
	Password string `json:"password"`
}

The fields for specifying an HTTP Data Source's Basic authentication settings.

func (*HttpBasicAuthInput) GetPassword

func (v *HttpBasicAuthInput) GetPassword() string

GetPassword returns HttpBasicAuthInput.Password, and is useful for accessing the field via an interface.

func (*HttpBasicAuthInput) GetUsername

func (v *HttpBasicAuthInput) GetUsername() string

GetUsername returns HttpBasicAuthInput.Username, and is useful for accessing the field via an interface.

type HttpConnectionSettingsInput

type HttpConnectionSettingsInput struct {
	// The HTTP Basic authentication settings for uploading new data.
	//
	// If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it's OK to test without HTTP Basic authentication, we recommend enabling it.
	BasicAuth *HttpBasicAuthInput `json:"basicAuth,omitempty"`
	// The HTTP Data Source's tables.
	Tables []*HttpDataSourceTableInput `json:"tables,omitempty"`
}

The HTTP Data Source connection settings.

func (*HttpConnectionSettingsInput) GetBasicAuth

GetBasicAuth returns HttpConnectionSettingsInput.BasicAuth, and is useful for accessing the field via an interface.

func (*HttpConnectionSettingsInput) GetTables

GetTables returns HttpConnectionSettingsInput.Tables, and is useful for accessing the field via an interface.

type HttpDataSourceColumnInput

type HttpDataSourceColumnInput struct {
	// The column name. It has to be unique within a Table.
	Name string `json:"name"`
	// The column type.
	Type ColumnType `json:"type"`
	// The ClickHouse type to use when `type` is set to `CLICKHOUSE`.
	ClickHouseType *string `json:"clickHouseType"`
	// Whether the column's type is nullable or not.
	Nullable bool `json:"nullable"`
}

The fields for specifying a column in an HTTP Data Source's table.

func (*HttpDataSourceColumnInput) GetClickHouseType added in v1.2.1

func (v *HttpDataSourceColumnInput) GetClickHouseType() *string

GetClickHouseType returns HttpDataSourceColumnInput.ClickHouseType, and is useful for accessing the field via an interface.

func (*HttpDataSourceColumnInput) GetName

func (v *HttpDataSourceColumnInput) GetName() string

GetName returns HttpDataSourceColumnInput.Name, and is useful for accessing the field via an interface.

func (*HttpDataSourceColumnInput) GetNullable

func (v *HttpDataSourceColumnInput) GetNullable() bool

GetNullable returns HttpDataSourceColumnInput.Nullable, and is useful for accessing the field via an interface.

func (*HttpDataSourceColumnInput) GetType

GetType returns HttpDataSourceColumnInput.Type, and is useful for accessing the field via an interface.

type HttpDataSourceTableInput

type HttpDataSourceTableInput struct {
	// The name of the table
	Name string `json:"name"`
	// All the columns present in the table
	Columns []*HttpDataSourceColumnInput `json:"columns,omitempty"`
}

The fields for specifying an HTTP Data Source's table.

func (*HttpDataSourceTableInput) GetColumns

GetColumns returns HttpDataSourceTableInput.Columns, and is useful for accessing the field via an interface.

func (*HttpDataSourceTableInput) GetName

func (v *HttpDataSourceTableInput) GetName() string

GetName returns HttpDataSourceTableInput.Name, and is useful for accessing the field via an interface.

type IdOrUniqueName

type IdOrUniqueName struct {
	// The unique identifier of the object.
	Id *string `json:"id"`
	// The unique name of the object.
	UniqueName *string `json:"uniqueName"`
}

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

func (*IdOrUniqueName) GetId

func (v *IdOrUniqueName) GetId() *string

GetId returns IdOrUniqueName.Id, and is useful for accessing the field via an interface.

func (*IdOrUniqueName) GetUniqueName

func (v *IdOrUniqueName) GetUniqueName() *string

GetUniqueName returns IdOrUniqueName.UniqueName, and is useful for accessing the field via an interface.

type JobStatus added in v1.1.0

type JobStatus string
const (
	// The Job was created, but is not yet being executed.
	JobStatusCreated JobStatus = "CREATED"
	// The Job is executing.
	JobStatusInProgress JobStatus = "IN_PROGRESS"
	// The Job succeeded.
	JobStatusSucceeded JobStatus = "SUCCEEDED"
	// The Job failed. Check the error message.
	JobStatusFailed JobStatus = "FAILED"
)

type MaterializedViewData added in v1.2.1

type MaterializedViewData struct {
	// The Materialized View's unique identifier.
	Id                         string `json:"id"`
	CommonDataMaterializedView `json:"-"`
	// The SQL that the Materialized View executes.
	Sql string `json:"sql"`
	// The Materialized View's destination (AKA "target") Data Pool.
	Destination *MaterializedViewDataDestinationDataPool `json:"destination"`
	// The Materialized View's source Data Pool.
	Source *MaterializedViewDataSourceDataPool `json:"source"`
	// Other Data Pools queried by the Materialized View.
	Others []*MaterializedViewDataOthersDataPool `json:"others"`
}

MaterializedViewData includes the GraphQL fields of MaterializedView requested by the fragment MaterializedViewData.

func (*MaterializedViewData) GetAccount added in v1.2.1

func (v *MaterializedViewData) GetAccount() *CommonDataAccount

GetAccount returns MaterializedViewData.Account, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetCreatedAt added in v1.2.1

func (v *MaterializedViewData) GetCreatedAt() time.Time

GetCreatedAt returns MaterializedViewData.CreatedAt, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetCreatedBy added in v1.2.1

func (v *MaterializedViewData) GetCreatedBy() string

GetCreatedBy returns MaterializedViewData.CreatedBy, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetDescription added in v1.2.1

func (v *MaterializedViewData) GetDescription() string

GetDescription returns MaterializedViewData.Description, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetDestination added in v1.2.1

GetDestination returns MaterializedViewData.Destination, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetEnvironment added in v1.2.1

func (v *MaterializedViewData) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns MaterializedViewData.Environment, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetId added in v1.2.1

func (v *MaterializedViewData) GetId() string

GetId returns MaterializedViewData.Id, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetModifiedAt added in v1.2.1

func (v *MaterializedViewData) GetModifiedAt() time.Time

GetModifiedAt returns MaterializedViewData.ModifiedAt, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetModifiedBy added in v1.2.1

func (v *MaterializedViewData) GetModifiedBy() string

GetModifiedBy returns MaterializedViewData.ModifiedBy, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetOthers added in v1.2.1

GetOthers returns MaterializedViewData.Others, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetSource added in v1.2.1

GetSource returns MaterializedViewData.Source, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetSql added in v1.2.1

func (v *MaterializedViewData) GetSql() string

GetSql returns MaterializedViewData.Sql, and is useful for accessing the field via an interface.

func (*MaterializedViewData) GetUniqueName added in v1.2.1

func (v *MaterializedViewData) GetUniqueName() string

GetUniqueName returns MaterializedViewData.UniqueName, and is useful for accessing the field via an interface.

func (*MaterializedViewData) MarshalJSON added in v1.2.1

func (v *MaterializedViewData) MarshalJSON() ([]byte, error)

func (*MaterializedViewData) UnmarshalJSON added in v1.2.1

func (v *MaterializedViewData) UnmarshalJSON(b []byte) error

type MaterializedViewDataDestinationDataPool added in v1.2.1

type MaterializedViewDataDestinationDataPool struct {
	// The Data Pool's unique identifier.
	Id string `json:"id"`
}

MaterializedViewDataDestinationDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*MaterializedViewDataDestinationDataPool) GetId added in v1.2.1

GetId returns MaterializedViewDataDestinationDataPool.Id, and is useful for accessing the field via an interface.

type MaterializedViewDataOthersDataPool added in v1.2.1

type MaterializedViewDataOthersDataPool struct {
	// The Data Pool's unique identifier.
	Id string `json:"id"`
}

MaterializedViewDataOthersDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*MaterializedViewDataOthersDataPool) GetId added in v1.2.1

GetId returns MaterializedViewDataOthersDataPool.Id, and is useful for accessing the field via an interface.

type MaterializedViewDataSourceDataPool added in v1.2.1

type MaterializedViewDataSourceDataPool struct {
	// The Data Pool's unique identifier.
	Id string `json:"id"`
}

MaterializedViewDataSourceDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*MaterializedViewDataSourceDataPool) GetId added in v1.2.1

GetId returns MaterializedViewDataSourceDataPool.Id, and is useful for accessing the field via an interface.

type MaterializedViewMaterializedView added in v1.2.1

type MaterializedViewMaterializedView struct {
	MaterializedViewData `json:"-"`
}

MaterializedViewMaterializedView includes the requested fields of the GraphQL type MaterializedView.

func (*MaterializedViewMaterializedView) GetAccount added in v1.2.1

GetAccount returns MaterializedViewMaterializedView.Account, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetCreatedAt added in v1.2.1

func (v *MaterializedViewMaterializedView) GetCreatedAt() time.Time

GetCreatedAt returns MaterializedViewMaterializedView.CreatedAt, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetCreatedBy added in v1.2.1

func (v *MaterializedViewMaterializedView) GetCreatedBy() string

GetCreatedBy returns MaterializedViewMaterializedView.CreatedBy, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetDescription added in v1.2.1

func (v *MaterializedViewMaterializedView) GetDescription() string

GetDescription returns MaterializedViewMaterializedView.Description, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetDestination added in v1.2.1

GetDestination returns MaterializedViewMaterializedView.Destination, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetEnvironment added in v1.2.1

GetEnvironment returns MaterializedViewMaterializedView.Environment, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetId added in v1.2.1

GetId returns MaterializedViewMaterializedView.Id, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetModifiedAt added in v1.2.1

func (v *MaterializedViewMaterializedView) GetModifiedAt() time.Time

GetModifiedAt returns MaterializedViewMaterializedView.ModifiedAt, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetModifiedBy added in v1.2.1

func (v *MaterializedViewMaterializedView) GetModifiedBy() string

GetModifiedBy returns MaterializedViewMaterializedView.ModifiedBy, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetOthers added in v1.2.1

GetOthers returns MaterializedViewMaterializedView.Others, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetSource added in v1.2.1

GetSource returns MaterializedViewMaterializedView.Source, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetSql added in v1.2.1

GetSql returns MaterializedViewMaterializedView.Sql, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) GetUniqueName added in v1.2.1

func (v *MaterializedViewMaterializedView) GetUniqueName() string

GetUniqueName returns MaterializedViewMaterializedView.UniqueName, and is useful for accessing the field via an interface.

func (*MaterializedViewMaterializedView) MarshalJSON added in v1.2.1

func (v *MaterializedViewMaterializedView) MarshalJSON() ([]byte, error)

func (*MaterializedViewMaterializedView) UnmarshalJSON added in v1.2.1

func (v *MaterializedViewMaterializedView) UnmarshalJSON(b []byte) error

type MaterializedViewResponse added in v1.2.1

type MaterializedViewResponse struct {
	// This query returns the Materialized View specified by the given ID.
	MaterializedView *MaterializedViewMaterializedView `json:"materializedView"`
}

MaterializedViewResponse is returned by MaterializedView on success.

func MaterializedView added in v1.2.1

func MaterializedView(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*MaterializedViewResponse, error)

func (*MaterializedViewResponse) GetMaterializedView added in v1.2.1

GetMaterializedView returns MaterializedViewResponse.MaterializedView, and is useful for accessing the field via an interface.

type MergeTreeTableEngineInput added in v1.2.1

type MergeTreeTableEngineInput struct {
	// The type is always `MERGE_TREE`.
	Type *TableEngineType `json:"type"`
}

Parameters for the MergeTree table engine.

func (*MergeTreeTableEngineInput) GetType added in v1.2.1

GetType returns MergeTreeTableEngineInput.Type, and is useful for accessing the field via an interface.

type MetricByNameMetric

type MetricByNameMetric struct {
	MetricData `json:"-"`
}

MetricByNameMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*MetricByNameMetric) GetAccessControlEnabled added in v0.1.4

func (v *MetricByNameMetric) GetAccessControlEnabled() bool

GetAccessControlEnabled returns MetricByNameMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetAccount

func (v *MetricByNameMetric) GetAccount() *CommonDataAccount

GetAccount returns MetricByNameMetric.Account, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetCreatedAt

func (v *MetricByNameMetric) GetCreatedAt() time.Time

GetCreatedAt returns MetricByNameMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetCreatedBy

func (v *MetricByNameMetric) GetCreatedBy() string

GetCreatedBy returns MetricByNameMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetDataPool

func (v *MetricByNameMetric) GetDataPool() *MetricDataDataPool

GetDataPool returns MetricByNameMetric.DataPool, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetDescription

func (v *MetricByNameMetric) GetDescription() string

GetDescription returns MetricByNameMetric.Description, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetDimensions

func (v *MetricByNameMetric) GetDimensions() []*MetricDataDimensionsDimension

GetDimensions returns MetricByNameMetric.Dimensions, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetEnvironment

func (v *MetricByNameMetric) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns MetricByNameMetric.Environment, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetId

func (v *MetricByNameMetric) GetId() string

GetId returns MetricByNameMetric.Id, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetMeasure

GetMeasure returns MetricByNameMetric.Measure, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetModifiedAt

func (v *MetricByNameMetric) GetModifiedAt() time.Time

GetModifiedAt returns MetricByNameMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetModifiedBy

func (v *MetricByNameMetric) GetModifiedBy() string

GetModifiedBy returns MetricByNameMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetSettings

GetSettings returns MetricByNameMetric.Settings, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetTimestamp

GetTimestamp returns MetricByNameMetric.Timestamp, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetType

func (v *MetricByNameMetric) GetType() MetricType

GetType returns MetricByNameMetric.Type, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) GetUniqueName

func (v *MetricByNameMetric) GetUniqueName() string

GetUniqueName returns MetricByNameMetric.UniqueName, and is useful for accessing the field via an interface.

func (*MetricByNameMetric) MarshalJSON

func (v *MetricByNameMetric) MarshalJSON() ([]byte, error)

func (*MetricByNameMetric) UnmarshalJSON

func (v *MetricByNameMetric) UnmarshalJSON(b []byte) error

type MetricByNameResponse

type MetricByNameResponse struct {
	// This query returns the Metric specified by the given unique name.
	//
	// A Metric is a business indicator measured over time.
	Metric *MetricByNameMetric `json:"metric"`
}

MetricByNameResponse is returned by MetricByName on success.

func MetricByName

func MetricByName(
	ctx context.Context,
	client graphql.Client,
	uniqueName string,
) (*MetricByNameResponse, error)

func (*MetricByNameResponse) GetMetric

func (v *MetricByNameResponse) GetMetric() *MetricByNameMetric

GetMetric returns MetricByNameResponse.Metric, and is useful for accessing the field via an interface.

type MetricData

type MetricData struct {
	CommonDataMetric `json:"-"`
	// The Metric's unique identifier.
	Id string `json:"id"`
	// The Metric's type. The different Metric types determine how the values are calculated.
	Type MetricType `json:"type"`
	// Whether or not access control is enabled for the Metric.
	AccessControlEnabled bool `json:"accessControlEnabled"`
	// The Data Pool that powers this Metric.
	DataPool *MetricDataDataPool `json:"dataPool"`
	// The Metric's Dimensions. These Dimensions are available to Query Filters.
	Dimensions []*MetricDataDimensionsDimension `json:"dimensions"`
	// The Metric's timestamp, if any. This is the same as its Data Pool's timestamp, if any.
	Timestamp *MetricDataTimestampDimension `json:"timestamp"`
	// The Metric's measure. Access this from the Metric's `settings` object instead.
	Measure *MetricDataMeasureDimension `json:"measure"`
	// The settings for the Metric. The settings are specific to the Metric's type.
	Settings MetricDataSettingsMetricSettings `json:"-"`
}

MetricData includes the GraphQL fields of Metric requested by the fragment MetricData. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*MetricData) GetAccessControlEnabled added in v0.1.4

func (v *MetricData) GetAccessControlEnabled() bool

GetAccessControlEnabled returns MetricData.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*MetricData) GetAccount

func (v *MetricData) GetAccount() *CommonDataAccount

GetAccount returns MetricData.Account, and is useful for accessing the field via an interface.

func (*MetricData) GetCreatedAt

func (v *MetricData) GetCreatedAt() time.Time

GetCreatedAt returns MetricData.CreatedAt, and is useful for accessing the field via an interface.

func (*MetricData) GetCreatedBy

func (v *MetricData) GetCreatedBy() string

GetCreatedBy returns MetricData.CreatedBy, and is useful for accessing the field via an interface.

func (*MetricData) GetDataPool

func (v *MetricData) GetDataPool() *MetricDataDataPool

GetDataPool returns MetricData.DataPool, and is useful for accessing the field via an interface.

func (*MetricData) GetDescription

func (v *MetricData) GetDescription() string

GetDescription returns MetricData.Description, and is useful for accessing the field via an interface.

func (*MetricData) GetDimensions

func (v *MetricData) GetDimensions() []*MetricDataDimensionsDimension

GetDimensions returns MetricData.Dimensions, and is useful for accessing the field via an interface.

func (*MetricData) GetEnvironment

func (v *MetricData) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns MetricData.Environment, and is useful for accessing the field via an interface.

func (*MetricData) GetId

func (v *MetricData) GetId() string

GetId returns MetricData.Id, and is useful for accessing the field via an interface.

func (*MetricData) GetMeasure

func (v *MetricData) GetMeasure() *MetricDataMeasureDimension

GetMeasure returns MetricData.Measure, and is useful for accessing the field via an interface.

func (*MetricData) GetModifiedAt

func (v *MetricData) GetModifiedAt() time.Time

GetModifiedAt returns MetricData.ModifiedAt, and is useful for accessing the field via an interface.

func (*MetricData) GetModifiedBy

func (v *MetricData) GetModifiedBy() string

GetModifiedBy returns MetricData.ModifiedBy, and is useful for accessing the field via an interface.

func (*MetricData) GetSettings

GetSettings returns MetricData.Settings, and is useful for accessing the field via an interface.

func (*MetricData) GetTimestamp

func (v *MetricData) GetTimestamp() *MetricDataTimestampDimension

GetTimestamp returns MetricData.Timestamp, and is useful for accessing the field via an interface.

func (*MetricData) GetType

func (v *MetricData) GetType() MetricType

GetType returns MetricData.Type, and is useful for accessing the field via an interface.

func (*MetricData) GetUniqueName

func (v *MetricData) GetUniqueName() string

GetUniqueName returns MetricData.UniqueName, and is useful for accessing the field via an interface.

func (*MetricData) MarshalJSON

func (v *MetricData) MarshalJSON() ([]byte, error)

func (*MetricData) UnmarshalJSON

func (v *MetricData) UnmarshalJSON(b []byte) error

type MetricDataDataPool

type MetricDataDataPool struct {
	DataPoolData `json:"-"`
}

MetricDataDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*MetricDataDataPool) GetAccessControlEnabled added in v1.1.0

func (v *MetricDataDataPool) GetAccessControlEnabled() bool

GetAccessControlEnabled returns MetricDataDataPool.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetAccount

func (v *MetricDataDataPool) GetAccount() *CommonDataAccount

GetAccount returns MetricDataDataPool.Account, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetAvailableMeasures

GetAvailableMeasures returns MetricDataDataPool.AvailableMeasures, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetColumns

GetColumns returns MetricDataDataPool.Columns, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetCreatedAt

func (v *MetricDataDataPool) GetCreatedAt() time.Time

GetCreatedAt returns MetricDataDataPool.CreatedAt, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetCreatedBy

func (v *MetricDataDataPool) GetCreatedBy() string

GetCreatedBy returns MetricDataDataPool.CreatedBy, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetDataPoolAccessPolicies added in v1.1.0

GetDataPoolAccessPolicies returns MetricDataDataPool.DataPoolAccessPolicies, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetDataSource

func (v *MetricDataDataPool) GetDataSource() *DataPoolDataDataSource

GetDataSource returns MetricDataDataPool.DataSource, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetDescription

func (v *MetricDataDataPool) GetDescription() string

GetDescription returns MetricDataDataPool.Description, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetEnvironment

func (v *MetricDataDataPool) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns MetricDataDataPool.Environment, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetError

func (v *MetricDataDataPool) GetError() *DataPoolDataError

GetError returns MetricDataDataPool.Error, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetId

func (v *MetricDataDataPool) GetId() string

GetId returns MetricDataDataPool.Id, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetModifiedAt

func (v *MetricDataDataPool) GetModifiedAt() time.Time

GetModifiedAt returns MetricDataDataPool.ModifiedAt, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetModifiedBy

func (v *MetricDataDataPool) GetModifiedBy() string

GetModifiedBy returns MetricDataDataPool.ModifiedBy, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetSetupTasks

GetSetupTasks returns MetricDataDataPool.SetupTasks, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetStatus

func (v *MetricDataDataPool) GetStatus() DataPoolStatus

GetStatus returns MetricDataDataPool.Status, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetSyncing added in v0.1.3

GetSyncing returns MetricDataDataPool.Syncing, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetSyncs

GetSyncs returns MetricDataDataPool.Syncs, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetTable

func (v *MetricDataDataPool) GetTable() string

GetTable returns MetricDataDataPool.Table, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetTenant added in v1.2.1

func (v *MetricDataDataPool) GetTenant() *DataPoolDataTenant

GetTenant returns MetricDataDataPool.Tenant, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetTimestamp

func (v *MetricDataDataPool) GetTimestamp() *DataPoolDataTimestamp

GetTimestamp returns MetricDataDataPool.Timestamp, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetUniqueId added in v1.0.0

func (v *MetricDataDataPool) GetUniqueId() *DataPoolDataUniqueId

GetUniqueId returns MetricDataDataPool.UniqueId, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) GetUniqueName

func (v *MetricDataDataPool) GetUniqueName() string

GetUniqueName returns MetricDataDataPool.UniqueName, and is useful for accessing the field via an interface.

func (*MetricDataDataPool) MarshalJSON

func (v *MetricDataDataPool) MarshalJSON() ([]byte, error)

func (*MetricDataDataPool) UnmarshalJSON

func (v *MetricDataDataPool) UnmarshalJSON(b []byte) error

type MetricDataDimensionsDimension

type MetricDataDimensionsDimension struct {
	DimensionData `json:"-"`
}

MetricDataDimensionsDimension includes the requested fields of the GraphQL type Dimension. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*MetricDataDimensionsDimension) GetColumnName

func (v *MetricDataDimensionsDimension) GetColumnName() string

GetColumnName returns MetricDataDimensionsDimension.ColumnName, and is useful for accessing the field via an interface.

func (*MetricDataDimensionsDimension) GetIsNullable

func (v *MetricDataDimensionsDimension) GetIsNullable() *bool

GetIsNullable returns MetricDataDimensionsDimension.IsNullable, and is useful for accessing the field via an interface.

func (*MetricDataDimensionsDimension) GetIsUniqueKey

func (v *MetricDataDimensionsDimension) GetIsUniqueKey() *bool

GetIsUniqueKey returns MetricDataDimensionsDimension.IsUniqueKey, and is useful for accessing the field via an interface.

func (*MetricDataDimensionsDimension) GetType

GetType returns MetricDataDimensionsDimension.Type, and is useful for accessing the field via an interface.

func (*MetricDataDimensionsDimension) MarshalJSON

func (v *MetricDataDimensionsDimension) MarshalJSON() ([]byte, error)

func (*MetricDataDimensionsDimension) UnmarshalJSON

func (v *MetricDataDimensionsDimension) UnmarshalJSON(b []byte) error

type MetricDataMeasureDimension

type MetricDataMeasureDimension struct {
	DimensionData `json:"-"`
}

MetricDataMeasureDimension includes the requested fields of the GraphQL type Dimension. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*MetricDataMeasureDimension) GetColumnName

func (v *MetricDataMeasureDimension) GetColumnName() string

GetColumnName returns MetricDataMeasureDimension.ColumnName, and is useful for accessing the field via an interface.

func (*MetricDataMeasureDimension) GetIsNullable

func (v *MetricDataMeasureDimension) GetIsNullable() *bool

GetIsNullable returns MetricDataMeasureDimension.IsNullable, and is useful for accessing the field via an interface.

func (*MetricDataMeasureDimension) GetIsUniqueKey

func (v *MetricDataMeasureDimension) GetIsUniqueKey() *bool

GetIsUniqueKey returns MetricDataMeasureDimension.IsUniqueKey, and is useful for accessing the field via an interface.

func (*MetricDataMeasureDimension) GetType

func (v *MetricDataMeasureDimension) GetType() string

GetType returns MetricDataMeasureDimension.Type, and is useful for accessing the field via an interface.

func (*MetricDataMeasureDimension) MarshalJSON

func (v *MetricDataMeasureDimension) MarshalJSON() ([]byte, error)

func (*MetricDataMeasureDimension) UnmarshalJSON

func (v *MetricDataMeasureDimension) UnmarshalJSON(b []byte) error

type MetricDataSettingsAverageMetricSettings

type MetricDataSettingsAverageMetricSettings struct {
	Typename *string `json:"__typename"`
	// Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the `filters` property on the `timeSeriesInput`, `counterInput`, or `leaderboardInput` objects. There is no need to add `filters` to be able to filter at query time.
	Filters []*MetricDataSettingsAverageMetricSettingsFiltersFilter `json:"filters"`
	// The Dimension to be averaged.
	Measure *MetricDataSettingsAverageMetricSettingsMeasureDimension `json:"measure"`
}

MetricDataSettingsAverageMetricSettings includes the requested fields of the GraphQL type AverageMetricSettings. The GraphQL type's documentation follows.

Settings for Average Metrics.

func (*MetricDataSettingsAverageMetricSettings) GetFilters added in v0.1.4

GetFilters returns MetricDataSettingsAverageMetricSettings.Filters, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettings) GetMeasure added in v0.1.4

GetMeasure returns MetricDataSettingsAverageMetricSettings.Measure, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettings) GetTypename

GetTypename returns MetricDataSettingsAverageMetricSettings.Typename, and is useful for accessing the field via an interface.

type MetricDataSettingsAverageMetricSettingsFiltersFilter added in v0.1.4

type MetricDataSettingsAverageMetricSettingsFiltersFilter struct {
	FilterData `json:"-"`
}

MetricDataSettingsAverageMetricSettingsFiltersFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*MetricDataSettingsAverageMetricSettingsFiltersFilter) GetAnd added in v1.0.1

GetAnd returns MetricDataSettingsAverageMetricSettingsFiltersFilter.And, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsFiltersFilter) GetColumn added in v0.1.4

GetColumn returns MetricDataSettingsAverageMetricSettingsFiltersFilter.Column, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsFiltersFilter) GetOperator added in v0.1.4

GetOperator returns MetricDataSettingsAverageMetricSettingsFiltersFilter.Operator, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsFiltersFilter) GetOr added in v1.0.1

GetOr returns MetricDataSettingsAverageMetricSettingsFiltersFilter.Or, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsFiltersFilter) GetValue added in v0.1.4

GetValue returns MetricDataSettingsAverageMetricSettingsFiltersFilter.Value, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsFiltersFilter) MarshalJSON added in v0.1.4

func (*MetricDataSettingsAverageMetricSettingsFiltersFilter) UnmarshalJSON added in v0.1.4

type MetricDataSettingsAverageMetricSettingsMeasureDimension added in v0.1.4

type MetricDataSettingsAverageMetricSettingsMeasureDimension struct {
	DimensionData `json:"-"`
}

MetricDataSettingsAverageMetricSettingsMeasureDimension includes the requested fields of the GraphQL type Dimension. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*MetricDataSettingsAverageMetricSettingsMeasureDimension) GetColumnName added in v0.1.4

GetColumnName returns MetricDataSettingsAverageMetricSettingsMeasureDimension.ColumnName, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsMeasureDimension) GetIsNullable added in v0.1.4

GetIsNullable returns MetricDataSettingsAverageMetricSettingsMeasureDimension.IsNullable, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsMeasureDimension) GetIsUniqueKey added in v0.1.4

GetIsUniqueKey returns MetricDataSettingsAverageMetricSettingsMeasureDimension.IsUniqueKey, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsMeasureDimension) GetType added in v0.1.4

GetType returns MetricDataSettingsAverageMetricSettingsMeasureDimension.Type, and is useful for accessing the field via an interface.

func (*MetricDataSettingsAverageMetricSettingsMeasureDimension) MarshalJSON added in v0.1.4

func (*MetricDataSettingsAverageMetricSettingsMeasureDimension) UnmarshalJSON added in v0.1.4

type MetricDataSettingsCountDistinctMetricSettings

type MetricDataSettingsCountDistinctMetricSettings struct {
	Typename *string `json:"__typename"`
	// Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the `filters` property on the `timeSeriesInput`, `counterInput`, or `leaderboardInput` objects. There is no need to add `filters` to be able to filter at query time.
	Filters []*MetricDataSettingsCountDistinctMetricSettingsFiltersFilter `json:"filters"`
	// The Dimension where the count distinct operation is going to be performed.
	Dimension *MetricDataSettingsCountDistinctMetricSettingsDimension `json:"dimension"`
}

MetricDataSettingsCountDistinctMetricSettings includes the requested fields of the GraphQL type CountDistinctMetricSettings. The GraphQL type's documentation follows.

Settings for Count Distinct Metrics.

func (*MetricDataSettingsCountDistinctMetricSettings) GetDimension

GetDimension returns MetricDataSettingsCountDistinctMetricSettings.Dimension, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettings) GetFilters

GetFilters returns MetricDataSettingsCountDistinctMetricSettings.Filters, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettings) GetTypename

GetTypename returns MetricDataSettingsCountDistinctMetricSettings.Typename, and is useful for accessing the field via an interface.

type MetricDataSettingsCountDistinctMetricSettingsDimension

type MetricDataSettingsCountDistinctMetricSettingsDimension struct {
	DimensionData `json:"-"`
}

MetricDataSettingsCountDistinctMetricSettingsDimension includes the requested fields of the GraphQL type Dimension. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*MetricDataSettingsCountDistinctMetricSettingsDimension) GetColumnName

GetColumnName returns MetricDataSettingsCountDistinctMetricSettingsDimension.ColumnName, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsDimension) GetIsNullable

GetIsNullable returns MetricDataSettingsCountDistinctMetricSettingsDimension.IsNullable, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsDimension) GetIsUniqueKey

GetIsUniqueKey returns MetricDataSettingsCountDistinctMetricSettingsDimension.IsUniqueKey, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsDimension) GetType

GetType returns MetricDataSettingsCountDistinctMetricSettingsDimension.Type, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsDimension) MarshalJSON

func (*MetricDataSettingsCountDistinctMetricSettingsDimension) UnmarshalJSON

type MetricDataSettingsCountDistinctMetricSettingsFiltersFilter

type MetricDataSettingsCountDistinctMetricSettingsFiltersFilter struct {
	FilterData `json:"-"`
}

MetricDataSettingsCountDistinctMetricSettingsFiltersFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*MetricDataSettingsCountDistinctMetricSettingsFiltersFilter) GetAnd added in v1.0.1

GetAnd returns MetricDataSettingsCountDistinctMetricSettingsFiltersFilter.And, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsFiltersFilter) GetColumn

GetColumn returns MetricDataSettingsCountDistinctMetricSettingsFiltersFilter.Column, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsFiltersFilter) GetOperator

GetOperator returns MetricDataSettingsCountDistinctMetricSettingsFiltersFilter.Operator, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsFiltersFilter) GetOr added in v1.0.1

GetOr returns MetricDataSettingsCountDistinctMetricSettingsFiltersFilter.Or, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsFiltersFilter) GetValue

GetValue returns MetricDataSettingsCountDistinctMetricSettingsFiltersFilter.Value, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountDistinctMetricSettingsFiltersFilter) MarshalJSON

func (*MetricDataSettingsCountDistinctMetricSettingsFiltersFilter) UnmarshalJSON

type MetricDataSettingsCountMetricSettings

type MetricDataSettingsCountMetricSettings struct {
	Typename *string `json:"__typename"`
	// Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the `filters` property on the `timeSeriesInput`, `counterInput`, or `leaderboardInput` objects. There is no need to add `filters` to be able to filter at query time.
	Filters []*MetricDataSettingsCountMetricSettingsFiltersFilter `json:"filters"`
}

MetricDataSettingsCountMetricSettings includes the requested fields of the GraphQL type CountMetricSettings. The GraphQL type's documentation follows.

Settings for Count Metrics.

func (*MetricDataSettingsCountMetricSettings) GetFilters

GetFilters returns MetricDataSettingsCountMetricSettings.Filters, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountMetricSettings) GetTypename

GetTypename returns MetricDataSettingsCountMetricSettings.Typename, and is useful for accessing the field via an interface.

type MetricDataSettingsCountMetricSettingsFiltersFilter

type MetricDataSettingsCountMetricSettingsFiltersFilter struct {
	FilterData `json:"-"`
}

MetricDataSettingsCountMetricSettingsFiltersFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*MetricDataSettingsCountMetricSettingsFiltersFilter) GetAnd added in v1.0.1

GetAnd returns MetricDataSettingsCountMetricSettingsFiltersFilter.And, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountMetricSettingsFiltersFilter) GetColumn

GetColumn returns MetricDataSettingsCountMetricSettingsFiltersFilter.Column, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountMetricSettingsFiltersFilter) GetOperator

GetOperator returns MetricDataSettingsCountMetricSettingsFiltersFilter.Operator, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountMetricSettingsFiltersFilter) GetOr added in v1.0.1

GetOr returns MetricDataSettingsCountMetricSettingsFiltersFilter.Or, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountMetricSettingsFiltersFilter) GetValue

GetValue returns MetricDataSettingsCountMetricSettingsFiltersFilter.Value, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCountMetricSettingsFiltersFilter) MarshalJSON

func (*MetricDataSettingsCountMetricSettingsFiltersFilter) UnmarshalJSON

type MetricDataSettingsCustomMetricSettings added in v0.1.6

type MetricDataSettingsCustomMetricSettings struct {
	Typename *string `json:"__typename"`
	// Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the `filters` property on the `timeSeriesInput`, `counterInput`, or `leaderboardInput` objects. There is no need to add `filters` to be able to filter at query time.
	Filters []*MetricDataSettingsCustomMetricSettingsFiltersFilter `json:"filters"`
	// The expression that defines the aggregation function for this Metric.
	Expression string `json:"expression"`
}

MetricDataSettingsCustomMetricSettings includes the requested fields of the GraphQL type CustomMetricSettings. The GraphQL type's documentation follows.

Settings for Custom Metrics.

func (*MetricDataSettingsCustomMetricSettings) GetExpression added in v0.1.6

GetExpression returns MetricDataSettingsCustomMetricSettings.Expression, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCustomMetricSettings) GetFilters added in v0.1.6

GetFilters returns MetricDataSettingsCustomMetricSettings.Filters, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCustomMetricSettings) GetTypename added in v0.1.6

GetTypename returns MetricDataSettingsCustomMetricSettings.Typename, and is useful for accessing the field via an interface.

type MetricDataSettingsCustomMetricSettingsFiltersFilter added in v0.1.6

type MetricDataSettingsCustomMetricSettingsFiltersFilter struct {
	FilterData `json:"-"`
}

MetricDataSettingsCustomMetricSettingsFiltersFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*MetricDataSettingsCustomMetricSettingsFiltersFilter) GetAnd added in v1.0.1

GetAnd returns MetricDataSettingsCustomMetricSettingsFiltersFilter.And, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCustomMetricSettingsFiltersFilter) GetColumn added in v0.1.6

GetColumn returns MetricDataSettingsCustomMetricSettingsFiltersFilter.Column, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCustomMetricSettingsFiltersFilter) GetOperator added in v0.1.6

GetOperator returns MetricDataSettingsCustomMetricSettingsFiltersFilter.Operator, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCustomMetricSettingsFiltersFilter) GetOr added in v1.0.1

GetOr returns MetricDataSettingsCustomMetricSettingsFiltersFilter.Or, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCustomMetricSettingsFiltersFilter) GetValue added in v0.1.6

GetValue returns MetricDataSettingsCustomMetricSettingsFiltersFilter.Value, and is useful for accessing the field via an interface.

func (*MetricDataSettingsCustomMetricSettingsFiltersFilter) MarshalJSON added in v0.1.6

func (*MetricDataSettingsCustomMetricSettingsFiltersFilter) UnmarshalJSON added in v0.1.6

type MetricDataSettingsMaxMetricSettings

type MetricDataSettingsMaxMetricSettings struct {
	Typename *string `json:"__typename"`
	// Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the `filters` property on the `timeSeriesInput`, `counterInput`, or `leaderboardInput` objects. There is no need to add `filters` to be able to filter at query time.
	Filters []*MetricDataSettingsMaxMetricSettingsFiltersFilter `json:"filters"`
	// The Dimension to select the maximum from.
	Measure *MetricDataSettingsMaxMetricSettingsMeasureDimension `json:"measure"`
}

MetricDataSettingsMaxMetricSettings includes the requested fields of the GraphQL type MaxMetricSettings. The GraphQL type's documentation follows.

Settings for Max Metrics.

func (*MetricDataSettingsMaxMetricSettings) GetFilters added in v0.1.4

GetFilters returns MetricDataSettingsMaxMetricSettings.Filters, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettings) GetMeasure added in v0.1.4

GetMeasure returns MetricDataSettingsMaxMetricSettings.Measure, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettings) GetTypename

func (v *MetricDataSettingsMaxMetricSettings) GetTypename() *string

GetTypename returns MetricDataSettingsMaxMetricSettings.Typename, and is useful for accessing the field via an interface.

type MetricDataSettingsMaxMetricSettingsFiltersFilter added in v0.1.4

type MetricDataSettingsMaxMetricSettingsFiltersFilter struct {
	FilterData `json:"-"`
}

MetricDataSettingsMaxMetricSettingsFiltersFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*MetricDataSettingsMaxMetricSettingsFiltersFilter) GetAnd added in v1.0.1

GetAnd returns MetricDataSettingsMaxMetricSettingsFiltersFilter.And, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsFiltersFilter) GetColumn added in v0.1.4

GetColumn returns MetricDataSettingsMaxMetricSettingsFiltersFilter.Column, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsFiltersFilter) GetOperator added in v0.1.4

GetOperator returns MetricDataSettingsMaxMetricSettingsFiltersFilter.Operator, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsFiltersFilter) GetOr added in v1.0.1

GetOr returns MetricDataSettingsMaxMetricSettingsFiltersFilter.Or, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsFiltersFilter) GetValue added in v0.1.4

GetValue returns MetricDataSettingsMaxMetricSettingsFiltersFilter.Value, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsFiltersFilter) MarshalJSON added in v0.1.4

func (*MetricDataSettingsMaxMetricSettingsFiltersFilter) UnmarshalJSON added in v0.1.4

type MetricDataSettingsMaxMetricSettingsMeasureDimension added in v0.1.4

type MetricDataSettingsMaxMetricSettingsMeasureDimension struct {
	DimensionData `json:"-"`
}

MetricDataSettingsMaxMetricSettingsMeasureDimension includes the requested fields of the GraphQL type Dimension. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*MetricDataSettingsMaxMetricSettingsMeasureDimension) GetColumnName added in v0.1.4

GetColumnName returns MetricDataSettingsMaxMetricSettingsMeasureDimension.ColumnName, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsMeasureDimension) GetIsNullable added in v0.1.4

GetIsNullable returns MetricDataSettingsMaxMetricSettingsMeasureDimension.IsNullable, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsMeasureDimension) GetIsUniqueKey added in v0.1.4

GetIsUniqueKey returns MetricDataSettingsMaxMetricSettingsMeasureDimension.IsUniqueKey, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsMeasureDimension) GetType added in v0.1.4

GetType returns MetricDataSettingsMaxMetricSettingsMeasureDimension.Type, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMaxMetricSettingsMeasureDimension) MarshalJSON added in v0.1.4

func (*MetricDataSettingsMaxMetricSettingsMeasureDimension) UnmarshalJSON added in v0.1.4

type MetricDataSettingsMetricSettings

type MetricDataSettingsMetricSettings interface {

	// GetTypename returns the receiver's concrete GraphQL type-name (see interface doc for possible values).
	GetTypename() *string
	// contains filtered or unexported methods
}

MetricDataSettingsMetricSettings includes the requested fields of the GraphQL interface MetricSettings.

MetricDataSettingsMetricSettings is implemented by the following types: MetricDataSettingsAverageMetricSettings MetricDataSettingsCountDistinctMetricSettings MetricDataSettingsCountMetricSettings MetricDataSettingsCustomMetricSettings MetricDataSettingsMaxMetricSettings MetricDataSettingsMinMetricSettings MetricDataSettingsSumMetricSettings The GraphQL type's documentation follows.

A Metric's settings, depending on its type.

type MetricDataSettingsMinMetricSettings

type MetricDataSettingsMinMetricSettings struct {
	Typename *string `json:"__typename"`
	// Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the `filters` property on the `timeSeriesInput`, `counterInput`, or `leaderboardInput` objects. There is no need to add `filters` to be able to filter at query time.
	Filters []*MetricDataSettingsMinMetricSettingsFiltersFilter `json:"filters"`
	// The Dimension to select the minimum from.
	Measure *MetricDataSettingsMinMetricSettingsMeasureDimension `json:"measure"`
}

MetricDataSettingsMinMetricSettings includes the requested fields of the GraphQL type MinMetricSettings. The GraphQL type's documentation follows.

Settings for Min Metrics.

func (*MetricDataSettingsMinMetricSettings) GetFilters added in v0.1.4

GetFilters returns MetricDataSettingsMinMetricSettings.Filters, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettings) GetMeasure added in v0.1.4

GetMeasure returns MetricDataSettingsMinMetricSettings.Measure, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettings) GetTypename

func (v *MetricDataSettingsMinMetricSettings) GetTypename() *string

GetTypename returns MetricDataSettingsMinMetricSettings.Typename, and is useful for accessing the field via an interface.

type MetricDataSettingsMinMetricSettingsFiltersFilter added in v0.1.4

type MetricDataSettingsMinMetricSettingsFiltersFilter struct {
	FilterData `json:"-"`
}

MetricDataSettingsMinMetricSettingsFiltersFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*MetricDataSettingsMinMetricSettingsFiltersFilter) GetAnd added in v1.0.1

GetAnd returns MetricDataSettingsMinMetricSettingsFiltersFilter.And, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsFiltersFilter) GetColumn added in v0.1.4

GetColumn returns MetricDataSettingsMinMetricSettingsFiltersFilter.Column, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsFiltersFilter) GetOperator added in v0.1.4

GetOperator returns MetricDataSettingsMinMetricSettingsFiltersFilter.Operator, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsFiltersFilter) GetOr added in v1.0.1

GetOr returns MetricDataSettingsMinMetricSettingsFiltersFilter.Or, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsFiltersFilter) GetValue added in v0.1.4

GetValue returns MetricDataSettingsMinMetricSettingsFiltersFilter.Value, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsFiltersFilter) MarshalJSON added in v0.1.4

func (*MetricDataSettingsMinMetricSettingsFiltersFilter) UnmarshalJSON added in v0.1.4

type MetricDataSettingsMinMetricSettingsMeasureDimension added in v0.1.4

type MetricDataSettingsMinMetricSettingsMeasureDimension struct {
	DimensionData `json:"-"`
}

MetricDataSettingsMinMetricSettingsMeasureDimension includes the requested fields of the GraphQL type Dimension. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*MetricDataSettingsMinMetricSettingsMeasureDimension) GetColumnName added in v0.1.4

GetColumnName returns MetricDataSettingsMinMetricSettingsMeasureDimension.ColumnName, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsMeasureDimension) GetIsNullable added in v0.1.4

GetIsNullable returns MetricDataSettingsMinMetricSettingsMeasureDimension.IsNullable, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsMeasureDimension) GetIsUniqueKey added in v0.1.4

GetIsUniqueKey returns MetricDataSettingsMinMetricSettingsMeasureDimension.IsUniqueKey, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsMeasureDimension) GetType added in v0.1.4

GetType returns MetricDataSettingsMinMetricSettingsMeasureDimension.Type, and is useful for accessing the field via an interface.

func (*MetricDataSettingsMinMetricSettingsMeasureDimension) MarshalJSON added in v0.1.4

func (*MetricDataSettingsMinMetricSettingsMeasureDimension) UnmarshalJSON added in v0.1.4

type MetricDataSettingsSumMetricSettings

type MetricDataSettingsSumMetricSettings struct {
	Typename *string `json:"__typename"`
	// Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the `filters` property on the `timeSeriesInput`, `counterInput`, or `leaderboardInput` objects. There is no need to add `filters` to be able to filter at query time.
	Filters []*MetricDataSettingsSumMetricSettingsFiltersFilter `json:"filters"`
	// The Dimension to be summed.
	Measure *MetricDataSettingsSumMetricSettingsMeasureDimension `json:"measure"`
}

MetricDataSettingsSumMetricSettings includes the requested fields of the GraphQL type SumMetricSettings. The GraphQL type's documentation follows.

Settings for Sum Metrics.

func (*MetricDataSettingsSumMetricSettings) GetFilters

GetFilters returns MetricDataSettingsSumMetricSettings.Filters, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettings) GetMeasure

GetMeasure returns MetricDataSettingsSumMetricSettings.Measure, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettings) GetTypename

func (v *MetricDataSettingsSumMetricSettings) GetTypename() *string

GetTypename returns MetricDataSettingsSumMetricSettings.Typename, and is useful for accessing the field via an interface.

type MetricDataSettingsSumMetricSettingsFiltersFilter

type MetricDataSettingsSumMetricSettingsFiltersFilter struct {
	FilterData `json:"-"`
}

MetricDataSettingsSumMetricSettingsFiltersFilter includes the requested fields of the GraphQL type Filter. The GraphQL type's documentation follows.

The fields of a filter.

You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

``` (value > 0 AND value <= 100) OR status = "confirmed" ```

you could write

``` { "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] } ```

Note that `and` takes precedence over `or`.

func (*MetricDataSettingsSumMetricSettingsFiltersFilter) GetAnd added in v1.0.1

GetAnd returns MetricDataSettingsSumMetricSettingsFiltersFilter.And, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsFiltersFilter) GetColumn

GetColumn returns MetricDataSettingsSumMetricSettingsFiltersFilter.Column, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsFiltersFilter) GetOperator

GetOperator returns MetricDataSettingsSumMetricSettingsFiltersFilter.Operator, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsFiltersFilter) GetOr added in v1.0.1

GetOr returns MetricDataSettingsSumMetricSettingsFiltersFilter.Or, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsFiltersFilter) GetValue

GetValue returns MetricDataSettingsSumMetricSettingsFiltersFilter.Value, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsFiltersFilter) MarshalJSON

func (*MetricDataSettingsSumMetricSettingsFiltersFilter) UnmarshalJSON

type MetricDataSettingsSumMetricSettingsMeasureDimension

type MetricDataSettingsSumMetricSettingsMeasureDimension struct {
	DimensionData `json:"-"`
}

MetricDataSettingsSumMetricSettingsMeasureDimension includes the requested fields of the GraphQL type Dimension. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*MetricDataSettingsSumMetricSettingsMeasureDimension) GetColumnName

GetColumnName returns MetricDataSettingsSumMetricSettingsMeasureDimension.ColumnName, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsMeasureDimension) GetIsNullable

GetIsNullable returns MetricDataSettingsSumMetricSettingsMeasureDimension.IsNullable, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsMeasureDimension) GetIsUniqueKey

GetIsUniqueKey returns MetricDataSettingsSumMetricSettingsMeasureDimension.IsUniqueKey, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsMeasureDimension) GetType

GetType returns MetricDataSettingsSumMetricSettingsMeasureDimension.Type, and is useful for accessing the field via an interface.

func (*MetricDataSettingsSumMetricSettingsMeasureDimension) MarshalJSON

func (*MetricDataSettingsSumMetricSettingsMeasureDimension) UnmarshalJSON

type MetricDataTimestampDimension

type MetricDataTimestampDimension struct {
	DimensionData `json:"-"`
}

MetricDataTimestampDimension includes the requested fields of the GraphQL type Dimension. The GraphQL type's documentation follows.

The Dimension object that represents a column in a table.

func (*MetricDataTimestampDimension) GetColumnName

func (v *MetricDataTimestampDimension) GetColumnName() string

GetColumnName returns MetricDataTimestampDimension.ColumnName, and is useful for accessing the field via an interface.

func (*MetricDataTimestampDimension) GetIsNullable

func (v *MetricDataTimestampDimension) GetIsNullable() *bool

GetIsNullable returns MetricDataTimestampDimension.IsNullable, and is useful for accessing the field via an interface.

func (*MetricDataTimestampDimension) GetIsUniqueKey

func (v *MetricDataTimestampDimension) GetIsUniqueKey() *bool

GetIsUniqueKey returns MetricDataTimestampDimension.IsUniqueKey, and is useful for accessing the field via an interface.

func (*MetricDataTimestampDimension) GetType

func (v *MetricDataTimestampDimension) GetType() string

GetType returns MetricDataTimestampDimension.Type, and is useful for accessing the field via an interface.

func (*MetricDataTimestampDimension) MarshalJSON

func (v *MetricDataTimestampDimension) MarshalJSON() ([]byte, error)

func (*MetricDataTimestampDimension) UnmarshalJSON

func (v *MetricDataTimestampDimension) UnmarshalJSON(b []byte) error

type MetricMetric

type MetricMetric struct {
	MetricData `json:"-"`
}

MetricMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*MetricMetric) GetAccessControlEnabled added in v0.1.4

func (v *MetricMetric) GetAccessControlEnabled() bool

GetAccessControlEnabled returns MetricMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*MetricMetric) GetAccount

func (v *MetricMetric) GetAccount() *CommonDataAccount

GetAccount returns MetricMetric.Account, and is useful for accessing the field via an interface.

func (*MetricMetric) GetCreatedAt

func (v *MetricMetric) GetCreatedAt() time.Time

GetCreatedAt returns MetricMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*MetricMetric) GetCreatedBy

func (v *MetricMetric) GetCreatedBy() string

GetCreatedBy returns MetricMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*MetricMetric) GetDataPool

func (v *MetricMetric) GetDataPool() *MetricDataDataPool

GetDataPool returns MetricMetric.DataPool, and is useful for accessing the field via an interface.

func (*MetricMetric) GetDescription

func (v *MetricMetric) GetDescription() string

GetDescription returns MetricMetric.Description, and is useful for accessing the field via an interface.

func (*MetricMetric) GetDimensions

func (v *MetricMetric) GetDimensions() []*MetricDataDimensionsDimension

GetDimensions returns MetricMetric.Dimensions, and is useful for accessing the field via an interface.

func (*MetricMetric) GetEnvironment

func (v *MetricMetric) GetEnvironment() *CommonDataEnvironment

GetEnvironment returns MetricMetric.Environment, and is useful for accessing the field via an interface.

func (*MetricMetric) GetId

func (v *MetricMetric) GetId() string

GetId returns MetricMetric.Id, and is useful for accessing the field via an interface.

func (*MetricMetric) GetMeasure

func (v *MetricMetric) GetMeasure() *MetricDataMeasureDimension

GetMeasure returns MetricMetric.Measure, and is useful for accessing the field via an interface.

func (*MetricMetric) GetModifiedAt

func (v *MetricMetric) GetModifiedAt() time.Time

GetModifiedAt returns MetricMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*MetricMetric) GetModifiedBy

func (v *MetricMetric) GetModifiedBy() string

GetModifiedBy returns MetricMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*MetricMetric) GetSettings

GetSettings returns MetricMetric.Settings, and is useful for accessing the field via an interface.

func (*MetricMetric) GetTimestamp

func (v *MetricMetric) GetTimestamp() *MetricDataTimestampDimension

GetTimestamp returns MetricMetric.Timestamp, and is useful for accessing the field via an interface.

func (*MetricMetric) GetType

func (v *MetricMetric) GetType() MetricType

GetType returns MetricMetric.Type, and is useful for accessing the field via an interface.

func (*MetricMetric) GetUniqueName

func (v *MetricMetric) GetUniqueName() string

GetUniqueName returns MetricMetric.UniqueName, and is useful for accessing the field via an interface.

func (*MetricMetric) MarshalJSON

func (v *MetricMetric) MarshalJSON() ([]byte, error)

func (*MetricMetric) UnmarshalJSON

func (v *MetricMetric) UnmarshalJSON(b []byte) error

type MetricResponse

type MetricResponse struct {
	// This query returns the Metric specified by the given ID.
	//
	// A Metric is a business indicator measured over time.
	Metric *MetricMetric `json:"metric"`
}

MetricResponse is returned by Metric on success.

func Metric

func Metric(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*MetricResponse, error)

func (*MetricResponse) GetMetric

func (v *MetricResponse) GetMetric() *MetricMetric

GetMetric returns MetricResponse.Metric, and is useful for accessing the field via an interface.

type MetricType

type MetricType string

The available Metric types.

const (
	// Counts the number of records that matches the Metric Filters. For time series, it will count the values for each time granularity.
	MetricTypeCount MetricType = "COUNT"
	// Sums the values of the specified column for every record that matches the Metric Filters. For time series, it will sum the values for each time granularity.
	MetricTypeSum MetricType = "SUM"
	// Counts the number of distinct values in the specified column for every record that matches the Metric Filters. For time series, it will count the distinct values for each time granularity.
	MetricTypeCountDistinct MetricType = "COUNT_DISTINCT"
	// Averages the values of the specified column for every record that matches the Metric Filters. For time series, it will average the values for each time granularity.
	MetricTypeAverage MetricType = "AVERAGE"
	// Selects the minimum value of the specified column for every record that matches the Metric Filters. For time series, it will select the minimum value for each time granularity.
	MetricTypeMin MetricType = "MIN"
	// Selects the maximum value of the specified column for every record that matches the Metric Filters. For time series, it will select the maximum value for each time granularity.
	MetricTypeMax MetricType = "MAX"
	// Aggregates values based on the provided custom expression.
	MetricTypeCustom MetricType = "CUSTOM"
)

type MetricsMetricsMetricConnection

type MetricsMetricsMetricConnection struct {
	// The Metric connection's page info.
	PageInfo *MetricsMetricsMetricConnectionPageInfo `json:"pageInfo"`
	// The Metric connection's nodes.
	Nodes []*MetricsMetricsMetricConnectionNodesMetric `json:"nodes"`
	// The Metric connection's edges.
	Edges []*MetricsMetricsMetricConnectionEdgesMetricEdge `json:"edges"`
}

MetricsMetricsMetricConnection includes the requested fields of the GraphQL type MetricConnection. The GraphQL type's documentation follows.

The Metric connection object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*MetricsMetricsMetricConnection) GetEdges

GetEdges returns MetricsMetricsMetricConnection.Edges, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnection) GetNodes

GetNodes returns MetricsMetricsMetricConnection.Nodes, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnection) GetPageInfo

GetPageInfo returns MetricsMetricsMetricConnection.PageInfo, and is useful for accessing the field via an interface.

type MetricsMetricsMetricConnectionEdgesMetricEdge

type MetricsMetricsMetricConnectionEdgesMetricEdge struct {
	// The edge's cursor.
	Cursor string `json:"cursor"`
	// The edge's node.
	Node *MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric `json:"node"`
}

MetricsMetricsMetricConnectionEdgesMetricEdge includes the requested fields of the GraphQL type MetricEdge. The GraphQL type's documentation follows.

The Metric edge object.

Learn more about [pagination in GraphQL](https://www.propeldata.com/docs/api/pagination).

func (*MetricsMetricsMetricConnectionEdgesMetricEdge) GetCursor

GetCursor returns MetricsMetricsMetricConnectionEdgesMetricEdge.Cursor, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdge) GetNode

GetNode returns MetricsMetricsMetricConnectionEdgesMetricEdge.Node, and is useful for accessing the field via an interface.

type MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric

type MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric struct {
	MetricData `json:"-"`
}

MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetAccessControlEnabled added in v0.1.4

GetAccessControlEnabled returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetAccount

GetAccount returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Account, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetCreatedAt

GetCreatedAt returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetCreatedBy

GetCreatedBy returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetDataPool

GetDataPool returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.DataPool, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetDescription

GetDescription returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Description, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetDimensions

GetDimensions returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Dimensions, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetEnvironment

GetEnvironment returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Environment, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetId

GetId returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Id, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetMeasure

GetMeasure returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Measure, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetModifiedAt

GetModifiedAt returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetModifiedBy

GetModifiedBy returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetSettings

GetSettings returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Settings, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetTimestamp

GetTimestamp returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Timestamp, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetType

GetType returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.Type, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) GetUniqueName

GetUniqueName returns MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric.UniqueName, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) MarshalJSON

func (*MetricsMetricsMetricConnectionEdgesMetricEdgeNodeMetric) UnmarshalJSON

type MetricsMetricsMetricConnectionNodesMetric

type MetricsMetricsMetricConnectionNodesMetric struct {
	MetricData `json:"-"`
}

MetricsMetricsMetricConnectionNodesMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*MetricsMetricsMetricConnectionNodesMetric) GetAccessControlEnabled added in v0.1.4

func (v *MetricsMetricsMetricConnectionNodesMetric) GetAccessControlEnabled() bool

GetAccessControlEnabled returns MetricsMetricsMetricConnectionNodesMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetAccount

GetAccount returns MetricsMetricsMetricConnectionNodesMetric.Account, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetCreatedAt

GetCreatedAt returns MetricsMetricsMetricConnectionNodesMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetCreatedBy

GetCreatedBy returns MetricsMetricsMetricConnectionNodesMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetDataPool

GetDataPool returns MetricsMetricsMetricConnectionNodesMetric.DataPool, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetDescription

GetDescription returns MetricsMetricsMetricConnectionNodesMetric.Description, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetDimensions

GetDimensions returns MetricsMetricsMetricConnectionNodesMetric.Dimensions, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetEnvironment

GetEnvironment returns MetricsMetricsMetricConnectionNodesMetric.Environment, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetId

GetId returns MetricsMetricsMetricConnectionNodesMetric.Id, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetMeasure

GetMeasure returns MetricsMetricsMetricConnectionNodesMetric.Measure, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetModifiedAt

GetModifiedAt returns MetricsMetricsMetricConnectionNodesMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetModifiedBy

GetModifiedBy returns MetricsMetricsMetricConnectionNodesMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetSettings

GetSettings returns MetricsMetricsMetricConnectionNodesMetric.Settings, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetTimestamp

GetTimestamp returns MetricsMetricsMetricConnectionNodesMetric.Timestamp, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetType

GetType returns MetricsMetricsMetricConnectionNodesMetric.Type, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) GetUniqueName

GetUniqueName returns MetricsMetricsMetricConnectionNodesMetric.UniqueName, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionNodesMetric) MarshalJSON

func (*MetricsMetricsMetricConnectionNodesMetric) UnmarshalJSON

type MetricsMetricsMetricConnectionPageInfo

type MetricsMetricsMetricConnectionPageInfo struct {
	PageInfoData `json:"-"`
}

MetricsMetricsMetricConnectionPageInfo includes the requested fields of the GraphQL type PageInfo. The GraphQL type's documentation follows.

The page info object used for pagination.

func (*MetricsMetricsMetricConnectionPageInfo) GetEndCursor

GetEndCursor returns MetricsMetricsMetricConnectionPageInfo.EndCursor, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionPageInfo) GetHasNextPage

func (v *MetricsMetricsMetricConnectionPageInfo) GetHasNextPage() bool

GetHasNextPage returns MetricsMetricsMetricConnectionPageInfo.HasNextPage, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionPageInfo) GetHasPreviousPage

func (v *MetricsMetricsMetricConnectionPageInfo) GetHasPreviousPage() bool

GetHasPreviousPage returns MetricsMetricsMetricConnectionPageInfo.HasPreviousPage, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionPageInfo) GetStartCursor

func (v *MetricsMetricsMetricConnectionPageInfo) GetStartCursor() *string

GetStartCursor returns MetricsMetricsMetricConnectionPageInfo.StartCursor, and is useful for accessing the field via an interface.

func (*MetricsMetricsMetricConnectionPageInfo) MarshalJSON

func (v *MetricsMetricsMetricConnectionPageInfo) MarshalJSON() ([]byte, error)

func (*MetricsMetricsMetricConnectionPageInfo) UnmarshalJSON

func (v *MetricsMetricsMetricConnectionPageInfo) UnmarshalJSON(b []byte) error

type MetricsResponse

type MetricsResponse struct {
	// This query returns the Metrics within the Environment.
	//
	// A Metric is a business indicator measured over time. Each Metric is associated with one Data Pool, which is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.
	//
	// The `metrics` query uses [cursor-based pagination](/docs/api/pagination) typical of GraphQL APIs. You can use the pairs of parameters `first` and `after` or `last` and `before` to page forward or backward through the results, respectively.
	//
	// For forward pagination, the `first` parameter defines the number of results to return, and the `after` parameter defines the cursor to continue from. You should pass the cursor for the _last_ result of the current page to `after`.
	//
	// For backward pagination, the `last` parameter defines the number of results to return, and the `before` parameter defines the cursor to continue from. You should pass the cursor for the _first_ result of the current page to `before`.
	Metrics *MetricsMetricsMetricConnection `json:"metrics"`
}

MetricsResponse is returned by Metrics on success.

func Metrics

func Metrics(
	ctx context.Context,
	client graphql.Client,
	first *int,
	last *int,
	after *string,
	before *string,
) (*MetricsResponse, error)

func (*MetricsResponse) GetMetrics

GetMetrics returns MetricsResponse.Metrics, and is useful for accessing the field via an interface.

type ModifyDataPoolAccessPolicyInput added in v1.1.0

type ModifyDataPoolAccessPolicyInput struct {
	Id string `json:"id"`
	// The Data Pool Access Policy's new unique name.
	UniqueName *string `json:"uniqueName"`
	// The Data Pool Access Policy's new description.
	Description *string `json:"description"`
	// Columns that the Access Policy makes available for querying. If not provided this property will not be modified.
	Columns []string `json:"columns"`
	// Row-level filters that the Access Policy applies before executing queries. If not provided this property will not be modified.
	Rows []*FilterInput `json:"rows,omitempty"`
	// Row-level filters that the Access Policy applies before executing queries, in the form of SQL. If not provided this property will not be modified.
	FilterSql *string `json:"filterSql"`
}

func (*ModifyDataPoolAccessPolicyInput) GetColumns added in v1.1.0

func (v *ModifyDataPoolAccessPolicyInput) GetColumns() []string

GetColumns returns ModifyDataPoolAccessPolicyInput.Columns, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyInput) GetDescription added in v1.1.0

func (v *ModifyDataPoolAccessPolicyInput) GetDescription() *string

GetDescription returns ModifyDataPoolAccessPolicyInput.Description, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyInput) GetFilterSql added in v1.2.1

func (v *ModifyDataPoolAccessPolicyInput) GetFilterSql() *string

GetFilterSql returns ModifyDataPoolAccessPolicyInput.FilterSql, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyInput) GetId added in v1.1.0

GetId returns ModifyDataPoolAccessPolicyInput.Id, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyInput) GetRows added in v1.1.0

GetRows returns ModifyDataPoolAccessPolicyInput.Rows, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyInput) GetUniqueName added in v1.1.0

func (v *ModifyDataPoolAccessPolicyInput) GetUniqueName() *string

GetUniqueName returns ModifyDataPoolAccessPolicyInput.UniqueName, and is useful for accessing the field via an interface.

type ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponse added in v1.1.0

type ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponse struct {
	// The Data Pool Access Policy.
	DataPoolAccessPolicy *ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy `json:"dataPoolAccessPolicy"`
}

ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponse includes the requested fields of the GraphQL type DataPoolAccessPolicyResponse.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponse) GetDataPoolAccessPolicy added in v1.1.0

GetDataPoolAccessPolicy returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponse.DataPoolAccessPolicy, and is useful for accessing the field via an interface.

type ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy added in v1.1.0

type ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy struct {
	DataPoolAccessPolicyData `json:"-"`
}

ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy includes the requested fields of the GraphQL type DataPoolAccessPolicy.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetAccount added in v1.1.0

GetAccount returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Account, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetColumns added in v1.1.0

GetColumns returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Columns, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetCreatedAt added in v1.1.0

GetCreatedAt returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.CreatedAt, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetCreatedBy added in v1.1.0

GetCreatedBy returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.CreatedBy, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetDataPool added in v1.1.0

GetDataPool returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.DataPool, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetDescription added in v1.1.0

GetDescription returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Description, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetEnvironment added in v1.1.0

GetEnvironment returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Environment, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetId added in v1.1.0

GetId returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Id, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetModifiedAt added in v1.1.0

GetModifiedAt returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.ModifiedAt, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetModifiedBy added in v1.1.0

GetModifiedBy returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.ModifiedBy, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetRows added in v1.1.0

GetRows returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.Rows, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) GetUniqueName added in v1.1.0

GetUniqueName returns ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy.UniqueName, and is useful for accessing the field via an interface.

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) MarshalJSON added in v1.1.0

func (*ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponseDataPoolAccessPolicy) UnmarshalJSON added in v1.1.0

type ModifyDataPoolAccessPolicyResponse added in v1.1.0

type ModifyDataPoolAccessPolicyResponse struct {
	// Modifies a Data Pool Access Policy with the provided unique name, description, columns and rows. If any of the optional arguments are omitted, those properties will be unchanged on the Data Pool Access Policy.
	//
	// [Learn more about Data Pool Access Policy](https://www.propeldata.com/docs/control-access).
	ModifyDataPoolAccessPolicy *ModifyDataPoolAccessPolicyModifyDataPoolAccessPolicyDataPoolAccessPolicyResponse `json:"modifyDataPoolAccessPolicy"`
}

ModifyDataPoolAccessPolicyResponse is returned by ModifyDataPoolAccessPolicy on success.

func ModifyDataPoolAccessPolicy added in v1.1.0

func ModifyDataPoolAccessPolicy(
	ctx context.Context,
	client graphql.Client,
	input *ModifyDataPoolAccessPolicyInput,
) (*ModifyDataPoolAccessPolicyResponse, error)

func (*ModifyDataPoolAccessPolicyResponse) GetModifyDataPoolAccessPolicy added in v1.1.0

GetModifyDataPoolAccessPolicy returns ModifyDataPoolAccessPolicyResponse.ModifyDataPoolAccessPolicy, and is useful for accessing the field via an interface.

type ModifyDataPoolInput

type ModifyDataPoolInput struct {
	// The ID or unique name of the Data Pool to modify.
	IdOrUniqueName *IdOrUniqueName `json:"idOrUniqueName,omitempty"`
	// The Data Pool's new unique name.
	UniqueName *string `json:"uniqueName"`
	// The Data Pool's new description.
	Description *string `json:"description"`
	// The Data Pool's new data retention in days.
	DataRetentionInDays *int `json:"dataRetentionInDays"`
	// The Data Pool's new syncing settings.
	Syncing *DataPoolSyncingInput `json:"syncing,omitempty"`
	// Enables or disables access control for the Data Pool.
	//
	// If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
	// Policies in order to query the Data Pool and its Metrics.
	AccessControlEnabled *bool `json:"accessControlEnabled"`
}

The fields for modifying a Data Pool.

func (*ModifyDataPoolInput) GetAccessControlEnabled added in v1.0.1

func (v *ModifyDataPoolInput) GetAccessControlEnabled() *bool

GetAccessControlEnabled returns ModifyDataPoolInput.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*ModifyDataPoolInput) GetDataRetentionInDays

func (v *ModifyDataPoolInput) GetDataRetentionInDays() *int

GetDataRetentionInDays returns ModifyDataPoolInput.DataRetentionInDays, and is useful for accessing the field via an interface.

func (*ModifyDataPoolInput) GetDescription

func (v *ModifyDataPoolInput) GetDescription() *string

GetDescription returns ModifyDataPoolInput.Description, and is useful for accessing the field via an interface.

func (*ModifyDataPoolInput) GetIdOrUniqueName

func (v *ModifyDataPoolInput) GetIdOrUniqueName() *IdOrUniqueName

GetIdOrUniqueName returns ModifyDataPoolInput.IdOrUniqueName, and is useful for accessing the field via an interface.

func (*ModifyDataPoolInput) GetSyncing added in v0.1.2

func (v *ModifyDataPoolInput) GetSyncing() *DataPoolSyncingInput

GetSyncing returns ModifyDataPoolInput.Syncing, and is useful for accessing the field via an interface.

func (*ModifyDataPoolInput) GetUniqueName

func (v *ModifyDataPoolInput) GetUniqueName() *string

GetUniqueName returns ModifyDataPoolInput.UniqueName, and is useful for accessing the field via an interface.

type ModifyDataPoolModifyDataPoolDataPoolOrFailureResponse

type ModifyDataPoolModifyDataPoolDataPoolOrFailureResponse interface {

	// GetTypename returns the receiver's concrete GraphQL type-name (see interface doc for possible values).
	GetTypename() *string
	// contains filtered or unexported methods
}

ModifyDataPoolModifyDataPoolDataPoolOrFailureResponse includes the requested fields of the GraphQL interface DataPoolOrFailureResponse.

ModifyDataPoolModifyDataPoolDataPoolOrFailureResponse is implemented by the following types: ModifyDataPoolModifyDataPoolDataPoolResponse ModifyDataPoolModifyDataPoolFailureResponse The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Pool.

If successful, an `DataPoolResponse` will be returned; otherwise, a `FailureResponse` will be returned.

type ModifyDataPoolModifyDataPoolDataPoolResponse

type ModifyDataPoolModifyDataPoolDataPoolResponse struct {
	Typename *string `json:"__typename"`
	// The Data Pool which was created or modified.
	DataPool *ModifyDataPoolModifyDataPoolDataPoolResponseDataPool `json:"dataPool"`
}

ModifyDataPoolModifyDataPoolDataPoolResponse includes the requested fields of the GraphQL type DataPoolResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Pool.

func (*ModifyDataPoolModifyDataPoolDataPoolResponse) GetDataPool

GetDataPool returns ModifyDataPoolModifyDataPoolDataPoolResponse.DataPool, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponse) GetTypename

GetTypename returns ModifyDataPoolModifyDataPoolDataPoolResponse.Typename, and is useful for accessing the field via an interface.

type ModifyDataPoolModifyDataPoolDataPoolResponseDataPool

type ModifyDataPoolModifyDataPoolDataPoolResponseDataPool struct {
	DataPoolData `json:"-"`
}

ModifyDataPoolModifyDataPoolDataPoolResponseDataPool includes the requested fields of the GraphQL type DataPool. The GraphQL type's documentation follows.

The Data Pool object. Data Pools are Propel's high-speed data store and cache

[Learn more about Data Pools](https://www.propeldata.com/docs/connect-your-data#key-concept-2-data-pools).

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetAccessControlEnabled added in v1.1.0

func (v *ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetAccessControlEnabled() bool

GetAccessControlEnabled returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetAccount

GetAccount returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Account, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetAvailableMeasures

GetAvailableMeasures returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.AvailableMeasures, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetColumns

GetColumns returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Columns, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetCreatedAt

GetCreatedAt returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.CreatedAt, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetCreatedBy

GetCreatedBy returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.CreatedBy, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetDataPoolAccessPolicies added in v1.1.0

GetDataPoolAccessPolicies returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.DataPoolAccessPolicies, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetDataSource

GetDataSource returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.DataSource, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetDescription

GetDescription returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Description, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetEnvironment

GetEnvironment returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Environment, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetError

GetError returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Error, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetId

GetId returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Id, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetModifiedAt

GetModifiedAt returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.ModifiedAt, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetModifiedBy

GetModifiedBy returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.ModifiedBy, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetSetupTasks

GetSetupTasks returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.SetupTasks, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetStatus

GetStatus returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Status, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetSyncing added in v0.1.3

GetSyncing returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Syncing, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetSyncs

GetSyncs returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Syncs, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetTable

GetTable returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Table, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetTenant added in v1.2.1

GetTenant returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Tenant, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetTimestamp

GetTimestamp returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.Timestamp, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetUniqueId added in v1.0.0

GetUniqueId returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.UniqueId, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) GetUniqueName

GetUniqueName returns ModifyDataPoolModifyDataPoolDataPoolResponseDataPool.UniqueName, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) MarshalJSON

func (*ModifyDataPoolModifyDataPoolDataPoolResponseDataPool) UnmarshalJSON

type ModifyDataPoolModifyDataPoolFailureResponse

type ModifyDataPoolModifyDataPoolFailureResponse struct {
	Typename *string `json:"__typename"`
	// The error that caused the failure.
	Error *ModifyDataPoolModifyDataPoolFailureResponseError `json:"error"`
}

ModifyDataPoolModifyDataPoolFailureResponse includes the requested fields of the GraphQL type FailureResponse. The GraphQL type's documentation follows.

The failure response object.

func (*ModifyDataPoolModifyDataPoolFailureResponse) GetError

GetError returns ModifyDataPoolModifyDataPoolFailureResponse.Error, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolFailureResponse) GetTypename

GetTypename returns ModifyDataPoolModifyDataPoolFailureResponse.Typename, and is useful for accessing the field via an interface.

type ModifyDataPoolModifyDataPoolFailureResponseError

type ModifyDataPoolModifyDataPoolFailureResponseError struct {
	GqlError `json:"-"`
}

ModifyDataPoolModifyDataPoolFailureResponseError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*ModifyDataPoolModifyDataPoolFailureResponseError) GetCode

GetCode returns ModifyDataPoolModifyDataPoolFailureResponseError.Code, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolFailureResponseError) GetMessage

GetMessage returns ModifyDataPoolModifyDataPoolFailureResponseError.Message, and is useful for accessing the field via an interface.

func (*ModifyDataPoolModifyDataPoolFailureResponseError) MarshalJSON

func (*ModifyDataPoolModifyDataPoolFailureResponseError) UnmarshalJSON

type ModifyDataPoolResponse

type ModifyDataPoolResponse struct {
	// Modifies a Data Pool with the provided unique name, description, and data retention time. If any of the optional arguments are omitted, those properties will be unchanged on the Data Pool.
	ModifyDataPool *ModifyDataPoolModifyDataPoolDataPoolOrFailureResponse `json:"-"`
}

ModifyDataPoolResponse is returned by ModifyDataPool on success.

func ModifyDataPool

func ModifyDataPool(
	ctx context.Context,
	client graphql.Client,
	input *ModifyDataPoolInput,
) (*ModifyDataPoolResponse, error)

func (*ModifyDataPoolResponse) GetModifyDataPool

GetModifyDataPool returns ModifyDataPoolResponse.ModifyDataPool, and is useful for accessing the field via an interface.

func (*ModifyDataPoolResponse) MarshalJSON

func (v *ModifyDataPoolResponse) MarshalJSON() ([]byte, error)

func (*ModifyDataPoolResponse) UnmarshalJSON

func (v *ModifyDataPoolResponse) UnmarshalJSON(b []byte) error

type ModifyHttpDataSourceInput added in v0.1.3

type ModifyHttpDataSourceInput struct {
	// The HTTP Data Source's new connection settings. If not provided this property will not be modified.
	ConnectionSettings *PartialHttpConnectionSettingsInput `json:"connectionSettings,omitempty"`
	// The HTTP Data Source's new description. If not provided this property will not be modified.
	Description *string `json:"description"`
	// The ID or unique name of the HTTP Data Source to modify.
	IdOrUniqueName *IdOrUniqueName `json:"idOrUniqueName,omitempty"`
	// The HTTP Data Source's new unique name. If not provided this property will not be modified.
	UniqueName *string `json:"uniqueName"`
}

func (*ModifyHttpDataSourceInput) GetConnectionSettings added in v0.1.3

GetConnectionSettings returns ModifyHttpDataSourceInput.ConnectionSettings, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceInput) GetDescription added in v0.1.3

func (v *ModifyHttpDataSourceInput) GetDescription() *string

GetDescription returns ModifyHttpDataSourceInput.Description, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceInput) GetIdOrUniqueName added in v0.1.3

func (v *ModifyHttpDataSourceInput) GetIdOrUniqueName() *IdOrUniqueName

GetIdOrUniqueName returns ModifyHttpDataSourceInput.IdOrUniqueName, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceInput) GetUniqueName added in v0.1.3

func (v *ModifyHttpDataSourceInput) GetUniqueName() *string

GetUniqueName returns ModifyHttpDataSourceInput.UniqueName, and is useful for accessing the field via an interface.

type ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponse added in v0.1.3

type ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponse struct {
	// The Data Source which was created or modified.
	DataSource *ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource `json:"dataSource"`
}

ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponse includes the requested fields of the GraphQL type DataSourceResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Source.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponse) GetDataSource added in v0.1.3

GetDataSource returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponse.DataSource, and is useful for accessing the field via an interface.

type ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource added in v0.1.3

type ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource struct {
	DataSourceData `json:"-"`
}

ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetAccount added in v0.1.3

GetAccount returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Account, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetChecks added in v0.1.3

GetChecks returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Checks, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetConnectionSettings added in v0.1.3

GetConnectionSettings returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetCreatedAt added in v0.1.3

GetCreatedAt returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetCreatedBy added in v0.1.3

GetCreatedBy returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetDataPools added in v1.0.1

GetDataPools returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.DataPools, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetDescription added in v0.1.3

GetDescription returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Description, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetEnvironment added in v0.1.3

GetEnvironment returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Environment, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetError added in v0.1.3

GetError returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Error, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetId added in v0.1.3

GetId returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Id, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetModifiedAt added in v0.1.3

GetModifiedAt returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetModifiedBy added in v0.1.3

GetModifiedBy returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetStatus added in v0.1.3

GetStatus returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Status, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetTableIntrospections added in v0.1.3

GetTableIntrospections returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetTables added in v0.1.3

GetTables returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Tables, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetType added in v0.1.3

GetType returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.Type, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) GetUniqueName added in v0.1.3

GetUniqueName returns ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) MarshalJSON added in v0.1.3

func (*ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponseDataSource) UnmarshalJSON added in v0.1.3

type ModifyHttpDataSourceResponse added in v0.1.3

type ModifyHttpDataSourceResponse struct {
	// This mutation selects a Data Source by its ID or unique name and modifies it to have the given unique name, description, and connection settings.
	//
	// If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.
	ModifyHttpDataSource *ModifyHttpDataSourceModifyHttpDataSourceDataSourceResponse `json:"modifyHttpDataSource"`
}

ModifyHttpDataSourceResponse is returned by ModifyHttpDataSource on success.

func ModifyHttpDataSource added in v0.1.3

func ModifyHttpDataSource(
	ctx context.Context,
	client graphql.Client,
	input *ModifyHttpDataSourceInput,
) (*ModifyHttpDataSourceResponse, error)

func (*ModifyHttpDataSourceResponse) GetModifyHttpDataSource added in v0.1.3

GetModifyHttpDataSource returns ModifyHttpDataSourceResponse.ModifyHttpDataSource, and is useful for accessing the field via an interface.

type ModifyMaterializedViewInput added in v1.2.1

type ModifyMaterializedViewInput struct {
	// The ID of the Materialized View to modify.
	Id string `json:"id"`
	// The Materialized View's new unique name.
	UniqueName *string `json:"uniqueName"`
	// The Materialized View's new description.
	Description *string `json:"description"`
}

The fields for modifying a Materialized View.

func (*ModifyMaterializedViewInput) GetDescription added in v1.2.1

func (v *ModifyMaterializedViewInput) GetDescription() *string

GetDescription returns ModifyMaterializedViewInput.Description, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewInput) GetId added in v1.2.1

GetId returns ModifyMaterializedViewInput.Id, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewInput) GetUniqueName added in v1.2.1

func (v *ModifyMaterializedViewInput) GetUniqueName() *string

GetUniqueName returns ModifyMaterializedViewInput.UniqueName, and is useful for accessing the field via an interface.

type ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponse added in v1.2.1

type ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponse struct {
	// The Materialized View which was created or modified.
	MaterializedView *ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView `json:"materializedView"`
}

ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponse includes the requested fields of the GraphQL type MaterializedViewResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Materialized View.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponse) GetMaterializedView added in v1.2.1

GetMaterializedView returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponse.MaterializedView, and is useful for accessing the field via an interface.

type ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView added in v1.2.1

type ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView struct {
	MaterializedViewData `json:"-"`
}

ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView includes the requested fields of the GraphQL type MaterializedView.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetAccount added in v1.2.1

GetAccount returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.Account, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetCreatedAt added in v1.2.1

GetCreatedAt returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.CreatedAt, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetCreatedBy added in v1.2.1

GetCreatedBy returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.CreatedBy, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetDescription added in v1.2.1

GetDescription returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.Description, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetDestination added in v1.2.1

GetDestination returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.Destination, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetEnvironment added in v1.2.1

GetEnvironment returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.Environment, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetId added in v1.2.1

GetId returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.Id, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetModifiedAt added in v1.2.1

GetModifiedAt returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.ModifiedAt, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetModifiedBy added in v1.2.1

GetModifiedBy returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.ModifiedBy, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetOthers added in v1.2.1

GetOthers returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.Others, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetSource added in v1.2.1

GetSource returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.Source, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetSql added in v1.2.1

GetSql returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.Sql, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) GetUniqueName added in v1.2.1

GetUniqueName returns ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView.UniqueName, and is useful for accessing the field via an interface.

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) MarshalJSON added in v1.2.1

func (*ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponseMaterializedView) UnmarshalJSON added in v1.2.1

type ModifyMaterializedViewResponse added in v1.2.1

type ModifyMaterializedViewResponse struct {
	// Modifies a Materialized View. If any of the optional arguments are omitted, those properties will be unchanged on the Materialized View.
	ModifyMaterializedView *ModifyMaterializedViewModifyMaterializedViewMaterializedViewResponse `json:"modifyMaterializedView"`
}

ModifyMaterializedViewResponse is returned by ModifyMaterializedView on success.

func ModifyMaterializedView added in v1.2.1

func ModifyMaterializedView(
	ctx context.Context,
	client graphql.Client,
	input *ModifyMaterializedViewInput,
) (*ModifyMaterializedViewResponse, error)

func (*ModifyMaterializedViewResponse) GetModifyMaterializedView added in v1.2.1

GetModifyMaterializedView returns ModifyMaterializedViewResponse.ModifyMaterializedView, and is useful for accessing the field via an interface.

type ModifyMetricInput

type ModifyMetricInput struct {
	// The ID of the Metric to modify.
	Metric string `json:"metric"`
	// The Metric's new unique name.
	UniqueName *string `json:"uniqueName"`
	// The Metric's new description.
	Description *string `json:"description"`
	// The Metric's new Dimensions. Used to add or remove Dimensions.
	Dimensions []*DimensionInput `json:"dimensions,omitempty"`
	// The Metric's new Filters. Used to add or remove Metric Filters.
	Filters []*FilterInput `json:"filters,omitempty"`
	// The Metric's new Filters, in the form of SQL. Used to add or remove Metric Filters.
	FilterSql *string `json:"filterSql"`
	// Enables or disables access control for the Metric.
	AccessControlEnabled *bool `json:"accessControlEnabled"`
}

The fields for modifying a Metric.

func (*ModifyMetricInput) GetAccessControlEnabled

func (v *ModifyMetricInput) GetAccessControlEnabled() *bool

GetAccessControlEnabled returns ModifyMetricInput.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*ModifyMetricInput) GetDescription

func (v *ModifyMetricInput) GetDescription() *string

GetDescription returns ModifyMetricInput.Description, and is useful for accessing the field via an interface.

func (*ModifyMetricInput) GetDimensions

func (v *ModifyMetricInput) GetDimensions() []*DimensionInput

GetDimensions returns ModifyMetricInput.Dimensions, and is useful for accessing the field via an interface.

func (*ModifyMetricInput) GetFilterSql added in v1.2.1

func (v *ModifyMetricInput) GetFilterSql() *string

GetFilterSql returns ModifyMetricInput.FilterSql, and is useful for accessing the field via an interface.

func (*ModifyMetricInput) GetFilters

func (v *ModifyMetricInput) GetFilters() []*FilterInput

GetFilters returns ModifyMetricInput.Filters, and is useful for accessing the field via an interface.

func (*ModifyMetricInput) GetMetric

func (v *ModifyMetricInput) GetMetric() string

GetMetric returns ModifyMetricInput.Metric, and is useful for accessing the field via an interface.

func (*ModifyMetricInput) GetUniqueName

func (v *ModifyMetricInput) GetUniqueName() *string

GetUniqueName returns ModifyMetricInput.UniqueName, and is useful for accessing the field via an interface.

type ModifyMetricModifyMetricMetricResponse

type ModifyMetricModifyMetricMetricResponse struct {
	Typename *string `json:"__typename"`
	// The Metric which was created or modified.
	Metric *ModifyMetricModifyMetricMetricResponseMetric `json:"metric"`
}

ModifyMetricModifyMetricMetricResponse includes the requested fields of the GraphQL type MetricResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Metric.

func (*ModifyMetricModifyMetricMetricResponse) GetMetric

GetMetric returns ModifyMetricModifyMetricMetricResponse.Metric, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponse) GetTypename

GetTypename returns ModifyMetricModifyMetricMetricResponse.Typename, and is useful for accessing the field via an interface.

type ModifyMetricModifyMetricMetricResponseMetric

type ModifyMetricModifyMetricMetricResponseMetric struct {
	MetricData `json:"-"`
}

ModifyMetricModifyMetricMetricResponseMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*ModifyMetricModifyMetricMetricResponseMetric) GetAccessControlEnabled added in v0.1.4

func (v *ModifyMetricModifyMetricMetricResponseMetric) GetAccessControlEnabled() bool

GetAccessControlEnabled returns ModifyMetricModifyMetricMetricResponseMetric.AccessControlEnabled, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetAccount

GetAccount returns ModifyMetricModifyMetricMetricResponseMetric.Account, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetCreatedAt

GetCreatedAt returns ModifyMetricModifyMetricMetricResponseMetric.CreatedAt, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetCreatedBy

GetCreatedBy returns ModifyMetricModifyMetricMetricResponseMetric.CreatedBy, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetDataPool

GetDataPool returns ModifyMetricModifyMetricMetricResponseMetric.DataPool, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetDescription

GetDescription returns ModifyMetricModifyMetricMetricResponseMetric.Description, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetDimensions

GetDimensions returns ModifyMetricModifyMetricMetricResponseMetric.Dimensions, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetEnvironment

GetEnvironment returns ModifyMetricModifyMetricMetricResponseMetric.Environment, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetId

GetId returns ModifyMetricModifyMetricMetricResponseMetric.Id, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetMeasure

GetMeasure returns ModifyMetricModifyMetricMetricResponseMetric.Measure, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetModifiedAt

GetModifiedAt returns ModifyMetricModifyMetricMetricResponseMetric.ModifiedAt, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetModifiedBy

GetModifiedBy returns ModifyMetricModifyMetricMetricResponseMetric.ModifiedBy, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetSettings

GetSettings returns ModifyMetricModifyMetricMetricResponseMetric.Settings, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetTimestamp

GetTimestamp returns ModifyMetricModifyMetricMetricResponseMetric.Timestamp, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetType

GetType returns ModifyMetricModifyMetricMetricResponseMetric.Type, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) GetUniqueName

GetUniqueName returns ModifyMetricModifyMetricMetricResponseMetric.UniqueName, and is useful for accessing the field via an interface.

func (*ModifyMetricModifyMetricMetricResponseMetric) MarshalJSON

func (*ModifyMetricModifyMetricMetricResponseMetric) UnmarshalJSON

type ModifyMetricResponse

type ModifyMetricResponse struct {
	// Modifies a Metric by ID with the provided unique name, description, and Dimensions. If any of the optional arguments are omitted, those properties will be unchanged on the Metric.
	ModifyMetric *ModifyMetricModifyMetricMetricResponse `json:"modifyMetric"`
}

ModifyMetricResponse is returned by ModifyMetric on success.

func ModifyMetric

func ModifyMetric(
	ctx context.Context,
	client graphql.Client,
	input *ModifyMetricInput,
) (*ModifyMetricResponse, error)

func (*ModifyMetricResponse) GetModifyMetric

GetModifyMetric returns ModifyMetricResponse.ModifyMetric, and is useful for accessing the field via an interface.

type ModifyPolicyInput added in v0.1.4

type ModifyPolicyInput struct {
	// The Policy's unique identifier.
	Policy string `json:"policy"`
	// The type of Policy.
	Type PolicyType `json:"type"`
}

The fields for modifying a Policy.

func (*ModifyPolicyInput) GetPolicy added in v0.1.4

func (v *ModifyPolicyInput) GetPolicy() string

GetPolicy returns ModifyPolicyInput.Policy, and is useful for accessing the field via an interface.

func (*ModifyPolicyInput) GetType added in v0.1.4

func (v *ModifyPolicyInput) GetType() PolicyType

GetType returns ModifyPolicyInput.Type, and is useful for accessing the field via an interface.

type ModifyPolicyModifyPolicyPolicyResponse added in v0.1.4

type ModifyPolicyModifyPolicyPolicyResponse struct {
	// The Policy which was created or modified.
	Policy *ModifyPolicyModifyPolicyPolicyResponsePolicy `json:"policy"`
}

ModifyPolicyModifyPolicyPolicyResponse includes the requested fields of the GraphQL type PolicyResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Policy.

func (*ModifyPolicyModifyPolicyPolicyResponse) GetPolicy added in v0.1.4

GetPolicy returns ModifyPolicyModifyPolicyPolicyResponse.Policy, and is useful for accessing the field via an interface.

type ModifyPolicyModifyPolicyPolicyResponsePolicy added in v0.1.4

type ModifyPolicyModifyPolicyPolicyResponsePolicy struct {
	PolicyData `json:"-"`
}

ModifyPolicyModifyPolicyPolicyResponsePolicy includes the requested fields of the GraphQL type Policy. The GraphQL type's documentation follows.

The Policy type. It governs an Application's access to a Metric's data.

func (*ModifyPolicyModifyPolicyPolicyResponsePolicy) GetApplication added in v0.1.4

GetApplication returns ModifyPolicyModifyPolicyPolicyResponsePolicy.Application, and is useful for accessing the field via an interface.

func (*ModifyPolicyModifyPolicyPolicyResponsePolicy) GetId added in v0.1.4

GetId returns ModifyPolicyModifyPolicyPolicyResponsePolicy.Id, and is useful for accessing the field via an interface.

func (*ModifyPolicyModifyPolicyPolicyResponsePolicy) GetMetric added in v0.1.4

GetMetric returns ModifyPolicyModifyPolicyPolicyResponsePolicy.Metric, and is useful for accessing the field via an interface.

func (*ModifyPolicyModifyPolicyPolicyResponsePolicy) GetType added in v0.1.4

GetType returns ModifyPolicyModifyPolicyPolicyResponsePolicy.Type, and is useful for accessing the field via an interface.

func (*ModifyPolicyModifyPolicyPolicyResponsePolicy) MarshalJSON added in v0.1.4

func (*ModifyPolicyModifyPolicyPolicyResponsePolicy) UnmarshalJSON added in v0.1.4

type ModifyPolicyResponse added in v0.1.4

type ModifyPolicyResponse struct {
	// Modifies an existing Policy. You can modify the Application's level of access to the Metric's data.
	ModifyPolicy *ModifyPolicyModifyPolicyPolicyResponse `json:"modifyPolicy"`
}

ModifyPolicyResponse is returned by ModifyPolicy on success.

func ModifyPolicy added in v0.1.4

func ModifyPolicy(
	ctx context.Context,
	client graphql.Client,
	input *ModifyPolicyInput,
) (*ModifyPolicyResponse, error)

func (*ModifyPolicyResponse) GetModifyPolicy added in v0.1.4

GetModifyPolicy returns ModifyPolicyResponse.ModifyPolicy, and is useful for accessing the field via an interface.

type ModifyS3DataSourceInput added in v0.1.3

type ModifyS3DataSourceInput struct {
	// The S3 Data Source's new connection settings. If not provided this property will not be modified.
	ConnectionSettings *PartialS3ConnectionSettingsInput `json:"connectionSettings,omitempty"`
	// The S3 Data Source's new description. If not provided this property will not be modified.
	Description *string `json:"description"`
	// The ID or unique name of the S3 Data Source to modify.
	IdOrUniqueName *IdOrUniqueName `json:"idOrUniqueName,omitempty"`
	// The S3 Data Source's new unique name. If not provided this property will not be modified.
	UniqueName *string `json:"uniqueName"`
}

func (*ModifyS3DataSourceInput) GetConnectionSettings added in v0.1.3

func (v *ModifyS3DataSourceInput) GetConnectionSettings() *PartialS3ConnectionSettingsInput

GetConnectionSettings returns ModifyS3DataSourceInput.ConnectionSettings, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceInput) GetDescription added in v0.1.3

func (v *ModifyS3DataSourceInput) GetDescription() *string

GetDescription returns ModifyS3DataSourceInput.Description, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceInput) GetIdOrUniqueName added in v0.1.3

func (v *ModifyS3DataSourceInput) GetIdOrUniqueName() *IdOrUniqueName

GetIdOrUniqueName returns ModifyS3DataSourceInput.IdOrUniqueName, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceInput) GetUniqueName added in v0.1.3

func (v *ModifyS3DataSourceInput) GetUniqueName() *string

GetUniqueName returns ModifyS3DataSourceInput.UniqueName, and is useful for accessing the field via an interface.

type ModifyS3DataSourceModifyS3DataSourceDataSourceResponse added in v0.1.3

type ModifyS3DataSourceModifyS3DataSourceDataSourceResponse struct {
	// The Data Source which was created or modified.
	DataSource *ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource `json:"dataSource"`
}

ModifyS3DataSourceModifyS3DataSourceDataSourceResponse includes the requested fields of the GraphQL type DataSourceResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Source.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponse) GetDataSource added in v0.1.3

GetDataSource returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponse.DataSource, and is useful for accessing the field via an interface.

type ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource added in v0.1.3

type ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource struct {
	DataSourceData `json:"-"`
}

ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetAccount added in v0.1.3

GetAccount returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Account, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetChecks added in v0.1.3

GetChecks returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Checks, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetConnectionSettings added in v0.1.3

GetConnectionSettings returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetCreatedAt added in v0.1.3

GetCreatedAt returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetCreatedBy added in v0.1.3

GetCreatedBy returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetDataPools added in v1.0.1

GetDataPools returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.DataPools, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetDescription added in v0.1.3

GetDescription returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Description, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetEnvironment added in v0.1.3

GetEnvironment returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Environment, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetError added in v0.1.3

GetError returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Error, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetId added in v0.1.3

GetId returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Id, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetModifiedAt added in v0.1.3

GetModifiedAt returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetModifiedBy added in v0.1.3

GetModifiedBy returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetStatus added in v0.1.3

GetStatus returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Status, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetTableIntrospections added in v0.1.3

GetTableIntrospections returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetTables added in v0.1.3

GetTables returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Tables, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetType added in v0.1.3

GetType returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.Type, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) GetUniqueName added in v0.1.3

GetUniqueName returns ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) MarshalJSON added in v0.1.3

func (*ModifyS3DataSourceModifyS3DataSourceDataSourceResponseDataSource) UnmarshalJSON added in v0.1.3

type ModifyS3DataSourceResponse added in v0.1.3

type ModifyS3DataSourceResponse struct {
	// This mutation selects a Data Source by its ID or unique name and modifies it to have the given unique name, description, and connection settings.
	//
	// If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.
	ModifyS3DataSource *ModifyS3DataSourceModifyS3DataSourceDataSourceResponse `json:"modifyS3DataSource"`
}

ModifyS3DataSourceResponse is returned by ModifyS3DataSource on success.

func ModifyS3DataSource added in v0.1.3

func ModifyS3DataSource(
	ctx context.Context,
	client graphql.Client,
	input *ModifyS3DataSourceInput,
) (*ModifyS3DataSourceResponse, error)

func (*ModifyS3DataSourceResponse) GetModifyS3DataSource added in v0.1.3

GetModifyS3DataSource returns ModifyS3DataSourceResponse.ModifyS3DataSource, and is useful for accessing the field via an interface.

type ModifySnowflakeDataSourceInput

type ModifySnowflakeDataSourceInput struct {
	// The ID or unique name of the Data Source to modify.
	IdOrUniqueName *IdOrUniqueName `json:"idOrUniqueName,omitempty"`
	// The Data Source's new unique name.
	UniqueName *string `json:"uniqueName"`
	// The Data Source's new description.
	Description *string `json:"description"`
	// The Data Source's new connection settings.
	ConnectionSettings *PartialSnowflakeConnectionSettingsInput `json:"connectionSettings,omitempty"`
}

The fields for modifying a Snowflake Data Source.

func (*ModifySnowflakeDataSourceInput) GetConnectionSettings

GetConnectionSettings returns ModifySnowflakeDataSourceInput.ConnectionSettings, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceInput) GetDescription

func (v *ModifySnowflakeDataSourceInput) GetDescription() *string

GetDescription returns ModifySnowflakeDataSourceInput.Description, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceInput) GetIdOrUniqueName

func (v *ModifySnowflakeDataSourceInput) GetIdOrUniqueName() *IdOrUniqueName

GetIdOrUniqueName returns ModifySnowflakeDataSourceInput.IdOrUniqueName, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceInput) GetUniqueName

func (v *ModifySnowflakeDataSourceInput) GetUniqueName() *string

GetUniqueName returns ModifySnowflakeDataSourceInput.UniqueName, and is useful for accessing the field via an interface.

type ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceOrFailureResponse

type ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceOrFailureResponse interface {

	// GetTypename returns the receiver's concrete GraphQL type-name (see interface doc for possible values).
	GetTypename() *string
	// contains filtered or unexported methods
}

ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceOrFailureResponse includes the requested fields of the GraphQL interface DataSourceOrFailureResponse.

ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceOrFailureResponse is implemented by the following types: ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponse ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponse The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a DataSource.

If successful, an `DataSourceResponse` will be returned; otherwise, a `FailureResponse` will be returned.

type ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponse

type ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponse struct {
	Typename *string `json:"__typename"`
	// The Data Source which was created or modified.
	DataSource *ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource `json:"dataSource"`
}

ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponse includes the requested fields of the GraphQL type DataSourceResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Source.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponse) GetDataSource

GetDataSource returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponse.DataSource, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponse) GetTypename

GetTypename returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponse.Typename, and is useful for accessing the field via an interface.

type ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource

type ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource struct {
	DataSourceData `json:"-"`
}

ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetAccount

GetAccount returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Account, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetChecks

GetChecks returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Checks, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetConnectionSettings

GetConnectionSettings returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetCreatedAt

GetCreatedAt returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetCreatedBy

GetCreatedBy returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetDataPools added in v1.0.1

GetDataPools returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.DataPools, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetDescription

GetDescription returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Description, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetEnvironment

GetEnvironment returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Environment, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetError

GetError returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Error, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetId

GetId returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Id, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetModifiedAt

GetModifiedAt returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetModifiedBy

GetModifiedBy returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetStatus

GetStatus returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Status, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetTableIntrospections

GetTableIntrospections returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetTables

GetTables returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Tables, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetType

GetType returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.Type, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) GetUniqueName

GetUniqueName returns ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) MarshalJSON

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceResponseDataSource) UnmarshalJSON

type ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponse

type ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponse struct {
	Typename *string `json:"__typename"`
	// The error that caused the failure.
	Error *ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError `json:"error"`
}

ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponse includes the requested fields of the GraphQL type FailureResponse. The GraphQL type's documentation follows.

The failure response object.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponse) GetError

GetError returns ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponse.Error, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponse) GetTypename

GetTypename returns ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponse.Typename, and is useful for accessing the field via an interface.

type ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError

type ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError struct {
	GqlError `json:"-"`
}

ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError) GetCode

GetCode returns ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError.Code, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError) GetMessage

GetMessage returns ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError.Message, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError) MarshalJSON

func (*ModifySnowflakeDataSourceModifySnowflakeDataSourceFailureResponseError) UnmarshalJSON

type ModifySnowflakeDataSourceResponse

type ModifySnowflakeDataSourceResponse struct {
	// Modifies a Data Source with the provided unique name, description, and connection settings. If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.
	ModifySnowflakeDataSource *ModifySnowflakeDataSourceModifySnowflakeDataSourceDataSourceOrFailureResponse `json:"-"`
}

ModifySnowflakeDataSourceResponse is returned by ModifySnowflakeDataSource on success.

func (*ModifySnowflakeDataSourceResponse) GetModifySnowflakeDataSource

GetModifySnowflakeDataSource returns ModifySnowflakeDataSourceResponse.ModifySnowflakeDataSource, and is useful for accessing the field via an interface.

func (*ModifySnowflakeDataSourceResponse) MarshalJSON

func (v *ModifySnowflakeDataSourceResponse) MarshalJSON() ([]byte, error)

func (*ModifySnowflakeDataSourceResponse) UnmarshalJSON

func (v *ModifySnowflakeDataSourceResponse) UnmarshalJSON(b []byte) error

type ModifyWebhookDataSourceInput added in v1.0.1

type ModifyWebhookDataSourceInput struct {
	// The Webhook Data Source's new connection settings. If not provided this property will not be modified.
	ConnectionSettings *PartialWebhookConnectionSettingsInput `json:"connectionSettings,omitempty"`
	// The Webhook Data Source's new description. If not provided this property will not be modified.
	Description *string `json:"description"`
	// The ID or unique name of the Webhook Data Source to modify.
	IdOrUniqueName *IdOrUniqueName `json:"idOrUniqueName,omitempty"`
	// The Webhook Data Source's new unique name. If not provided this property will not be modified.
	UniqueName *string `json:"uniqueName"`
}

func (*ModifyWebhookDataSourceInput) GetConnectionSettings added in v1.0.1

GetConnectionSettings returns ModifyWebhookDataSourceInput.ConnectionSettings, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceInput) GetDescription added in v1.0.1

func (v *ModifyWebhookDataSourceInput) GetDescription() *string

GetDescription returns ModifyWebhookDataSourceInput.Description, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceInput) GetIdOrUniqueName added in v1.0.1

func (v *ModifyWebhookDataSourceInput) GetIdOrUniqueName() *IdOrUniqueName

GetIdOrUniqueName returns ModifyWebhookDataSourceInput.IdOrUniqueName, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceInput) GetUniqueName added in v1.0.1

func (v *ModifyWebhookDataSourceInput) GetUniqueName() *string

GetUniqueName returns ModifyWebhookDataSourceInput.UniqueName, and is useful for accessing the field via an interface.

type ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponse added in v1.0.1

type ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponse struct {
	// The Data Source which was created or modified.
	DataSource *ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource `json:"dataSource"`
}

ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponse includes the requested fields of the GraphQL type DataSourceResponse. The GraphQL type's documentation follows.

The result of a mutation which creates or modifies a Data Source.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponse) GetDataSource added in v1.0.1

GetDataSource returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponse.DataSource, and is useful for accessing the field via an interface.

type ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource added in v1.0.1

type ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource struct {
	DataSourceData `json:"-"`
}

ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetAccount added in v1.0.1

GetAccount returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Account, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetChecks added in v1.0.1

GetChecks returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Checks, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetConnectionSettings added in v1.0.1

GetConnectionSettings returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.ConnectionSettings, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetCreatedAt added in v1.0.1

GetCreatedAt returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.CreatedAt, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetCreatedBy added in v1.0.1

GetCreatedBy returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.CreatedBy, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetDataPools added in v1.0.1

GetDataPools returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.DataPools, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetDescription added in v1.0.1

GetDescription returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Description, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetEnvironment added in v1.0.1

GetEnvironment returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Environment, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetError added in v1.0.1

GetError returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Error, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetId added in v1.0.1

GetId returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Id, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetModifiedAt added in v1.0.1

GetModifiedAt returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.ModifiedAt, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetModifiedBy added in v1.0.1

GetModifiedBy returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.ModifiedBy, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetStatus added in v1.0.1

GetStatus returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Status, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetTableIntrospections added in v1.0.1

GetTableIntrospections returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.TableIntrospections, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetTables added in v1.0.1

GetTables returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Tables, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetType added in v1.0.1

GetType returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.Type, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) GetUniqueName added in v1.0.1

GetUniqueName returns ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource.UniqueName, and is useful for accessing the field via an interface.

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) MarshalJSON added in v1.0.1

func (*ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponseDataSource) UnmarshalJSON added in v1.0.1

type ModifyWebhookDataSourceResponse added in v1.0.1

type ModifyWebhookDataSourceResponse struct {
	// Modifies the Data Source by the ID or unique name provided with the given unique name, description, and connection settings.
	//
	// If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.
	ModifyWebhookDataSource *ModifyWebhookDataSourceModifyWebhookDataSourceDataSourceResponse `json:"modifyWebhookDataSource"`
}

ModifyWebhookDataSourceResponse is returned by ModifyWebhookDataSource on success.

func ModifyWebhookDataSource added in v1.0.1

func ModifyWebhookDataSource(
	ctx context.Context,
	client graphql.Client,
	input *ModifyWebhookDataSourceInput,
) (*ModifyWebhookDataSourceResponse, error)

func (*ModifyWebhookDataSourceResponse) GetModifyWebhookDataSource added in v1.0.1

GetModifyWebhookDataSource returns ModifyWebhookDataSourceResponse.ModifyWebhookDataSource, and is useful for accessing the field via an interface.

type PageInfoData

type PageInfoData struct {
	// Points to the first item returned in the results. Used when paginating backward.
	StartCursor *string `json:"startCursor"`
	// Points to the last item returned in the results. Used when paginating forward.
	EndCursor *string `json:"endCursor"`
	// A boolean that indicates whether a next page of results exists. Can be used to display a "next page" button in user interfaces, for example.
	HasNextPage bool `json:"hasNextPage"`
	// A boolean that indicates whether a previous page of results exists. Can be used to display a "previous page" button in user interfaces, for example.
	HasPreviousPage bool `json:"hasPreviousPage"`
}

PageInfoData includes the GraphQL fields of PageInfo requested by the fragment PageInfoData. The GraphQL type's documentation follows.

The page info object used for pagination.

func (*PageInfoData) GetEndCursor

func (v *PageInfoData) GetEndCursor() *string

GetEndCursor returns PageInfoData.EndCursor, and is useful for accessing the field via an interface.

func (*PageInfoData) GetHasNextPage

func (v *PageInfoData) GetHasNextPage() bool

GetHasNextPage returns PageInfoData.HasNextPage, and is useful for accessing the field via an interface.

func (*PageInfoData) GetHasPreviousPage

func (v *PageInfoData) GetHasPreviousPage() bool

GetHasPreviousPage returns PageInfoData.HasPreviousPage, and is useful for accessing the field via an interface.

func (*PageInfoData) GetStartCursor

func (v *PageInfoData) GetStartCursor() *string

GetStartCursor returns PageInfoData.StartCursor, and is useful for accessing the field via an interface.

type PartialHttpConnectionSettingsInput added in v0.1.3

type PartialHttpConnectionSettingsInput struct {
	// The HTTP Basic authentication settings for uploading new data.
	//
	// If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it's OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.
	BasicAuth *HttpBasicAuthInput `json:"basicAuth,omitempty"`
	// Set this to `false` to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.
	BasicAuthEnabled *bool `json:"basicAuthEnabled"`
	// The HTTP Data Source's tables. If not provided this property will not be modified.
	Tables []*HttpDataSourceTableInput `json:"tables,omitempty"`
}

The HTTP Data Source connection settings.

func (*PartialHttpConnectionSettingsInput) GetBasicAuth added in v0.1.3

GetBasicAuth returns PartialHttpConnectionSettingsInput.BasicAuth, and is useful for accessing the field via an interface.

func (*PartialHttpConnectionSettingsInput) GetBasicAuthEnabled added in v0.1.3

func (v *PartialHttpConnectionSettingsInput) GetBasicAuthEnabled() *bool

GetBasicAuthEnabled returns PartialHttpConnectionSettingsInput.BasicAuthEnabled, and is useful for accessing the field via an interface.

func (*PartialHttpConnectionSettingsInput) GetTables added in v0.1.3

GetTables returns PartialHttpConnectionSettingsInput.Tables, and is useful for accessing the field via an interface.

type PartialS3ConnectionSettingsInput added in v0.1.3

type PartialS3ConnectionSettingsInput struct {
	// The AWS access key ID for an IAM user with sufficient access to the S3 bucket. If not provided this property will not be modified.
	AwsAccessKeyId *string `json:"awsAccessKeyId"`
	// The AWS secret access key for an IAM user with sufficient access to the S3 bucket. If not provided this property will not be modified.
	AwsSecretAccessKey *string `json:"awsSecretAccessKey"`
	// The name of the S3 bucket. If not provided this property will not be modified.
	Bucket *string `json:"bucket"`
	// The S3 Data Source's tables. If not provided this property will not be modified.
	Tables []*S3DataSourceTableInput `json:"tables,omitempty"`
}

The connection settings for an S3 Data Source. These include the S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.

func (*PartialS3ConnectionSettingsInput) GetAwsAccessKeyId added in v0.1.3

func (v *PartialS3ConnectionSettingsInput) GetAwsAccessKeyId() *string

GetAwsAccessKeyId returns PartialS3ConnectionSettingsInput.AwsAccessKeyId, and is useful for accessing the field via an interface.

func (*PartialS3ConnectionSettingsInput) GetAwsSecretAccessKey added in v0.1.3

func (v *PartialS3ConnectionSettingsInput) GetAwsSecretAccessKey() *string

GetAwsSecretAccessKey returns PartialS3ConnectionSettingsInput.AwsSecretAccessKey, and is useful for accessing the field via an interface.

func (*PartialS3ConnectionSettingsInput) GetBucket added in v0.1.3

func (v *PartialS3ConnectionSettingsInput) GetBucket() *string

GetBucket returns PartialS3ConnectionSettingsInput.Bucket, and is useful for accessing the field via an interface.

func (*PartialS3ConnectionSettingsInput) GetTables added in v0.1.3

GetTables returns PartialS3ConnectionSettingsInput.Tables, and is useful for accessing the field via an interface.

type PartialSnowflakeConnectionSettingsInput

type PartialSnowflakeConnectionSettingsInput struct {
	// The Snowflake account. Only include the part before the "snowflakecomputing.com" part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like "znXXXXX.us-east-2.aws". For Google Cloud-based accounts, this looks like "ffXXXXX.us-central1.gcp". If not provided this property will not be modified.
	Account *string `json:"account"`
	// The Snowflake database name. If not provided this property will not be modified.
	Database *string `json:"database"`
	// The Snowflake warehouse name. It should be "PROPELLING" if you used the default name in the setup script. If not provided this property will not be modified.
	Warehouse *string `json:"warehouse"`
	// The Snowflake schema. If not provided this property will not be modified.
	Schema *string `json:"schema"`
	// The Snowflake username. It should be "PROPEL" if you used the default name in the setup script. If not provided this property will not be modified.
	Username *string `json:"username"`
	// The Snowflake password. If not provided this property will not be modified.
	Password *string `json:"password"`
	// The Snowflake role. It should be "PROPELLER" if you used the default name in the setup script. If not provided this property will not be modified.
	Role *string `json:"role"`
}

The fields for modifying a Snowflake Data Source's connection settings.

func (*PartialSnowflakeConnectionSettingsInput) GetAccount

GetAccount returns PartialSnowflakeConnectionSettingsInput.Account, and is useful for accessing the field via an interface.

func (*PartialSnowflakeConnectionSettingsInput) GetDatabase

GetDatabase returns PartialSnowflakeConnectionSettingsInput.Database, and is useful for accessing the field via an interface.

func (*PartialSnowflakeConnectionSettingsInput) GetPassword

GetPassword returns PartialSnowflakeConnectionSettingsInput.Password, and is useful for accessing the field via an interface.

func (*PartialSnowflakeConnectionSettingsInput) GetRole

GetRole returns PartialSnowflakeConnectionSettingsInput.Role, and is useful for accessing the field via an interface.

func (*PartialSnowflakeConnectionSettingsInput) GetSchema

GetSchema returns PartialSnowflakeConnectionSettingsInput.Schema, and is useful for accessing the field via an interface.

func (*PartialSnowflakeConnectionSettingsInput) GetUsername

GetUsername returns PartialSnowflakeConnectionSettingsInput.Username, and is useful for accessing the field via an interface.

func (*PartialSnowflakeConnectionSettingsInput) GetWarehouse

GetWarehouse returns PartialSnowflakeConnectionSettingsInput.Warehouse, and is useful for accessing the field via an interface.

type PartialWebhookConnectionSettingsInput added in v1.0.1

type PartialWebhookConnectionSettingsInput struct {
	// The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it's OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.
	BasicAuth *HttpBasicAuthInput `json:"basicAuth,omitempty"`
	// Set this to `false` to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.
	BasicAuthEnabled *bool `json:"basicAuthEnabled"`
}

The Webhook Data Source connection settings.

func (*PartialWebhookConnectionSettingsInput) GetBasicAuth added in v1.0.1

GetBasicAuth returns PartialWebhookConnectionSettingsInput.BasicAuth, and is useful for accessing the field via an interface.

func (*PartialWebhookConnectionSettingsInput) GetBasicAuthEnabled added in v1.0.1

func (v *PartialWebhookConnectionSettingsInput) GetBasicAuthEnabled() *bool

GetBasicAuthEnabled returns PartialWebhookConnectionSettingsInput.BasicAuthEnabled, and is useful for accessing the field via an interface.

type PolicyData added in v0.1.4

type PolicyData struct {
	// The Policy's unique identifier.
	Id string `json:"id"`
	// The type of Policy.
	Type PolicyType `json:"type"`
	// The Metric that the Application is granted access to.
	Metric *PolicyDataMetric `json:"metric"`
	// The Application that is granted access.
	Application *PolicyDataApplication `json:"application"`
}

PolicyData includes the GraphQL fields of Policy requested by the fragment PolicyData. The GraphQL type's documentation follows.

The Policy type. It governs an Application's access to a Metric's data.

func (*PolicyData) GetApplication added in v0.1.4

func (v *PolicyData) GetApplication() *PolicyDataApplication

GetApplication returns PolicyData.Application, and is useful for accessing the field via an interface.

func (*PolicyData) GetId added in v0.1.4

func (v *PolicyData) GetId() string

GetId returns PolicyData.Id, and is useful for accessing the field via an interface.

func (*PolicyData) GetMetric added in v0.1.4

func (v *PolicyData) GetMetric() *PolicyDataMetric

GetMetric returns PolicyData.Metric, and is useful for accessing the field via an interface.

func (*PolicyData) GetType added in v0.1.4

func (v *PolicyData) GetType() PolicyType

GetType returns PolicyData.Type, and is useful for accessing the field via an interface.

type PolicyDataApplication added in v0.1.4

type PolicyDataApplication struct {
	// The Application's unique identifier.
	Id string `json:"id"`
}

PolicyDataApplication includes the requested fields of the GraphQL type Application. The GraphQL type's documentation follows.

The Application object.

Propel Applications represent the web or mobile app you are building. They provide the API credentials that allow your client- or server-side app to access the Propel API. The Application's Propeller determines the speed and cost of your Metric Queries.

[Learn more about Applications](https://www.propeldata.com/docs/applications).

func (*PolicyDataApplication) GetId added in v0.1.4

func (v *PolicyDataApplication) GetId() string

GetId returns PolicyDataApplication.Id, and is useful for accessing the field via an interface.

type PolicyDataMetric added in v0.1.4

type PolicyDataMetric struct {
	// The Metric's unique identifier.
	Id string `json:"id"`
}

PolicyDataMetric includes the requested fields of the GraphQL type Metric. The GraphQL type's documentation follows.

The Metric object.

A Metric is a business indicator measured over time.

[Learn more about Metrics](/docs/key-concepts#metric).

func (*PolicyDataMetric) GetId added in v0.1.4

func (v *PolicyDataMetric) GetId() string

GetId returns PolicyDataMetric.Id, and is useful for accessing the field via an interface.

type PolicyPolicy added in v0.1.4

type PolicyPolicy struct {
	PolicyData `json:"-"`
}

PolicyPolicy includes the requested fields of the GraphQL type Policy. The GraphQL type's documentation follows.

The Policy type. It governs an Application's access to a Metric's data.

func (*PolicyPolicy) GetApplication added in v0.1.4

func (v *PolicyPolicy) GetApplication() *PolicyDataApplication

GetApplication returns PolicyPolicy.Application, and is useful for accessing the field via an interface.

func (*PolicyPolicy) GetId added in v0.1.4

func (v *PolicyPolicy) GetId() string

GetId returns PolicyPolicy.Id, and is useful for accessing the field via an interface.

func (*PolicyPolicy) GetMetric added in v0.1.4

func (v *PolicyPolicy) GetMetric() *PolicyDataMetric

GetMetric returns PolicyPolicy.Metric, and is useful for accessing the field via an interface.

func (*PolicyPolicy) GetType added in v0.1.4

func (v *PolicyPolicy) GetType() PolicyType

GetType returns PolicyPolicy.Type, and is useful for accessing the field via an interface.

func (*PolicyPolicy) MarshalJSON added in v0.1.4

func (v *PolicyPolicy) MarshalJSON() ([]byte, error)

func (*PolicyPolicy) UnmarshalJSON added in v0.1.4

func (v *PolicyPolicy) UnmarshalJSON(b []byte) error

type PolicyResponse added in v0.1.4

type PolicyResponse struct {
	// Returns a Policy by ID.
	Policy *PolicyPolicy `json:"policy"`
}

PolicyResponse is returned by Policy on success.

func Policy added in v0.1.4

func Policy(
	ctx context.Context,
	client graphql.Client,
	id string,
) (*PolicyResponse, error)

func (*PolicyResponse) GetPolicy added in v0.1.4

func (v *PolicyResponse) GetPolicy() *PolicyPolicy

GetPolicy returns PolicyResponse.Policy, and is useful for accessing the field via an interface.

type PolicyType added in v0.1.4

type PolicyType string

The types of Policies that can be applied to a Metric.

const (
	// Grants access to all Metric data.
	PolicyTypeAllAccess PolicyType = "ALL_ACCESS"
	// Grants access to a specified tenant's Metric data.
	PolicyTypeTenantAccess PolicyType = "TENANT_ACCESS"
)

type ReplacingMergeTreeTableEngineInput added in v1.2.1

type ReplacingMergeTreeTableEngineInput struct {
	// The type is always `REPLACING_MERGE_TREE`.
	Type *TableEngineType `json:"type"`
	// The `ver` parameter to the ReplacingMergeTree engine.
	Ver *string `json:"ver"`
}

Parameters for the ReplacingMergeTree table engine.

func (*ReplacingMergeTreeTableEngineInput) GetType added in v1.2.1

GetType returns ReplacingMergeTreeTableEngineInput.Type, and is useful for accessing the field via an interface.

func (*ReplacingMergeTreeTableEngineInput) GetVer added in v1.2.1

GetVer returns ReplacingMergeTreeTableEngineInput.Ver, and is useful for accessing the field via an interface.

type S3ConnectionSettingsInput

type S3ConnectionSettingsInput struct {
	// The AWS access key ID for an IAM user with sufficient access to the S3 bucket.
	AwsAccessKeyId string `json:"awsAccessKeyId"`
	// The AWS secret access key for an IAM user with sufficient access to the S3 bucket.
	AwsSecretAccessKey string `json:"awsSecretAccessKey"`
	// The name of the S3 bucket.
	Bucket string `json:"bucket"`
	// The S3 Data Source's tables.
	Tables []*S3DataSourceTableInput `json:"tables,omitempty"`
}

The connection settings for an S3 Data Source. These include the S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.

func (*S3ConnectionSettingsInput) GetAwsAccessKeyId

func (v *S3ConnectionSettingsInput) GetAwsAccessKeyId() string

GetAwsAccessKeyId returns S3ConnectionSettingsInput.AwsAccessKeyId, and is useful for accessing the field via an interface.

func (*S3ConnectionSettingsInput) GetAwsSecretAccessKey

func (v *S3ConnectionSettingsInput) GetAwsSecretAccessKey() string

GetAwsSecretAccessKey returns S3ConnectionSettingsInput.AwsSecretAccessKey, and is useful for accessing the field via an interface.

func (*S3ConnectionSettingsInput) GetBucket

func (v *S3ConnectionSettingsInput) GetBucket() string

GetBucket returns S3ConnectionSettingsInput.Bucket, and is useful for accessing the field via an interface.

func (*S3ConnectionSettingsInput) GetTables

GetTables returns S3ConnectionSettingsInput.Tables, and is useful for accessing the field via an interface.

type S3DataSourceColumnInput

type S3DataSourceColumnInput struct {
	// The column name. It has to be unique within a Table.
	Name string `json:"name"`
	// The column type.
	Type ColumnType `json:"type"`
	// Whether the column's type is nullable or not.
	Nullable bool `json:"nullable"`
}

The fields for specifying a column in an S3 Data Source's table.

func (*S3DataSourceColumnInput) GetName

func (v *S3DataSourceColumnInput) GetName() string

GetName returns S3DataSourceColumnInput.Name, and is useful for accessing the field via an interface.

func (*S3DataSourceColumnInput) GetNullable

func (v *S3DataSourceColumnInput) GetNullable() bool

GetNullable returns S3DataSourceColumnInput.Nullable, and is useful for accessing the field via an interface.

func (*S3DataSourceColumnInput) GetType

func (v *S3DataSourceColumnInput) GetType() ColumnType

GetType returns S3DataSourceColumnInput.Type, and is useful for accessing the field via an interface.

type S3DataSourceTableInput

type S3DataSourceTableInput struct {
	// The name of the table
	Name string `json:"name"`
	// The path to the table's files in S3.
	Path *string `json:"path"`
	// All the columns present in the table
	Columns []*S3DataSourceColumnInput `json:"columns,omitempty"`
}

The fields for specifying an S3 Data Source's table.

func (*S3DataSourceTableInput) GetColumns

GetColumns returns S3DataSourceTableInput.Columns, and is useful for accessing the field via an interface.

func (*S3DataSourceTableInput) GetName

func (v *S3DataSourceTableInput) GetName() string

GetName returns S3DataSourceTableInput.Name, and is useful for accessing the field via an interface.

func (*S3DataSourceTableInput) GetPath

func (v *S3DataSourceTableInput) GetPath() *string

GetPath returns S3DataSourceTableInput.Path, and is useful for accessing the field via an interface.

type SnowflakeConnectionSettingsInput

type SnowflakeConnectionSettingsInput struct {
	// The Snowflake account. Only include the part before the "snowflakecomputing.com" part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like "znXXXXX.us-east-2.aws". For Google Cloud-based accounts, this looks like "ffXXXXX.us-central1.gcp".
	Account string `json:"account"`
	// The Snowflake database name.
	Database string `json:"database"`
	// The Snowflake warehouse name. It should be "PROPELLING" if you used the default name in the setup script.
	Warehouse string `json:"warehouse"`
	// The Snowflake schema.
	Schema string `json:"schema"`
	// The Snowflake username. It should be "PROPEL" if you used the default name in the setup script.
	Username string `json:"username"`
	// The Snowflake password.
	Password string `json:"password"`
	// The Snowflake role. It should be "PROPELLER" if you used the default name in the setup script.
	Role string `json:"role"`
}

The fields for creating a Snowflake Data Source's connection settings.

func (*SnowflakeConnectionSettingsInput) GetAccount

func (v *SnowflakeConnectionSettingsInput) GetAccount() string

GetAccount returns SnowflakeConnectionSettingsInput.Account, and is useful for accessing the field via an interface.

func (*SnowflakeConnectionSettingsInput) GetDatabase

func (v *SnowflakeConnectionSettingsInput) GetDatabase() string

GetDatabase returns SnowflakeConnectionSettingsInput.Database, and is useful for accessing the field via an interface.

func (*SnowflakeConnectionSettingsInput) GetPassword

func (v *SnowflakeConnectionSettingsInput) GetPassword() string

GetPassword returns SnowflakeConnectionSettingsInput.Password, and is useful for accessing the field via an interface.

func (*SnowflakeConnectionSettingsInput) GetRole

GetRole returns SnowflakeConnectionSettingsInput.Role, and is useful for accessing the field via an interface.

func (*SnowflakeConnectionSettingsInput) GetSchema

GetSchema returns SnowflakeConnectionSettingsInput.Schema, and is useful for accessing the field via an interface.

func (*SnowflakeConnectionSettingsInput) GetUsername

func (v *SnowflakeConnectionSettingsInput) GetUsername() string

GetUsername returns SnowflakeConnectionSettingsInput.Username, and is useful for accessing the field via an interface.

func (*SnowflakeConnectionSettingsInput) GetWarehouse

func (v *SnowflakeConnectionSettingsInput) GetWarehouse() string

GetWarehouse returns SnowflakeConnectionSettingsInput.Warehouse, and is useful for accessing the field via an interface.

type SummingMergeTreeTableEngineInput added in v1.2.1

type SummingMergeTreeTableEngineInput struct {
	// The type is always `SUMMING_MERGE_TREE`.
	Type *TableEngineType `json:"type"`
	// The columns argument for the SummingMergeTree table engine
	Columns []string `json:"columns"`
}

Parameters for the SummingMergeTree table engine.

func (*SummingMergeTreeTableEngineInput) GetColumns added in v1.2.1

func (v *SummingMergeTreeTableEngineInput) GetColumns() []string

GetColumns returns SummingMergeTreeTableEngineInput.Columns, and is useful for accessing the field via an interface.

func (*SummingMergeTreeTableEngineInput) GetType added in v1.2.1

GetType returns SummingMergeTreeTableEngineInput.Type, and is useful for accessing the field via an interface.

type SyncData

type SyncData struct {
	// The Sync's unique identifier.
	Id string `json:"id"`
	// The status of the Sync (all Syncs begin as SYNCING before transitioning to SUCCEEDED or FAILED).
	Status SyncStatus `json:"status"`
	// The number of new records contained within the Sync, if known. This excludes filtered records.
	NewRecords *string `json:"newRecords"`
	// The number of updated records contained within the Sync, if known. This excludes filtered records.
	UpdatedRecords *string `json:"updatedRecords"`
	// The number of deleted records contained within the Sync, if known. This excludes filtered records.
	DeletedRecords *string `json:"deletedRecords"`
	// The number of filtered records contained within the Sync, due to issues such as a missing timestamp Dimension, if any are known to be invalid.
	InvalidRecords *string `json:"invalidRecords"`
	// The time at which the Sync started.
	StartedAt *time.Time `json:"startedAt"`
	// The time at which the Sync succeeded.
	SucceededAt *time.Time `json:"succeededAt"`
	// The time at which the Sync failed.
	FailedAt *time.Time `json:"failedAt"`
	// If the Sync failed, this represents the reason the Sync failed.
	Error *SyncDataError `json:"error"`
	// The Sync's creation date and time in UTC.
	CreatedAt time.Time `json:"createdAt"`
	// The Sync's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	CreatedBy string `json:"createdBy"`
	// The Sync's last modification date and time in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The Sync's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	ModifiedBy string `json:"modifiedBy"`
}

SyncData includes the GraphQL fields of Sync requested by the fragment SyncData. The GraphQL type's documentation follows.

The Sync object.

This represents the process of syncing data from your Data Source (for example, a Snowflake data warehouse) to your Data Pool.

func (*SyncData) GetCreatedAt

func (v *SyncData) GetCreatedAt() time.Time

GetCreatedAt returns SyncData.CreatedAt, and is useful for accessing the field via an interface.

func (*SyncData) GetCreatedBy

func (v *SyncData) GetCreatedBy() string

GetCreatedBy returns SyncData.CreatedBy, and is useful for accessing the field via an interface.

func (*SyncData) GetDeletedRecords

func (v *SyncData) GetDeletedRecords() *string

GetDeletedRecords returns SyncData.DeletedRecords, and is useful for accessing the field via an interface.

func (*SyncData) GetError

func (v *SyncData) GetError() *SyncDataError

GetError returns SyncData.Error, and is useful for accessing the field via an interface.

func (*SyncData) GetFailedAt

func (v *SyncData) GetFailedAt() *time.Time

GetFailedAt returns SyncData.FailedAt, and is useful for accessing the field via an interface.

func (*SyncData) GetId

func (v *SyncData) GetId() string

GetId returns SyncData.Id, and is useful for accessing the field via an interface.

func (*SyncData) GetInvalidRecords

func (v *SyncData) GetInvalidRecords() *string

GetInvalidRecords returns SyncData.InvalidRecords, and is useful for accessing the field via an interface.

func (*SyncData) GetModifiedAt

func (v *SyncData) GetModifiedAt() time.Time

GetModifiedAt returns SyncData.ModifiedAt, and is useful for accessing the field via an interface.

func (*SyncData) GetModifiedBy

func (v *SyncData) GetModifiedBy() string

GetModifiedBy returns SyncData.ModifiedBy, and is useful for accessing the field via an interface.

func (*SyncData) GetNewRecords

func (v *SyncData) GetNewRecords() *string

GetNewRecords returns SyncData.NewRecords, and is useful for accessing the field via an interface.

func (*SyncData) GetStartedAt

func (v *SyncData) GetStartedAt() *time.Time

GetStartedAt returns SyncData.StartedAt, and is useful for accessing the field via an interface.

func (*SyncData) GetStatus

func (v *SyncData) GetStatus() SyncStatus

GetStatus returns SyncData.Status, and is useful for accessing the field via an interface.

func (*SyncData) GetSucceededAt

func (v *SyncData) GetSucceededAt() *time.Time

GetSucceededAt returns SyncData.SucceededAt, and is useful for accessing the field via an interface.

func (*SyncData) GetUpdatedRecords

func (v *SyncData) GetUpdatedRecords() *string

GetUpdatedRecords returns SyncData.UpdatedRecords, and is useful for accessing the field via an interface.

type SyncDataError

type SyncDataError struct {
	// The error message.
	Message string `json:"message"`
}

SyncDataError includes the requested fields of the GraphQL type Error. The GraphQL type's documentation follows.

The error object.

func (*SyncDataError) GetMessage

func (v *SyncDataError) GetMessage() string

GetMessage returns SyncDataError.Message, and is useful for accessing the field via an interface.

type SyncStatus

type SyncStatus string

The status of a Sync.

const (
	// Propel is actively syncing records contained within the Sync.
	SyncStatusSyncing SyncStatus = "SYNCING"
	// The Sync succeeded. Propel successfully synced all records contained within the Sync.
	SyncStatusSucceeded SyncStatus = "SUCCEEDED"
	// The Sync failed. Propel failed to sync some or all records contained within the Sync.
	SyncStatusFailed SyncStatus = "FAILED"
	// Propel is deleting the Sync.
	SyncStatusDeleting SyncStatus = "DELETING"
)

type TableEngineInput added in v1.2.1

type TableEngineInput struct {
	// Field for specifying the MergeTree table engine.
	MergeTree *MergeTreeTableEngineInput `json:"mergeTree,omitempty"`
	// Field for specifying the ReplacingMergeTree table engine.
	ReplacingMergeTree *ReplacingMergeTreeTableEngineInput `json:"replacingMergeTree,omitempty"`
	// Field for specifying the SummingMergeTree table engine.
	SummingMergeTree *SummingMergeTreeTableEngineInput `json:"summingMergeTree,omitempty"`
	// Field for specifying the AggregatingMergeTree table engine.
	AggregatingMergeTree *AggregatingMergeTreeTableEngineInput `json:"aggregatingMergeTree,omitempty"`
}

A Data Pool's table engine.

func (*TableEngineInput) GetAggregatingMergeTree added in v1.2.1

func (v *TableEngineInput) GetAggregatingMergeTree() *AggregatingMergeTreeTableEngineInput

GetAggregatingMergeTree returns TableEngineInput.AggregatingMergeTree, and is useful for accessing the field via an interface.

func (*TableEngineInput) GetMergeTree added in v1.2.1

func (v *TableEngineInput) GetMergeTree() *MergeTreeTableEngineInput

GetMergeTree returns TableEngineInput.MergeTree, and is useful for accessing the field via an interface.

func (*TableEngineInput) GetReplacingMergeTree added in v1.2.1

func (v *TableEngineInput) GetReplacingMergeTree() *ReplacingMergeTreeTableEngineInput

GetReplacingMergeTree returns TableEngineInput.ReplacingMergeTree, and is useful for accessing the field via an interface.

func (*TableEngineInput) GetSummingMergeTree added in v1.2.1

func (v *TableEngineInput) GetSummingMergeTree() *SummingMergeTreeTableEngineInput

GetSummingMergeTree returns TableEngineInput.SummingMergeTree, and is useful for accessing the field via an interface.

type TableEngineType added in v1.2.1

type TableEngineType string

ClickHouse table engine types.

const (
	// The MergeTree table engine.
	TableEngineTypeMergeTree TableEngineType = "MERGE_TREE"
	// The ReplacingMergeTree table engine.
	TableEngineTypeReplacingMergeTree TableEngineType = "REPLACING_MERGE_TREE"
	// The SummingMergeTree table engine.
	TableEngineTypeSummingMergeTree TableEngineType = "SUMMING_MERGE_TREE"
	// The AggregatingMergeTree table engine.
	TableEngineTypeAggregatingMergeTree TableEngineType = "AGGREGATING_MERGE_TREE"
)

type TableIntrospectionData

type TableIntrospectionData struct {
	// The Data Source the table introspection was performed for.
	DataSource *TableIntrospectionDataDataSource `json:"dataSource"`
	// The status of the table introspection.
	Status TableIntrospectionStatus `json:"status"`
	// The table introspection's creation date and time in UTC.
	CreatedAt time.Time `json:"createdAt"`
	// The table introspection's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
	CreatedBy string `json:"createdBy"`
	// The table introspection's last modification date and time in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The table introspection's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
	ModifiedBy string `json:"modifiedBy"`
	// The number of tables introspected.
	NumTables *int `json:"numTables"`
}

TableIntrospectionData includes the GraphQL fields of TableIntrospection requested by the fragment TableIntrospectionData. The GraphQL type's documentation follows.

The table introspection object.

When setting up a Data Source, Propel may need to introspect tables in order to determine what tables and columns are available to create Data Pools from. The table introspection represents the lifecycle of this operation (whether it's in-progress, succeeded, or failed) and the resulting tables and columns. These will be captured as table and column objects, respectively.

func (*TableIntrospectionData) GetCreatedAt

func (v *TableIntrospectionData) GetCreatedAt() time.Time

GetCreatedAt returns TableIntrospectionData.CreatedAt, and is useful for accessing the field via an interface.

func (*TableIntrospectionData) GetCreatedBy

func (v *TableIntrospectionData) GetCreatedBy() string

GetCreatedBy returns TableIntrospectionData.CreatedBy, and is useful for accessing the field via an interface.

func (*TableIntrospectionData) GetDataSource

GetDataSource returns TableIntrospectionData.DataSource, and is useful for accessing the field via an interface.

func (*TableIntrospectionData) GetModifiedAt

func (v *TableIntrospectionData) GetModifiedAt() time.Time

GetModifiedAt returns TableIntrospectionData.ModifiedAt, and is useful for accessing the field via an interface.

func (*TableIntrospectionData) GetModifiedBy

func (v *TableIntrospectionData) GetModifiedBy() string

GetModifiedBy returns TableIntrospectionData.ModifiedBy, and is useful for accessing the field via an interface.

func (*TableIntrospectionData) GetNumTables

func (v *TableIntrospectionData) GetNumTables() *int

GetNumTables returns TableIntrospectionData.NumTables, and is useful for accessing the field via an interface.

func (*TableIntrospectionData) GetStatus

GetStatus returns TableIntrospectionData.Status, and is useful for accessing the field via an interface.

type TableIntrospectionDataDataSource

type TableIntrospectionDataDataSource struct {
	// The Data Source's unique identifier.
	Id string `json:"id"`
}

TableIntrospectionDataDataSource includes the requested fields of the GraphQL type DataSource. The GraphQL type's documentation follows.

The Data Source object.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

[Learn more about Data Sources](https://www.propeldata.com/docs/data-sources).

func (*TableIntrospectionDataDataSource) GetId

GetId returns TableIntrospectionDataDataSource.Id, and is useful for accessing the field via an interface.

type TableIntrospectionStatus

type TableIntrospectionStatus string

The status of a table introspection.

const (
	// The table introspection has not started.
	TableIntrospectionStatusNotStarted TableIntrospectionStatus = "NOT_STARTED"
	// The table introspection has started.
	TableIntrospectionStatusStarted TableIntrospectionStatus = "STARTED"
	// The table introspection succeeded.
	TableIntrospectionStatusSucceeded TableIntrospectionStatus = "SUCCEEDED"
	// The table introspection failed.
	TableIntrospectionStatusFailed TableIntrospectionStatus = "FAILED"
)

type TableSettingsInput added in v1.2.1

type TableSettingsInput struct {
	// The ClickHouse table engine for the Data Pool's table.
	//
	// This field is optional. A default will be chosen based on the Data Pool's `timestamp` and `uniqueId` values, if specified.
	Engine *TableEngineInput `json:"engine,omitempty"`
	// The PARTITION BY clause for the Data Pool's table.
	//
	// This field is optional. A default will be chosen based on the Data Pool's `timestamp` and `uniqueId` values, if specified.
	PartitionBy []string `json:"partitionBy"`
	// The PRIMARY KEY clause for the Data Pool's table.
	//
	// This field is optional. A default will be chosen based on the Data Pool's `timestamp` and `uniqueId` values, if specified.
	PrimaryKey []string `json:"primaryKey"`
	// The ORDER BY clause for the Data Pool's table.
	//
	// This field is optional. A default will be chosen based on the Data Pool's `timestamp` and `uniqueId` values, if specified.
	OrderBy []string `json:"orderBy"`
}

A Data Pool's table settings.

These describe how the Data Pool's table is created in ClickHouse.

func (*TableSettingsInput) GetEngine added in v1.2.1

func (v *TableSettingsInput) GetEngine() *TableEngineInput

GetEngine returns TableSettingsInput.Engine, and is useful for accessing the field via an interface.

func (*TableSettingsInput) GetOrderBy added in v1.2.1

func (v *TableSettingsInput) GetOrderBy() []string

GetOrderBy returns TableSettingsInput.OrderBy, and is useful for accessing the field via an interface.

func (*TableSettingsInput) GetPartitionBy added in v1.2.1

func (v *TableSettingsInput) GetPartitionBy() []string

GetPartitionBy returns TableSettingsInput.PartitionBy, and is useful for accessing the field via an interface.

func (*TableSettingsInput) GetPrimaryKey added in v1.2.1

func (v *TableSettingsInput) GetPrimaryKey() []string

GetPrimaryKey returns TableSettingsInput.PrimaryKey, and is useful for accessing the field via an interface.

type TenantData added in v1.2.1

type TenantData struct {
	// The name of the column that represents the tenant ID.
	ColumnName string `json:"columnName"`
	// The tenant ID column's type.
	Type string `json:"type"`
}

TenantData includes the GraphQL fields of Tenant requested by the fragment TenantData. The GraphQL type's documentation follows.

A Data Pool's tenant ID column. The tenant ID column is used to control access to your data with access policies.

func (*TenantData) GetColumnName added in v1.2.1

func (v *TenantData) GetColumnName() string

GetColumnName returns TenantData.ColumnName, and is useful for accessing the field via an interface.

func (*TenantData) GetType added in v1.2.1

func (v *TenantData) GetType() string

GetType returns TenantData.Type, and is useful for accessing the field via an interface.

type TenantInput

type TenantInput struct {
	// The name of the column that represents the tenant ID.
	ColumnName string `json:"columnName"`
}

The fields to specify the Data Pool's tenant ID column. The tenant ID column is used to control access to your data with access policies.

func (*TenantInput) GetColumnName

func (v *TenantInput) GetColumnName() string

GetColumnName returns TenantInput.ColumnName, and is useful for accessing the field via an interface.

type TimestampData

type TimestampData struct {
	// The name of the column that represents the primary timestamp.
	ColumnName string `json:"columnName"`
	// The primary timestamp column's type.
	Type string `json:"type"`
}

TimestampData includes the GraphQL fields of Timestamp requested by the fragment TimestampData. The GraphQL type's documentation follows.

A Data Pool's primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

func (*TimestampData) GetColumnName

func (v *TimestampData) GetColumnName() string

GetColumnName returns TimestampData.ColumnName, and is useful for accessing the field via an interface.

func (*TimestampData) GetType

func (v *TimestampData) GetType() string

GetType returns TimestampData.Type, and is useful for accessing the field via an interface.

type TimestampInput

type TimestampInput struct {
	// The name of the column that represents the primary timestamp.
	ColumnName string `json:"columnName"`
}

The fields to specify the Data Pool's primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

func (*TimestampInput) GetColumnName

func (v *TimestampInput) GetColumnName() string

GetColumnName returns TimestampInput.ColumnName, and is useful for accessing the field via an interface.

type UnAssignDataPoolAccessPolicyResponse added in v1.1.0

type UnAssignDataPoolAccessPolicyResponse struct {
	// Unassign a Data Pool Access Policy from an Application.
	//
	// Once unassigned, whether the Application will be able to query the Data Pool is
	// controlled by the Data Pool's `accessControlEnabled` property. If
	// `accessControlEnabled` is true, the Application will no longer be able to query the
	// Data Pool. If `accessControlEnabled` is false, the Application will be able to query
	// *all* data in the Data Pool, unrestricted.
	UnAssignDataPoolAccessPolicyFromApplication *string `json:"unAssignDataPoolAccessPolicyFromApplication"`
}

UnAssignDataPoolAccessPolicyResponse is returned by UnAssignDataPoolAccessPolicy on success.

func UnAssignDataPoolAccessPolicy added in v1.1.0

func UnAssignDataPoolAccessPolicy(
	ctx context.Context,
	client graphql.Client,
	dataPoolAccessPolicy string,
	application string,
) (*UnAssignDataPoolAccessPolicyResponse, error)

func (*UnAssignDataPoolAccessPolicyResponse) GetUnAssignDataPoolAccessPolicyFromApplication added in v1.1.0

func (v *UnAssignDataPoolAccessPolicyResponse) GetUnAssignDataPoolAccessPolicyFromApplication() *string

GetUnAssignDataPoolAccessPolicyFromApplication returns UnAssignDataPoolAccessPolicyResponse.UnAssignDataPoolAccessPolicyFromApplication, and is useful for accessing the field via an interface.

type UniqueIdInput added in v1.0.0

type UniqueIdInput struct {
	// The name of the column that represents the unique ID.
	ColumnName string `json:"columnName"`
}

The fields to specify the Data Pool's unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

func (*UniqueIdInput) GetColumnName added in v1.0.0

func (v *UniqueIdInput) GetColumnName() string

GetColumnName returns UniqueIdInput.ColumnName, and is useful for accessing the field via an interface.

type WebhookConnectionSettingsInput added in v1.0.1

type WebhookConnectionSettingsInput struct {
	// The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it's OK to test without HTTP Basic authentication, we recommend enabling it.
	BasicAuth *HttpBasicAuthInput `json:"basicAuth,omitempty"`
	// The additional columns for the Webhook Data Source table.
	Columns []*WebhookDataSourceColumnInput `json:"columns,omitempty"`
	// Override the Data Pool's table settings. These describe how the Data Pool's table is created in ClickHouse, and a
	// default will be chosen based on the Data Pool's `timestamp` and `uniqueId` values, if any. You can override these
	// defaults in order to specify a custom table engine, custom ORDER BY, etc.
	TableSettings *TableSettingsInput `json:"tableSettings,omitempty"`
	// The tenant ID column, if any.
	Tenant *string `json:"tenant"`
	// The primary timestamp column, if any.
	Timestamp *string `json:"timestamp"`
	// The unique ID column, if any. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated.
	UniqueId *string `json:"uniqueId"`
}

The Webhook Data Source connection settings.

func (*WebhookConnectionSettingsInput) GetBasicAuth added in v1.0.1

GetBasicAuth returns WebhookConnectionSettingsInput.BasicAuth, and is useful for accessing the field via an interface.

func (*WebhookConnectionSettingsInput) GetColumns added in v1.0.1

GetColumns returns WebhookConnectionSettingsInput.Columns, and is useful for accessing the field via an interface.

func (*WebhookConnectionSettingsInput) GetTableSettings added in v1.2.1

func (v *WebhookConnectionSettingsInput) GetTableSettings() *TableSettingsInput

GetTableSettings returns WebhookConnectionSettingsInput.TableSettings, and is useful for accessing the field via an interface.

func (*WebhookConnectionSettingsInput) GetTenant added in v1.0.1

func (v *WebhookConnectionSettingsInput) GetTenant() *string

GetTenant returns WebhookConnectionSettingsInput.Tenant, and is useful for accessing the field via an interface.

func (*WebhookConnectionSettingsInput) GetTimestamp added in v1.0.1

func (v *WebhookConnectionSettingsInput) GetTimestamp() *string

GetTimestamp returns WebhookConnectionSettingsInput.Timestamp, and is useful for accessing the field via an interface.

func (*WebhookConnectionSettingsInput) GetUniqueId added in v1.0.1

func (v *WebhookConnectionSettingsInput) GetUniqueId() *string

GetUniqueId returns WebhookConnectionSettingsInput.UniqueId, and is useful for accessing the field via an interface.

type WebhookDataSourceColumnInput added in v1.0.1

type WebhookDataSourceColumnInput struct {
	// The column name. It has to be unique within a Table.
	Name string `json:"name"`
	// The JSON property that the column will be derived from. For example, if you POST a JSON event like this:
	// “`json
	// { "greeting": { "message": "hello, world" } }
	// “`
	// Then you can use the JSON property "greeting.message" to extract "hello, world" to a column.
	JsonProperty string `json:"jsonProperty"`
	// The column type.
	Type ColumnType `json:"type"`
	// Whether the column's type is nullable or not.
	Nullable bool `json:"nullable"`
}

The fields for specifying a column in an Webhook Data Source's table.

func (*WebhookDataSourceColumnInput) GetJsonProperty added in v1.0.1

func (v *WebhookDataSourceColumnInput) GetJsonProperty() string

GetJsonProperty returns WebhookDataSourceColumnInput.JsonProperty, and is useful for accessing the field via an interface.

func (*WebhookDataSourceColumnInput) GetName added in v1.0.1

func (v *WebhookDataSourceColumnInput) GetName() string

GetName returns WebhookDataSourceColumnInput.Name, and is useful for accessing the field via an interface.

func (*WebhookDataSourceColumnInput) GetNullable added in v1.0.1

func (v *WebhookDataSourceColumnInput) GetNullable() bool

GetNullable returns WebhookDataSourceColumnInput.Nullable, and is useful for accessing the field via an interface.

func (*WebhookDataSourceColumnInput) GetType added in v1.0.1

GetType returns WebhookDataSourceColumnInput.Type, and is useful for accessing the field via an interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL