rockset

package
v0.8.0 Latest Latest
Warning

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

 Go to latest Published: Feb 14, 2020 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	// contains filtered or unexported fields
}

APIClient manages communication with the REST API API vv1 In most cases there should be only one, shared, APIClient.

func ApiClient 

func ApiClient(cfg *Configuration, apiKey string) *APIClient

Client creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddDocumentsRequest 

type AddDocumentsRequest struct {
	// Array of JSON documents
	Data []interface{} `json:"data"`
}

func (AddDocumentsRequest) PrintResponse 

func (m AddDocumentsRequest) PrintResponse()

type AddDocumentsResponse 

type AddDocumentsResponse struct {
	// information about the added documents
	Data []DocumentStatus `json:"data,omitempty"`
}

func (AddDocumentsResponse) PrintResponse 

func (m AddDocumentsResponse) PrintResponse()

type ApiKey 

type ApiKey struct {
	// ISO-8601 date
	CreatedAt string `json:"created_at,omitempty"`
	// descriptive label
	Name string `json:"name"`
	// string of 64 alphanumeric characters
	Key string `json:"key"`
}

API keys are used to authenticate requests to Rockset's API. An API key is tied to the user who creates it. A new API key can be created for each use case, with a maximum of 10 API keys per user.

func (ApiKey) PrintResponse 

func (m ApiKey) PrintResponse()

type ApiKeysApiService 

type ApiKeysApiService Service

func (*ApiKeysApiService) Create 

func (a *ApiKeysApiService) Create(body CreateApiKeyRequest) (CreateApiKeyResponse, *http.Response, error)

ApiKeysApiService Create API Key Create a new API key for the authenticated user.

  • @param body JSON object

@return CreateApiKeyResponse

func (*ApiKeysApiService) CreateStream 

func (a *ApiKeysApiService) CreateStream(body CreateApiKeyRequest) (string, *http.Response, error)

func (*ApiKeysApiService) Create_1 

func (a *ApiKeysApiService) Create_1(body CreateApiKeyRequest, user string) (CreateApiKeyResponse, *http.Response, error)

ApiKeysApiService Create API Key for any user (admin only) Create a new API key for any user (admin only).

  • @param body JSON object
  • @param user

@return CreateApiKeyResponse

func (*ApiKeysApiService) Create_1Stream 

func (a *ApiKeysApiService) Create_1Stream(body CreateApiKeyRequest, user string) (string, *http.Response, error)

func (*ApiKeysApiService) Delete 

func (a *ApiKeysApiService) Delete(name string) (DeleteApiKeyResponse, *http.Response, error)

ApiKeysApiService Delete API Key Delete an API key for the authenticated user.

  • @param name name of the API key

@return DeleteApiKeyResponse

func (*ApiKeysApiService) DeleteStream 

func (a *ApiKeysApiService) DeleteStream(name string) (string, *http.Response, error)

func (*ApiKeysApiService) Delete_2 

func (a *ApiKeysApiService) Delete_2(name string, user string) (DeleteApiKeyResponse, *http.Response, error)

ApiKeysApiService Delete API Key for any user (admin only) Delete an API key for any user (admin only).

  • @param name name of the API key
  • @param user

@return DeleteApiKeyResponse

func (*ApiKeysApiService) Delete_2Stream 

func (a *ApiKeysApiService) Delete_2Stream(name string, user string) (string, *http.Response, error)

func (*ApiKeysApiService) List 

func (a *ApiKeysApiService) List() (ListApiKeysResponse, *http.Response, error)

ApiKeysApiService List API Keys List all API keys for the authenticated user.

@return ListApiKeysResponse

func (*ApiKeysApiService) ListStream 

func (a *ApiKeysApiService) ListStream() (string, *http.Response, error)

func (*ApiKeysApiService) List_3 

func (a *ApiKeysApiService) List_3(user string) (ListApiKeysResponse, *http.Response, error)

ApiKeysApiService List API Keys for any user (admin only) List all API keys for any user (admin only).

  • @param user

@return ListApiKeysResponse

func (*ApiKeysApiService) List_3Stream 

func (a *ApiKeysApiService) List_3Stream(user string) (string, *http.Response, error)

type AwsAccessKey added in v0.6.0 

type AwsAccessKey struct {
	// AWS access key ID
	AwsAccessKeyId string `json:"aws_access_key_id"`
	// AWS secret access key
	AwsSecretAccessKey string `json:"aws_secret_access_key"`
}

func (AwsAccessKey) PrintResponse added in v0.6.0 

func (m AwsAccessKey) PrintResponse()

type AwsExternalIdIntegration 

type AwsExternalIdIntegration struct {
	// ARN of rockset-role created in your account
	AwsRoleArn     string `json:"aws_role_arn"`
	AwsExternalId  string `json:"aws_external_id,omitempty"`
	RocksetIamUser string `json:"rockset_iam_user,omitempty"`
}

func (AwsExternalIdIntegration) PrintResponse 

func (m AwsExternalIdIntegration) PrintResponse()

type AwsKeyIntegration 

type AwsKeyIntegration struct {
	// AWS access key ID
	AwsAccessKeyId string `json:"aws_access_key_id"`
	// AWS secret access key
	AwsSecretAccessKey string `json:"aws_secret_access_key"`
}

func (AwsKeyIntegration) PrintResponse 

func (m AwsKeyIntegration) PrintResponse()

type AwsRole added in v0.6.0 

type AwsRole struct {
	// ARN of rockset-role created in your account
	AwsRoleArn string `json:"aws_role_arn"`
}

func (AwsRole) PrintResponse added in v0.6.0 

func (m AwsRole) PrintResponse()

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Collection added in v0.6.0 

type Collection struct {
	// ISO-8601 date
	CreatedAt string `json:"created_at,omitempty"`
	// email of user who created the collection
	CreatedBy string `json:"created_by,omitempty"`
	// unique identifer for collection, can contain alphanumeric or dash characters
	Name string `json:"name,omitempty"`
	// text describing the collection
	Description string `json:"description,omitempty"`
	// name of the workspace that the collection is in
	Workspace string `json:"workspace,omitempty"`
	// current status of collection, one of: CREATED, READY, DELETED
	Status string `json:"status,omitempty"`
	// list of sources from which collection ingests
	Sources []Source `json:"sources,omitempty"`
	// metrics about the collection
	Stats *CollectionStats `json:"stats,omitempty"`
	// number of seconds after which data is purged based on event time
	RetentionSecs int64 `json:"retention_secs,omitempty"`
	// list of mappings applied on all documents in a collection
	FieldMappings []FieldMappingV2 `json:"field_mappings,omitempty"`
}

func (Collection) PrintResponse added in v0.6.0 

func (m Collection) PrintResponse()

type CollectionStats added in v0.6.0 

type CollectionStats struct {
	// number of documents in the collection
	DocCount int64 `json:"doc_count,omitempty"`
	// total collection size in bytes
	TotalSize int64 `json:"total_size,omitempty"`
	// number between 0 and 1 that indicates progress of collection creation
	FillProgress float64 `json:"fill_progress,omitempty"`
	// number of documents purged from the collection
	PurgedDocCount int64 `json:"purged_doc_count,omitempty"`
	// total collection size in bytes purged
	PurgedDocSize int64 `json:"purged_doc_size,omitempty"`
	// milliseconds since Unix epoch Jan 1, 1970
	LastUpdatedMs int64 `json:"last_updated_ms,omitempty"`
	// milliseconds since Unix epoch Jan 1, 1970
	LastQueriedMs int64 `json:"last_queried_ms,omitempty"`
	// total number of bytes inserted into the collection
	BytesInserted int64 `json:"bytes_inserted,omitempty"`
	// total number of bytes overwritten in writing into the collection
	BytesOverwritten int64 `json:"bytes_overwritten,omitempty"`
}

func (CollectionStats) PrintResponse added in v0.6.0 

func (m CollectionStats) PrintResponse()

type CollectionsApiService 

type CollectionsApiService Service

func (*CollectionsApiService) Create 

func (a *CollectionsApiService) Create(workspace string, body CreateCollectionRequest) (CreateCollectionResponse, *http.Response, error)

CollectionsApiService Create Collection Create new collection in a workspace.

  • @param workspace name of the workspace
  • @param body JSON object

@return CreateCollectionResponse

func (*CollectionsApiService) CreateStream 

func (a *CollectionsApiService) CreateStream(workspace string, body CreateCollectionRequest) (string, *http.Response, error)

func (*CollectionsApiService) Delete 

func (a *CollectionsApiService) Delete(workspace string, collection string) (DeleteCollectionResponse, *http.Response, error)

CollectionsApiService Delete Collection Delete a collection and all its documents from Rockset.

  • @param workspace name of the workspace
  • @param collection name of the collection

@return DeleteCollectionResponse

func (*CollectionsApiService) DeleteStream 

func (a *CollectionsApiService) DeleteStream(workspace string, collection string) (string, *http.Response, error)

func (*CollectionsApiService) Get 

func (a *CollectionsApiService) Get(workspace string, collection string) (GetCollectionResponse, *http.Response, error)

CollectionsApiService Get Collection Get details about a collection.

  • @param workspace name of the workspace
  • @param collection name of the collection

@return GetCollectionResponse

func (*CollectionsApiService) GetStream 

func (a *CollectionsApiService) GetStream(workspace string, collection string) (string, *http.Response, error)

func (*CollectionsApiService) List 

func (a *CollectionsApiService) List() (ListCollectionsResponse, *http.Response, error)

CollectionsApiService List Collections Retrieve all collections in an organization.

@return ListCollectionsResponse

func (*CollectionsApiService) ListStream 

func (a *CollectionsApiService) ListStream() (string, *http.Response, error)

func (*CollectionsApiService) Workspace added in v0.8.0 

func (a *CollectionsApiService) Workspace(workspace string) (ListCollectionsResponse, *http.Response, error)

CollectionsApiService List Collections for Workspace Retrieve all collections in a workspace.

  • @param workspace name of the workspace

@return ListCollectionsResponse

func (*CollectionsApiService) WorkspaceStream added in v0.8.0 

func (a *CollectionsApiService) WorkspaceStream(workspace string) (string, *http.Response, error)

type CommitMark 

type CommitMark struct {
}

func (CommitMark) PrintResponse 

func (m CommitMark) PrintResponse()

type CommitMarkPositions 

type CommitMarkPositions struct {
}

func (CommitMarkPositions) PrintResponse 

func (m CommitMarkPositions) PrintResponse()

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
	Version       string
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateApiKeyRequest 

type CreateApiKeyRequest struct {
	// descriptive label
	Name string `json:"name"`
}

func (CreateApiKeyRequest) PrintResponse 

func (m CreateApiKeyRequest) PrintResponse()

type CreateApiKeyResponse 

type CreateApiKeyResponse struct {
	// the API key that was created
	Data *ApiKey `json:"data,omitempty"`
}

func (CreateApiKeyResponse) PrintResponse 

func (m CreateApiKeyResponse) PrintResponse()

type CreateCollectionRequest 

type CreateCollectionRequest struct {
	// unique identifer for collection, can contain alphanumeric or dash characters
	Name string `json:"name"`
	// text describing the collection
	Description string `json:"description,omitempty"`
	// list of sources from which to ingest data
	Sources []Source `json:"sources,omitempty"`
	// number of seconds after which data is purged, based on event time
	RetentionSecs int64 `json:"retention_secs,omitempty"`
	// configuration for event data
	EventTimeInfo *EventTimeInfo `json:"event_time_info,omitempty"`
	// list of mappings
	FieldMappings []FieldMappingV2 `json:"field_mappings,omitempty"`
}

func (CreateCollectionRequest) PrintResponse 

func (m CreateCollectionRequest) PrintResponse()

type CreateCollectionResponse 

type CreateCollectionResponse struct {
	// collection that was created
	Data *Collection `json:"data,omitempty"`
}

func (CreateCollectionResponse) PrintResponse 

func (m CreateCollectionResponse) PrintResponse()

type CreateIntegrationRequest 

type CreateIntegrationRequest struct {
	// descriptive label
	Name string `json:"name"`
	// longer explanation for the integration
	Description string `json:"description,omitempty"`
	// Amazon S3 details, must have one of aws_access_key or aws_role
	S3 *S3Integration `json:"s3,omitempty"`
	// Amazon Kinesis details, must have one of aws_access_key or aws_role
	Kinesis *KinesisIntegration `json:"kinesis,omitempty"`
	// Amazon DynamoDB details, must have one of aws_access_key or aws_role
	Dynamodb *DynamodbIntegration `json:"dynamodb,omitempty"`
	// Amazon Redshift details
	Redshift *RedshiftIntegration `json:"redshift,omitempty"`
	// GCS details
	Gcs     *GcsIntegration     `json:"gcs,omitempty"`
	Segment *SegmentIntegration `json:"segment,omitempty"`
	Kafka   *KafkaIntegration   `json:"kafka,omitempty"`
}

func (CreateIntegrationRequest) PrintResponse 

func (m CreateIntegrationRequest) PrintResponse()

type CreateIntegrationResponse 

type CreateIntegrationResponse struct {
	// integration object that was created
	Data *Integration `json:"data,omitempty"`
}

func (CreateIntegrationResponse) PrintResponse 

func (m CreateIntegrationResponse) PrintResponse()

type CreateSavedQueryRequest added in v0.8.0 

type CreateSavedQueryRequest struct {
	// query name
	Name string `json:"name"`
	// optional version tag
	VersionTag string `json:"version_tag,omitempty"`
	// SQL text of this query
	QuerySql string `json:"query_sql"`
	// parameters associated with this query
	Parameters []SavedQueryParameter `json:"parameters,omitempty"`
}

func (CreateSavedQueryRequest) PrintResponse added in v0.8.0 

func (m CreateSavedQueryRequest) PrintResponse()

type CreateSavedQueryResponse added in v0.8.0 

type CreateSavedQueryResponse struct {
	// saved query data
	Data *SavedQuery `json:"data,omitempty"`
}

func (CreateSavedQueryResponse) PrintResponse added in v0.8.0 

func (m CreateSavedQueryResponse) PrintResponse()

type CreateUserRequest 

type CreateUserRequest struct {
	// user email, must be unique
	Email string `json:"email"`
	// List of roles for a given user
	Roles []string `json:"roles,omitempty"`
}

func (CreateUserRequest) PrintResponse 

func (m CreateUserRequest) PrintResponse()

type CreateUserResponse 

type CreateUserResponse struct {
	// user that was created
	Data *User `json:"data,omitempty"`
}

func (CreateUserResponse) PrintResponse 

func (m CreateUserResponse) PrintResponse()

type CreateWorkspaceRequest added in v0.6.0 

type CreateWorkspaceRequest struct {
	// descriptive label and unique identifier
	Name string `json:"name"`
	// longer explanation for the workspace
	Description string `json:"description,omitempty"`
}

func (CreateWorkspaceRequest) PrintResponse added in v0.6.0 

func (m CreateWorkspaceRequest) PrintResponse()

type CreateWorkspaceResponse added in v0.6.0 

type CreateWorkspaceResponse struct {
	// the workspace that was created
	Data *Workspace `json:"data,omitempty"`
}

func (CreateWorkspaceResponse) PrintResponse added in v0.6.0 

func (m CreateWorkspaceResponse) PrintResponse()

type CsvParams 

type CsvParams struct {
	// If the first line in every object specifies the column names
	FirstLineAsColumnNames bool `json:"firstLineAsColumnNames,omitempty"`
	// a single character that is the column seperator
	Separator string `json:"separator,omitempty"`
	// can be one of: UTF-8, ISO_8859_1, UTF-16
	Encoding string `json:"encoding,omitempty"`
	// names of columns
	ColumnNames []string `json:"columnNames,omitempty"`
	// names of columns
	ColumnTypes []string `json:"columnTypes,omitempty"`
	// character within which a cell value is enclosed,null character if no such character, default is '\"'
	QuoteChar string `json:"quoteChar,omitempty"`
	// escape character removes any special meaning from the following character,default is '\\'
	EscapeChar string `json:"escapeChar,omitempty"`
}

func (CsvParams) PrintResponse 

func (m CsvParams) PrintResponse()

type DeleteApiKeyResponse 

type DeleteApiKeyResponse struct {
	// the API key that was deleted
	Data *ApiKey `json:"data,omitempty"`
}

func (DeleteApiKeyResponse) PrintResponse 

func (m DeleteApiKeyResponse) PrintResponse()

type DeleteCollectionResponse 

type DeleteCollectionResponse struct {
	// collection that was deleted
	Data *Collection `json:"data,omitempty"`
}

func (DeleteCollectionResponse) PrintResponse 

func (m DeleteCollectionResponse) PrintResponse()

type DeleteDocumentsRequest 

type DeleteDocumentsRequest struct {
	// array of document IDs
	Data []DeleteDocumentsRequestData `json:"data"`
}

func (DeleteDocumentsRequest) PrintResponse 

func (m DeleteDocumentsRequest) PrintResponse()

type DeleteDocumentsRequestData 

type DeleteDocumentsRequestData struct {
	// unique document ID
	Id string `json:"_id"`
}

func (DeleteDocumentsRequestData) PrintResponse 

func (m DeleteDocumentsRequestData) PrintResponse()

type DeleteDocumentsResponse 

type DeleteDocumentsResponse struct {
	// information about deleted documents
	Data []DocumentStatus `json:"data,omitempty"`
}

func (DeleteDocumentsResponse) PrintResponse 

func (m DeleteDocumentsResponse) PrintResponse()

type DeleteIntegrationResponse 

type DeleteIntegrationResponse struct {
	// integration object that was deleted
	Data *Integration `json:"data,omitempty"`
}

func (DeleteIntegrationResponse) PrintResponse 

func (m DeleteIntegrationResponse) PrintResponse()

type DeleteSavedQueryResponse added in v0.8.0 

type DeleteSavedQueryResponse struct {
	// saved query details
	Data *SavedQuery `json:"data,omitempty"`
}

func (DeleteSavedQueryResponse) PrintResponse added in v0.8.0 

func (m DeleteSavedQueryResponse) PrintResponse()

type DeleteUserResponse 

type DeleteUserResponse struct {
	// user object that was deleted
	Data *User `json:"data,omitempty"`
}

func (DeleteUserResponse) PrintResponse 

func (m DeleteUserResponse) PrintResponse()

type DeleteWorkspaceResponse added in v0.6.0 

type DeleteWorkspaceResponse struct {
	// the workspace that was deleted
	Data *Workspace `json:"data,omitempty"`
}

func (DeleteWorkspaceResponse) PrintResponse added in v0.6.0 

func (m DeleteWorkspaceResponse) PrintResponse()

type DocumentStatus 

type DocumentStatus struct {
	// collection name
	Collection string `json:"_collection,omitempty"`
	// error message, if any
	Error_ *ErrorModel `json:"error,omitempty"`
	// unique document ID
	Id string `json:"_id,omitempty"`
	// status, one of ADDED, REPLACED, DELETED, ERROR
	Status string `json:"status,omitempty"`
	// unique id used to represent each patch request
	PatchId string `json:"patch_id,omitempty"`
}

func (DocumentStatus) PrintResponse 

func (m DocumentStatus) PrintResponse()

type DocumentsApiService 

type DocumentsApiService Service

func (*DocumentsApiService) Add 

func (a *DocumentsApiService) Add(workspace string, collection string, body AddDocumentsRequest) (AddDocumentsResponse, *http.Response, error)

DocumentsApiService Add Documents Add documents to a collection in Rockset.

  • @param workspace name of the workspace
  • @param collection name of the collection
  • @param body JSON object

@return AddDocumentsResponse

func (*DocumentsApiService) AddStream 

func (a *DocumentsApiService) AddStream(workspace string, collection string, body AddDocumentsRequest) (string, *http.Response, error)

func (*DocumentsApiService) Delete 

func (a *DocumentsApiService) Delete(workspace string, collection string, body DeleteDocumentsRequest) (DeleteDocumentsResponse, *http.Response, error)

DocumentsApiService Delete Documents Delete documents from a collection in Rockset.

  • @param workspace name of the workspace
  • @param collection name of the collection
  • @param body JSON object

@return DeleteDocumentsResponse

func (*DocumentsApiService) DeleteStream 

func (a *DocumentsApiService) DeleteStream(workspace string, collection string, body DeleteDocumentsRequest) (string, *http.Response, error)

func (*DocumentsApiService) Patch added in v0.8.0 

func (a *DocumentsApiService) Patch(workspace string, collection string, body PatchDocumentsRequest) (PatchDocumentsResponse, *http.Response, error)

DocumentsApiService Patch Documents Patch documents in a collection

  • @param workspace name of the workspace
  • @param collection name of the collection
  • @param body JSON Patch objects

@return PatchDocumentsResponse

func (*DocumentsApiService) PatchStream added in v0.8.0 

func (a *DocumentsApiService) PatchStream(workspace string, collection string, body PatchDocumentsRequest) (string, *http.Response, error)

type DynamodbIntegration added in v0.6.0 

type DynamodbIntegration struct {
	// credentials for an AWS access key integration
	AwsAccessKey *AwsAccessKey `json:"aws_access_key,omitempty"`
	// role used for external id type authentication
	AwsRole *AwsRole `json:"aws_role,omitempty"`
}

func (DynamodbIntegration) PrintResponse added in v0.6.0 

func (m DynamodbIntegration) PrintResponse()

type ErrorModel 

type ErrorModel struct {
	// descriptive message about the error
	Message string `json:"message,omitempty"`
	// category of the error
	Type_ string `json:"type,omitempty"`
	// Line where the error happened (if applicable)
	Line int32 `json:"line,omitempty"`
	// Column where the error happened (if applicable)
	Column int32 `json:"column,omitempty"`
	// Internal trace ID to help with debugging
	TraceId string `json:"trace_id,omitempty"`
}

Describes details about an error

func (ErrorModel) PrintResponse 

func (m ErrorModel) PrintResponse()

type ErrorModelContext 

type ErrorModelContext struct {
	// additional error message
	Lineinfo string `json:"lineinfo,omitempty"`
}

func (ErrorModelContext) PrintResponse 

func (m ErrorModelContext) PrintResponse()

type EventTimeInfo 

type EventTimeInfo struct {
	// name of the field containing event time
	Field string `json:"field"`
	// format of time field, can be one of: milliseconds_since_epoch, seconds_since_epoch
	Format string `json:"format,omitempty"`
	// default time zone, in standard IANA format
	TimeZone string `json:"time_zone,omitempty"`
}

func (EventTimeInfo) PrintResponse 

func (m EventTimeInfo) PrintResponse()

type ExecuteSavedQueryParameter added in v0.8.0 

type ExecuteSavedQueryParameter struct {
	// name of the field
	Name string `json:"name"`
	// literal value of the field
	Value *interface{} `json:"value"`
}

func (ExecuteSavedQueryParameter) PrintResponse added in v0.8.0 

func (m ExecuteSavedQueryParameter) PrintResponse()

type ExecuteSavedQueryRequest added in v0.8.0 

type ExecuteSavedQueryRequest struct {
	// workspace of this saved query
	Workspace string `json:"workspace,omitempty"`
	// query name
	Name string `json:"name,omitempty"`
	// query version
	Version string `json:"version,omitempty"`
	// list of named parameters
	Parameters []ExecuteSavedQueryParameter `json:"parameters,omitempty"`
	// Row limit to use if no limit specified in the query
	DefaultRowLimit int32 `json:"default_row_limit,omitempty"`
	// Whether to generate warnings
	GenerateWarnings bool `json:"generate_warnings,omitempty"`
}

func (ExecuteSavedQueryRequest) PrintResponse added in v0.8.0 

func (m ExecuteSavedQueryRequest) PrintResponse()

type FieldMapping 

type FieldMapping struct {
}

func (FieldMapping) PrintResponse 

func (m FieldMapping) PrintResponse()

type FieldMappingV2 

type FieldMappingV2 struct {
	// A user specified string that is a name for this mapping
	Name string `json:"name,omitempty"`
	// A List of InputField for this mapping
	InputFields []InputField `json:"input_fields,omitempty"`
	// An OutputField for this mapping
	OutputField *OutputField `json:"output_field,omitempty"`
}

func (FieldMappingV2) PrintResponse 

func (m FieldMappingV2) PrintResponse()

type FieldMask 

type FieldMask struct {
	InputPath []string       `json:"input_path"`
	Mask      *FieldMaskMask `json:"mask,omitempty"`
}

func (FieldMask) PrintResponse 

func (m FieldMask) PrintResponse()

type FieldMaskMask 

type FieldMaskMask struct {
	Name string       `json:"name"`
	Args *interface{} `json:"args,omitempty"`
}

Field masking function name + args. The args is a JSON object.

func (FieldMaskMask) PrintResponse 

func (m FieldMaskMask) PrintResponse()

type FormatParams 

type FormatParams struct {
	// source data is in json format
	Json bool       `json:"json,omitempty"`
	Csv  *CsvParams `json:"csv,omitempty"`
	Xml  *XmlParams `json:"xml,omitempty"`
}

func (FormatParams) PrintResponse 

func (m FormatParams) PrintResponse()

type GcpServiceAccount 

type GcpServiceAccount struct {
	// Contents of JSON Service Account key file
	ServiceAccountKeyFileJson string `json:"service_account_key_file_json"`
}

func (GcpServiceAccount) PrintResponse 

func (m GcpServiceAccount) PrintResponse()

type GcsIntegration added in v0.6.0 

type GcsIntegration struct {
	// credentials for an AWS key integration
	GcpServiceAccount *GcpServiceAccount `json:"gcp_service_account,omitempty"`
}

func (GcsIntegration) PrintResponse added in v0.6.0 

func (m GcsIntegration) PrintResponse()

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetCollectionResponse 

type GetCollectionResponse struct {
	// collection that was requested
	Data *Collection `json:"data,omitempty"`
}

func (GetCollectionResponse) PrintResponse 

func (m GetCollectionResponse) PrintResponse()

type GetIntegrationResponse 

type GetIntegrationResponse struct {
	// integration object
	Data        *Integration `json:"data,omitempty"`
	Collections []Collection `json:"collections,omitempty"`
}

func (GetIntegrationResponse) PrintResponse 

func (m GetIntegrationResponse) PrintResponse()

type GetSavedQueryResponse added in v0.8.0 

type GetSavedQueryResponse struct {
	// saved query details
	Data *SavedQuery `json:"data,omitempty"`
}

func (GetSavedQueryResponse) PrintResponse added in v0.8.0 

func (m GetSavedQueryResponse) PrintResponse()

type GetWorkspaceResponse added in v0.6.0 

type GetWorkspaceResponse struct {
	// the workspace that was requested
	Data *Workspace `json:"data,omitempty"`
}

func (GetWorkspaceResponse) PrintResponse added in v0.6.0 

func (m GetWorkspaceResponse) PrintResponse()

type InputField 

type InputField struct {
	// The name of a field, parsed as a SQL qualified name
	FieldName string `json:"field_name,omitempty"`
	// Define the behaviour if fieldName is missing or is null
	IfMissing string `json:"if_missing,omitempty"`
	// If true, then drop fieldName from the document
	IsDrop bool `json:"is_drop,omitempty"`
	// Sql parameter name
	Param string `json:"param,omitempty"`
}

func (InputField) PrintResponse 

func (m InputField) PrintResponse()

type Integration 

type Integration struct {
	// descriptive label and unique identifier
	Name string `json:"name"`
	// longer explanation for the integration
	Description string `json:"description,omitempty"`
	// email of user who created the integration
	CreatedBy string `json:"created_by"`
	// ISO-8601 date
	CreatedAt string `json:"created_at,omitempty"`
	// Amazon S3 details, must have one of aws_access_key or aws_role
	S3 *S3Integration `json:"s3,omitempty"`
	// Amazon Kinesis details, must have one of aws_access_key or aws_role
	Kinesis *KinesisIntegration `json:"kinesis,omitempty"`
	// Amazon DynamoDB details, must have one of aws_access_key or aws_role
	Dynamodb *DynamodbIntegration `json:"dynamodb,omitempty"`
	// Amazon Redshift details
	Redshift *RedshiftIntegration `json:"redshift,omitempty"`
	// GCS details
	Gcs *GcsIntegration `json:"gcs,omitempty"`
	// Segment details
	Segment *SegmentIntegration `json:"segment,omitempty"`
	// Kafka details
	Kafka *KafkaIntegration `json:"kafka,omitempty"`
}

Integrations that can be associated with data sources to create collections. Only one type of integration may be specified.

func (Integration) PrintResponse 

func (m Integration) PrintResponse()

type IntegrationsApiService 

type IntegrationsApiService Service

func (*IntegrationsApiService) Create 

func (a *IntegrationsApiService) Create(body CreateIntegrationRequest) (CreateIntegrationResponse, *http.Response, error)

IntegrationsApiService Create Integration Create a new integration with Rockset.

  • @param body integration credentials

@return CreateIntegrationResponse

func (*IntegrationsApiService) CreateStream 

func (a *IntegrationsApiService) CreateStream(body CreateIntegrationRequest) (string, *http.Response, error)

func (*IntegrationsApiService) Delete 

func (a *IntegrationsApiService) Delete(integration string) (DeleteIntegrationResponse, *http.Response, error)

IntegrationsApiService Delete Integration Remove an integration.

  • @param integration name of the integration

@return DeleteIntegrationResponse

func (*IntegrationsApiService) DeleteStream 

func (a *IntegrationsApiService) DeleteStream(integration string) (string, *http.Response, error)

func (*IntegrationsApiService) Get 

func (a *IntegrationsApiService) Get(integration string) (GetIntegrationResponse, *http.Response, error)

IntegrationsApiService Get Integration Get information about a single integration.

  • @param integration name of the integration

@return GetIntegrationResponse

func (*IntegrationsApiService) GetStream 

func (a *IntegrationsApiService) GetStream(integration string) (string, *http.Response, error)

func (*IntegrationsApiService) List 

func (a *IntegrationsApiService) List() (ListIntegrationsResponse, *http.Response, error)

IntegrationsApiService List Integrations List all integrations for organization.

@return ListIntegrationsResponse

func (*IntegrationsApiService) ListStream 

func (a *IntegrationsApiService) ListStream() (string, *http.Response, error)

type KafkaIntegration added in v0.8.0 

type KafkaIntegration struct {
	// Kafka topics to tail
	KafkaTopicNames []string `json:"kafka_topic_names"`
	// The status of the Kafka source by topic
	SourceStatusByTopic map[string]StatusKafka `json:"source_status_by_topic,omitempty"`
	// The format of the Kafka topics being tailed
	KafkaDataFormat string `json:"kafka_data_format"`
	// segment connection string
	ConnectionString string `json:"connection_string,omitempty"`
}

func (KafkaIntegration) PrintResponse added in v0.8.0 

func (m KafkaIntegration) PrintResponse()

type KinesisIntegration added in v0.6.0 

type KinesisIntegration struct {
	// credentials for an AWS access key integration
	AwsAccessKey *AwsAccessKey `json:"aws_access_key,omitempty"`
	// details of an AWS cross-account role integration
	AwsRole *AwsRole `json:"aws_role,omitempty"`
}

func (KinesisIntegration) PrintResponse added in v0.6.0 

func (m KinesisIntegration) PrintResponse()

type ListApiKeysResponse 

type ListApiKeysResponse struct {
	// list of API key objects
	Data []ApiKey `json:"data,omitempty"`
}

func (ListApiKeysResponse) PrintResponse 

func (m ListApiKeysResponse) PrintResponse()

type ListCollectionsResponse 

type ListCollectionsResponse struct {
	// list of all collections
	Data []Collection `json:"data,omitempty"`
}

func (ListCollectionsResponse) PrintResponse 

func (m ListCollectionsResponse) PrintResponse()

type ListIntegrationsResponse 

type ListIntegrationsResponse struct {
	// list of integration objects
	Data []Integration `json:"data,omitempty"`
}

func (ListIntegrationsResponse) PrintResponse 

func (m ListIntegrationsResponse) PrintResponse()

type ListSavedQueriesResponse added in v0.8.0 

type ListSavedQueriesResponse struct {
	// list of all saved queries
	Data []SavedQuery `json:"data,omitempty"`
}

func (ListSavedQueriesResponse) PrintResponse added in v0.8.0 

func (m ListSavedQueriesResponse) PrintResponse()

type ListUsersResponse 

type ListUsersResponse struct {
	// list of users
	Data []User `json:"data,omitempty"`
}

func (ListUsersResponse) PrintResponse 

func (m ListUsersResponse) PrintResponse()

type ListWorkspacesResponse added in v0.6.0 

type ListWorkspacesResponse struct {
	// list of workspaces
	Data []Workspace `json:"data,omitempty"`
}

func (ListWorkspacesResponse) PrintResponse added in v0.6.0 

func (m ListWorkspacesResponse) PrintResponse()

type Organization 

type Organization struct {
	// unique identifier for the organization
	Id string `json:"id,omitempty"`
	// ISO-8601 date
	CreatedAt string `json:"created_at,omitempty"`
	// name of the organization
	DisplayName string `json:"display_name,omitempty"`
	// name of the company
	CompanyName string `json:"company_name,omitempty"`
	ExternalId  string `json:"external_id,omitempty"`
	RocksetUser string `json:"rockset_user,omitempty"`
	// org state
	State string `json:"state,omitempty"`
}

An organization in Rockset is a container for users and collections.

func (Organization) PrintResponse 

func (m Organization) PrintResponse()

type OrganizationResponse 

type OrganizationResponse struct {
	// Organization object
	Data *Organization `json:"data,omitempty"`
}

func (OrganizationResponse) PrintResponse 

func (m OrganizationResponse) PrintResponse()

type OrganizationsApiService 

type OrganizationsApiService Service

func (*OrganizationsApiService) Get 

func (a *OrganizationsApiService) Get() (OrganizationResponse, *http.Response, error)

OrganizationsApiService Get Organization Retrieve information about current organization.

@return OrganizationResponse

func (*OrganizationsApiService) GetStream 

func (a *OrganizationsApiService) GetStream() (string, *http.Response, error)

type OutputField 

type OutputField struct {
	// The name of a field, parsed as a SQL qualified name
	FieldName string `json:"field_name,omitempty"`
	// The name of a sql function
	Value *SqlExpression `json:"value,omitempty"`
	// Error in Mapping execution: 'skip' or 'fail'
	OnError string `json:"on_error,omitempty"`
}

func (OutputField) PrintResponse 

func (m OutputField) PrintResponse()

type PatchDocument added in v0.8.0 

type PatchDocument struct {
	// Unique id of the document which is being patched
	Id string `json:"_id"`
	// List of patch operations
	Patch []PatchOperation `json:"patch"`
}

func (PatchDocument) PrintResponse added in v0.8.0 

func (m PatchDocument) PrintResponse()

type PatchDocumentsRequest added in v0.8.0 

type PatchDocumentsRequest struct {
	// List of JSON Patch Documents
	Data []PatchDocument `json:"data"`
}

func (PatchDocumentsRequest) PrintResponse added in v0.8.0 

func (m PatchDocumentsRequest) PrintResponse()

type PatchDocumentsResponse added in v0.8.0 

type PatchDocumentsResponse struct {
	Data []DocumentStatus `json:"data"`
}

func (PatchDocumentsResponse) PrintResponse added in v0.8.0 

func (m PatchDocumentsResponse) PrintResponse()

type PatchOperation added in v0.8.0 

type PatchOperation struct {
	// Operation to be performed in this patch
	Op string `json:"op"`
	// JSON-Pointer referencing a location in the target document where theoperation is performed
	Path string `json:"path"`
	// Value used in the patch operation. Required for add, replace and test operations
	Value *interface{} `json:"value,omitempty"`
	// JSON-Pointer referencing a location in the target document.Required for copy and move operations
	From string `json:"from,omitempty"`
}

func (PatchOperation) PrintResponse added in v0.8.0 

func (m PatchOperation) PrintResponse()

type QueriesApiService 

type QueriesApiService Service

func (*QueriesApiService) Create added in v0.8.0 

func (a *QueriesApiService) Create(workspace string, body CreateSavedQueryRequest) (CreateSavedQueryResponse, *http.Response, error)

QueriesApiService Create Saved Query Create a saved query in given workspace.

  • @param workspace name of the workspace
  • @param body JSON object

@return CreateSavedQueryResponse

func (*QueriesApiService) CreateStream added in v0.8.0 

func (a *QueriesApiService) CreateStream(workspace string, body CreateSavedQueryRequest) (string, *http.Response, error)

func (*QueriesApiService) Delete added in v0.8.0 

func (a *QueriesApiService) Delete(workspace string, query string) (DeleteSavedQueryResponse, *http.Response, error)

QueriesApiService Delete Saved Query Delete a saved query.

  • @param workspace name of the workspace
  • @param query name of the query

@return DeleteSavedQueryResponse

func (*QueriesApiService) DeleteStream added in v0.8.0 

func (a *QueriesApiService) DeleteStream(workspace string, query string) (string, *http.Response, error)

func (*QueriesApiService) Get added in v0.8.0 

func (a *QueriesApiService) Get(workspace string, query string, version int32) (GetSavedQueryResponse, *http.Response, error)

QueriesApiService Get Saved Query Version Get a specific version of a saved query

  • @param workspace name of the workspace
  • @param query name of the query
  • @param version version of the query

@return GetSavedQueryResponse

func (*QueriesApiService) GetStream added in v0.8.0 

func (a *QueriesApiService) GetStream(workspace string, query string, version int32) (string, *http.Response, error)

func (*QueriesApiService) List added in v0.8.0 

func (a *QueriesApiService) List() (ListSavedQueriesResponse, *http.Response, error)

QueriesApiService List Saved Queries List all queries.

@return ListSavedQueriesResponse

func (*QueriesApiService) ListStream added in v0.8.0 

func (a *QueriesApiService) ListStream() (string, *http.Response, error)

func (*QueriesApiService) List_1 added in v0.8.0 

func (a *QueriesApiService) List_1(workspace string) (ListSavedQueriesResponse, *http.Response, error)

QueriesApiService List Saved Queries List all queries under given workspace.

  • @param workspace name of the workspace

@return ListSavedQueriesResponse

func (*QueriesApiService) List_1Stream added in v0.8.0 

func (a *QueriesApiService) List_1Stream(workspace string) (string, *http.Response, error)

func (*QueriesApiService) List_2 added in v0.8.0 

func (a *QueriesApiService) List_2(workspace string, query string) (ListSavedQueriesResponse, *http.Response, error)

QueriesApiService List Saved Query Versions List all versions of a saved query.

  • @param workspace name of the workspace
  • @param query name of the query

@return ListSavedQueriesResponse

func (*QueriesApiService) List_2Stream added in v0.8.0 

func (a *QueriesApiService) List_2Stream(workspace string, query string) (string, *http.Response, error)

func (*QueriesApiService) Query 

func (a *QueriesApiService) Query(body QueryRequest) (QueryResponse, *http.Response, error)

QueriesApiService Query Make a SQL query to Rockset.

  • @param body JSON object

@return QueryResponse

func (*QueriesApiService) QueryStream 

func (a *QueriesApiService) QueryStream(body QueryRequest) (string, *http.Response, error)

func (*QueriesApiService) Run added in v0.8.0 

func (a *QueriesApiService) Run(workspace string, query string, version int32, localVarOptionals *RunOpts) (QueryResponse, *http.Response, error)

func (*QueriesApiService) RunStream added in v0.8.0 

func (a *QueriesApiService) RunStream(workspace string, query string, version int32, localVarOptionals *RunOpts) (string, *http.Response, error)

func (*QueriesApiService) Update added in v0.8.0 

func (a *QueriesApiService) Update(workspace string, query string, body UpdateSavedQueryRequest) (UpdateSavedQueryResponse, *http.Response, error)

QueriesApiService Update Saved Query Create a new version of a saved query in given workspace.

  • @param workspace name of the workspace
  • @param query name of the query
  • @param body JSON object

@return UpdateSavedQueryResponse

func (*QueriesApiService) UpdateStream added in v0.8.0 

func (a *QueriesApiService) UpdateStream(workspace string, query string, body UpdateSavedQueryRequest) (string, *http.Response, error)

type QueryFieldType 

type QueryFieldType struct {
	// name of the field
	Name string `json:"name"`
	// data type of the field
	Type_ string `json:"type"`
}

func (QueryFieldType) PrintResponse 

func (m QueryFieldType) PrintResponse()

type QueryParameter 

type QueryParameter struct {
	// name of the field
	Name string `json:"name"`
	// data type of the field
	Type_ string `json:"type"`
	// literal value of the field
	Value string `json:"value"`
}

func (QueryParameter) PrintResponse 

func (m QueryParameter) PrintResponse()

type QueryRequest 

type QueryRequest struct {
	// details about the query
	Sql *QueryRequestSql `json:"sql,omitempty"`
}

func (QueryRequest) PrintResponse 

func (m QueryRequest) PrintResponse()

type QueryRequestSql 

type QueryRequestSql struct {
	// SQL query as a string
	Query string `json:"query"`
	// list of named parameters
	Parameters []QueryParameter `json:"parameters,omitempty"`
	// Row limit to use if no limit specified in the query
	DefaultRowLimit int32 `json:"default_row_limit,omitempty"`
	// Whether to generate warnings
	GenerateWarnings bool `json:"generate_warnings,omitempty"`
}

func (QueryRequestSql) PrintResponse 

func (m QueryRequestSql) PrintResponse()

type QueryResponse 

type QueryResponse struct {
	// list of objects returned by the query
	Results []interface{} `json:"results,omitempty"`
	// list of fields returned by the query
	Fields []QueryFieldType `json:"fields,omitempty"`
	// meta information about the query
	Stats *QueryResponseStats `json:"stats,omitempty"`
	// warnings received from the query
	Warnings []string `json:"warnings,omitempty"`
	// list of collections queried by the query
	Collections []string `json:"collections,omitempty"`
	// meta information about each column in the result set
	ColumnFields []QueryFieldType `json:"column_fields,omitempty"`
}

func (QueryResponse) PrintResponse 

func (m QueryResponse) PrintResponse()

type QueryResponseStats 

type QueryResponseStats struct {
	// query time in milliseconds
	ElapsedTimeMs int64 `json:"elapsed_time_ms,omitempty"`
	// rows scanned as part of query execution
	RowsScanned int64 `json:"rows_scanned,omitempty"`
}

func (QueryResponseStats) PrintResponse 

func (m QueryResponseStats) PrintResponse()

type RedshiftIntegration added in v0.6.0 

type RedshiftIntegration struct {
	// AWS access key credentials
	AwsAccessKey *AwsAccessKey `json:"aws_access_key,omitempty"`
	// Username associated with Redshift cluster
	Username string `json:"username"`
	// Password associated with Redshift cluster
	Password string `json:"password"`
	// Redshift Cluster host
	Host string `json:"host"`
	// Redshift Cluster port
	Port int32 `json:"port"`
	// unload S3 bucket path
	S3BucketPath string `json:"s3_bucket_path"`
}

func (RedshiftIntegration) PrintResponse added in v0.6.0 

func (m RedshiftIntegration) PrintResponse()

type Resource 

type Resource struct {
	// ISO-8601 date
	CreatedAt string `json:"created_at,omitempty"`
	// email of user who created the collection
	CreatedBy string `json:"created_by,omitempty"`
	// unique identifer for collection, can contain alphanumeric or dash characters
	Name string `json:"name,omitempty"`
	// text describing the collection
	Description string `json:"description,omitempty"`
	// current status of collection, one of: CREATED, READY, DELETED, PAUSED, RESUMING
	Status string `json:"status,omitempty"`
	// list of sources from which collection ingests
	Sources []Source `json:"sources,omitempty"`
	// metrics about the collection
	Stats *ResourceStats `json:"stats,omitempty"`
	// number of seconds after which data is purged based on event time
	RetentionSecs int64 `json:"retention_secs,omitempty"`
	// list of mappings applied on all documents in a collection
	FieldMappings []FieldMappingV2 `json:"field_mappings,omitempty"`
}

func (Resource) PrintResponse 

func (m Resource) PrintResponse()

type ResourceStats 

type ResourceStats struct {
	// number of documents in the collection
	DocCount int64 `json:"doc_count,omitempty"`
	// total collection size in bytes
	TotalSize int64 `json:"total_size,omitempty"`
	// number between 0 and 1 that indicates progress of collection creation
	FillProgress float64 `json:"fill_progress,omitempty"`
	// milliseconds since Unix epoch Jan 1, 1970
	LastUpdatedMs int64 `json:"last_updated_ms,omitempty"`
	// milliseconds since Unix epoch Jan 1, 1970
	LastQueriedMs int64 `json:"last_queried_ms,omitempty"`
}

func (ResourceStats) PrintResponse 

func (m ResourceStats) PrintResponse()

type Response 

type Response struct {
	Metadata map[string][]interface{} `json:"metadata,omitempty"`
	Status   int32                    `json:"status,omitempty"`
	Entity   *interface{}             `json:"entity,omitempty"`
}

func (Response) PrintResponse 

func (m Response) PrintResponse()

type RunOpts added in v0.8.0 

type RunOpts struct {
	Body optional.Interface
}

type S3Integration added in v0.6.0 

type S3Integration struct {
	// credentials for an AWS access key integration
	AwsAccessKey *AwsAccessKey `json:"aws_access_key,omitempty"`
	// details of an AWS cross-account role integration
	AwsRole *AwsRole `json:"aws_role,omitempty"`
}

func (S3Integration) PrintResponse added in v0.6.0 

func (m S3Integration) PrintResponse()

type SavedQuery added in v0.8.0 

type SavedQuery struct {
	// workspace of this saved query
	Workspace string `json:"workspace,omitempty"`
	// user that created this query
	CreatedBy string `json:"created_by,omitempty"`
	// ISO-8601 date of when saved query was created
	CreatedAt time.Time `json:"created_at,omitempty"`
	// query name
	Name string `json:"name,omitempty"`
	// query version
	Version int32 `json:"version,omitempty"`
	// optional version tag
	VersionTag string `json:"version_tag,omitempty"`
	// SQL text of this query
	QuerySql string `json:"query_sql,omitempty"`
	// collections queried by this query
	Collections []string `json:"collections,omitempty"`
	// parameters associated with this query
	Parameters []SavedQueryParameter `json:"parameters,omitempty"`
	// status of this query
	State string `json:"state,omitempty"`
	// stats related to this query
	Stats *SavedQueryStats `json:"stats,omitempty"`
}

func (SavedQuery) PrintResponse added in v0.8.0 

func (m SavedQuery) PrintResponse()

type SavedQueryParameter added in v0.8.0 

type SavedQueryParameter struct {
	// name of the field
	Name string `json:"name"`
	// data type of the field
	Type_ string `json:"type"`
	// default value of the field
	DefaultValue *interface{} `json:"default_value"`
}

func (SavedQueryParameter) PrintResponse added in v0.8.0 

func (m SavedQueryParameter) PrintResponse()

type SavedQueryStats added in v0.8.0 

type SavedQueryStats struct {
	// ISO-8601 date
	LastExecuted time.Time `json:"last_executed,omitempty"`
	// user who last executed saved query
	LastExecutedBy string `json:"last_executed_by,omitempty"`
	// ISO-8601 date of last execution failure
	LastExecutionError time.Time `json:"last_execution_error,omitempty"`
	// error message associated with last failed query execution
	LastExecutionErrorMessage string `json:"last_execution_error_message,omitempty"`
}

func (SavedQueryStats) PrintResponse added in v0.8.0 

func (m SavedQueryStats) PrintResponse()

type SegmentIntegration added in v0.8.0 

type SegmentIntegration struct {
	// segment connection string
	ConnectionString string `json:"connection_string,omitempty"`
}

func (SegmentIntegration) PrintResponse added in v0.8.0 

func (m SegmentIntegration) PrintResponse()

type Service 

type Service struct {
	Client *APIClient
}

type Source 

type Source struct {
	// name of integration to use
	IntegrationName string `json:"integration_name"`
	// configuration for ingestion from S3
	S3 *SourceS3 `json:"s3,omitempty"`
	// configuration for ingestion from kinesis stream
	Kinesis *SourceKinesis `json:"kinesis,omitempty"`
	// configuration for ingestion from GCS
	Gcs *SourceGcs `json:"gcs,omitempty"`
	// configuration for ingestion from Redshift
	Redshift *SourceRedshift `json:"redshift,omitempty"`
	// configuration for ingestion from  a dynamodb table
	Dynamodb *SourceDynamoDb `json:"dynamodb,omitempty"`
	// file upload details
	FileUpload *SourceFileUpload `json:"file_upload,omitempty"`
	Kafka      *SourceKafka      `json:"kafka,omitempty"`
	// the ingest status of this source
	Status *Status `json:"status,omitempty"`
	// format parameters for data from this source
	FormatParams *FormatParams `json:"format_params,omitempty"`
}

Details about the data source for the given collection. Only one of the following fields are allowed to be defined. Only collections can act as data sources for views.

func (Source) PrintResponse 

func (m Source) PrintResponse()

type SourceDynamoDb 

type SourceDynamoDb struct {
	// AWS region name of DynamoDB table, by default us-west-2 is used
	AwsRegion string `json:"aws_region,omitempty"`
	// name of DynamoDB table containing data
	TableName string `json:"table_name"`
	// DynamoDB source status
	Status *StatusDynamoDb `json:"status,omitempty"`
	// Max RCU usage for scan
	Rcu int64 `json:"rcu,omitempty"`
}

func (SourceDynamoDb) PrintResponse 

func (m SourceDynamoDb) PrintResponse()

type SourceFileUpload 

type SourceFileUpload struct {
	// name of the file
	FileName string `json:"file_name"`
	// size of the file in bytes
	FileSize int64 `json:"file_size"`
	// time of file upload
	FileUploadTime string `json:"file_upload_time"`
}

func (SourceFileUpload) PrintResponse 

func (m SourceFileUpload) PrintResponse()

type SourceGcs 

type SourceGcs struct {
	// name of GCS bucket you want to ingest from
	Bucket string `json:"bucket,omitempty"`
	// Prefix that selects keys to ingest.
	Prefix string `json:"prefix,omitempty"`
}

func (SourceGcs) PrintResponse 

func (m SourceGcs) PrintResponse()

type SourceKafka added in v0.8.0 

type SourceKafka struct {
	// The Kafka topic to be tailed
	KafkaTopicName string `json:"kafka_topic_name"`
	// Kafka source status
	Status *StatusKafka `json:"status,omitempty"`
}

func (SourceKafka) PrintResponse added in v0.8.0 

func (m SourceKafka) PrintResponse()

type SourceKinesis 

type SourceKinesis struct {
	// name of kinesis stream
	StreamName string `json:"stream_name"`
	// AWS region name of Kinesis stream, by default us-west-2 is used
	AwsRegion string `json:"aws_region,omitempty"`
}

func (SourceKinesis) PrintResponse 

func (m SourceKinesis) PrintResponse()

type SourceRedshift added in v0.6.0 

type SourceRedshift struct {
	// name of the database in Redshift Cluster
	Database string `json:"database"`
	// schema which contains the Redshift table
	Schema string `json:"schema"`
	// name of Redshift table containing data
	TableName string `json:"table_name"`
	// field in Redshift source table to monitor for updates
	IncrementalField string `json:"incremental_field,omitempty"`
}

func (SourceRedshift) PrintResponse added in v0.6.0 

func (m SourceRedshift) PrintResponse()

type SourceS3 

type SourceS3 struct {
	// Prefix that selects keys to ingest.
	Prefix string `json:"prefix,omitempty"`
	// Pattern that selects keys to ingest.
	Pattern string `json:"pattern,omitempty"`
	// address of S3 bucket containing data
	Bucket string `json:"bucket"`
}

func (SourceS3) PrintResponse 

func (m SourceS3) PrintResponse()

type SqlExpression 

type SqlExpression struct {
	// The name of a sql function
	Sql string `json:"sql,omitempty"`
}

func (SqlExpression) PrintResponse 

func (m SqlExpression) PrintResponse()

type Status added in v0.8.0 

type Status struct {
	// Status of the Source's ingestion, one of: INITIALIZING, WATCHING, PROCESSING, COMPLETED, ERROR
	State string `json:"state,omitempty"`
	// ISO-8601 date when state was triggered
	Since string `json:"since,omitempty"`
	// state message
	Message string `json:"message,omitempty"`
	// ISO-8601 date when source was last processed
	LastProcessedAt string `json:"last_processed_at,omitempty"`
	// last source item processed by ingester
	LastProcessedItem string `json:"last_processed_item,omitempty"`
	// Total items processed of source
	TotalProcessedItems int64 `json:"total_processed_items,omitempty"`
	// ISO-8601 date when last error occurred
	LastErrorAt string `json:"last_error_at,omitempty"`
	// last source item that errored
	LastErrorItem string `json:"last_error_item,omitempty"`
	// reason for the last error
	LastErrorReason string `json:"last_error_reason,omitempty"`
	// Total items that errored
	TotalErrorItems int64 `json:"total_error_items,omitempty"`
}

func (Status) PrintResponse added in v0.8.0 

func (m Status) PrintResponse()

type StatusDynamoDb added in v0.8.0 

type StatusDynamoDb struct {
	// DynamoDB scan start time
	ScanStartTime string `json:"scan_start_time,omitempty"`
	// DynamoDb scan end time
	ScanEndTime string `json:"scan_end_time,omitempty"`
	// Number of records inserted using scan
	ScanRecordsProcessed int64 `json:"scan_records_processed,omitempty"`
	// Number of records in DynamoDB table at time of scan
	ScanTotalRecords int64 `json:"scan_total_records,omitempty"`
	// state of current ingest for this table
	State string `json:"state,omitempty"`
	// ISO-8601 date when source was last processed
	StreamLastProcessedAt string `json:"stream_last_processed_at,omitempty"`
}

func (StatusDynamoDb) PrintResponse added in v0.8.0 

func (m StatusDynamoDb) PrintResponse()

type StatusKafka added in v0.8.0 

type StatusKafka struct {
	// State of the Kafka source
	State string `json:"state,omitempty"`
	// Time at which the last document was consumed from Kafka
	LastConsumedTime string `json:"last_consumed_time,omitempty"`
	// Number of documents consumed by this Kafka topic
	NumDocumentsProcessed int64 `json:"num_documents_processed,omitempty"`
}

func (StatusKafka) PrintResponse added in v0.8.0 

func (m StatusKafka) PrintResponse()

type StatusKafkaPartition added in v0.8.0 

type StatusKafkaPartition struct {
	// The number of this partition
	PartitionNumber int32 `json:"partition_number,omitempty"`
	// Number of documents consumed by this partition
	NumDocumentsProcessed int64 `json:"num_documents_processed,omitempty"`
}

func (StatusKafkaPartition) PrintResponse added in v0.8.0 

func (m StatusKafkaPartition) PrintResponse()

type UpdateSavedQueryRequest added in v0.8.0 

type UpdateSavedQueryRequest struct {
	// optional version tag
	VersionTag string `json:"version_tag,omitempty"`
	// SQL text of this query
	QuerySql string `json:"query_sql"`
	// parameters associated with this query
	Parameters []SavedQueryParameter `json:"parameters,omitempty"`
}

func (UpdateSavedQueryRequest) PrintResponse added in v0.8.0 

func (m UpdateSavedQueryRequest) PrintResponse()

type UpdateSavedQueryResponse added in v0.8.0 

type UpdateSavedQueryResponse struct {
	// saved query data
	Data *SavedQuery `json:"data,omitempty"`
}

func (UpdateSavedQueryResponse) PrintResponse added in v0.8.0 

func (m UpdateSavedQueryResponse) PrintResponse()

type User 

type User struct {
	// ISO-8601 date
	CreatedAt string `json:"created_at,omitempty"`
	// user email
	Email string `json:"email"`
	// user first name
	FirstName string `json:"first_name,omitempty"`
	// user last name
	LastName string `json:"last_name,omitempty"`
	// List of roles for a given user
	Roles []string `json:"roles,omitempty"`
	// state of user - NEW / ACTIVE
	State string `json:"state,omitempty"`
}

func (User) PrintResponse 

func (m User) PrintResponse()

type UsersApiService 

type UsersApiService Service

func (*UsersApiService) Create 

func (a *UsersApiService) Create(body CreateUserRequest) (CreateUserResponse, *http.Response, error)

UsersApiService Create User Create a new user for an organization.

  • @param body JSON object

@return CreateUserResponse

func (*UsersApiService) CreateStream 

func (a *UsersApiService) CreateStream(body CreateUserRequest) (string, *http.Response, error)

func (*UsersApiService) Delete 

func (a *UsersApiService) Delete(user string) (DeleteUserResponse, *http.Response, error)

UsersApiService Delete User Delete a user from an organization.

  • @param user user email

@return DeleteUserResponse

func (*UsersApiService) DeleteStream 

func (a *UsersApiService) DeleteStream(user string) (string, *http.Response, error)

func (*UsersApiService) Get 

func (a *UsersApiService) Get() (User, *http.Response, error)

UsersApiService Get Current User Retrieve currently active user.

@return User

func (*UsersApiService) GetStream 

func (a *UsersApiService) GetStream() (string, *http.Response, error)

func (*UsersApiService) List 

func (a *UsersApiService) List() (ListUsersResponse, *http.Response, error)

UsersApiService List Users Retrieve all users for an organization.

@return ListUsersResponse

func (*UsersApiService) ListStream 

func (a *UsersApiService) ListStream() (string, *http.Response, error)

type Workspace added in v0.6.0 

type Workspace struct {
	// ISO-8601 date of when workspace was created
	CreatedAt string `json:"created_at,omitempty"`
	// email of user who created the workspace
	CreatedBy string `json:"created_by,omitempty"`
	// descriptive label and unique identifier
	Name string `json:"name,omitempty"`
	// longer explanation for the workspace
	Description string `json:"description,omitempty"`
	// number of collections that are immediate children of workspace
	CollectionCount int64 `json:"collection_count,omitempty"`
}

Workspaces are organizational containers for collections.

func (Workspace) PrintResponse added in v0.6.0 

func (m Workspace) PrintResponse()

type WorkspacesApiService added in v0.6.0 

type WorkspacesApiService Service

func (*WorkspacesApiService) Child added in v0.6.0 

func (a *WorkspacesApiService) Child(workspace string) (ListWorkspacesResponse, *http.Response, error)

WorkspacesApiService List Workspaces List workspaces under given workspace.

  • @param workspace name of the workspace

@return ListWorkspacesResponse

func (*WorkspacesApiService) ChildStream added in v0.6.0 

func (a *WorkspacesApiService) ChildStream(workspace string) (string, *http.Response, error)

func (*WorkspacesApiService) Create added in v0.6.0 

func (a *WorkspacesApiService) Create(body CreateWorkspaceRequest) (CreateWorkspaceResponse, *http.Response, error)

WorkspacesApiService Create Workspace Create a new workspace in your org.

  • @param body workspace details

@return CreateWorkspaceResponse

func (*WorkspacesApiService) CreateStream added in v0.6.0 

func (a *WorkspacesApiService) CreateStream(body CreateWorkspaceRequest) (string, *http.Response, error)

func (*WorkspacesApiService) Delete added in v0.6.0 

func (a *WorkspacesApiService) Delete(workspace string) (DeleteWorkspaceResponse, *http.Response, error)

WorkspacesApiService Delete Workspace Remove a workspace.

  • @param workspace name of the workspace

@return DeleteWorkspaceResponse

func (*WorkspacesApiService) DeleteStream added in v0.6.0 

func (a *WorkspacesApiService) DeleteStream(workspace string) (string, *http.Response, error)

func (*WorkspacesApiService) Get added in v0.6.0 

func (a *WorkspacesApiService) Get(workspace string) (GetWorkspaceResponse, *http.Response, error)

WorkspacesApiService Get Workspace Get information about a single workspace.

  • @param workspace name of the workspace

@return GetWorkspaceResponse

func (*WorkspacesApiService) GetStream added in v0.6.0 

func (a *WorkspacesApiService) GetStream(workspace string) (string, *http.Response, error)

func (*WorkspacesApiService) List added in v0.6.0 

func (a *WorkspacesApiService) List() (ListWorkspacesResponse, *http.Response, error)

WorkspacesApiService List Workspaces List all workspaces.

@return ListWorkspacesResponse

func (*WorkspacesApiService) ListStream added in v0.6.0 

func (a *WorkspacesApiService) ListStream() (string, *http.Response, error)

type XmlParams 

type XmlParams struct {
	// tag until which xml is ignored
	RootTag string `json:"root_tag,omitempty"`
	// encoding in which data source is encoded
	Encoding string `json:"encoding,omitempty"`
	// tags with which documents are identified
	DocTag string `json:"doc_tag,omitempty"`
	// tag used for the value when there are attributes in the element having no child
	ValueTag string `json:"value_tag,omitempty"`
	// tag to differentiate between attributes and elements
	AttributePrefix string `json:"attribute_prefix,omitempty"`
}

func (XmlParams) PrintResponse 

func (m XmlParams) PrintResponse()

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.