Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AddDocumentsRequest
- type AddDocumentsResponse
- type ApiKey
- type ApiKeysApiService
- func (a *ApiKeysApiService) Create(body CreateApiKeyRequest) (CreateApiKeyResponse, *http.Response, error)
- func (a *ApiKeysApiService) CreateStream(body CreateApiKeyRequest) (string, *http.Response, error)
- func (a *ApiKeysApiService) Create_1(body CreateApiKeyRequest, user string) (CreateApiKeyResponse, *http.Response, error)
- func (a *ApiKeysApiService) Create_1Stream(body CreateApiKeyRequest, user string) (string, *http.Response, error)
- func (a *ApiKeysApiService) Delete(name string) (DeleteApiKeyResponse, *http.Response, error)
- func (a *ApiKeysApiService) DeleteStream(name string) (string, *http.Response, error)
- func (a *ApiKeysApiService) Delete_2(name string, user string) (DeleteApiKeyResponse, *http.Response, error)
- func (a *ApiKeysApiService) Delete_2Stream(name string, user string) (string, *http.Response, error)
- func (a *ApiKeysApiService) List() (ListApiKeysResponse, *http.Response, error)
- func (a *ApiKeysApiService) ListStream() (string, *http.Response, error)
- func (a *ApiKeysApiService) List_3(user string) (ListApiKeysResponse, *http.Response, error)
- func (a *ApiKeysApiService) List_3Stream(user string) (string, *http.Response, error)
- type AwsExternalIdIntegration
- type AwsKeyIntegration
- type BasicAuth
- type CollectionsApiService
- func (a *CollectionsApiService) Create(body CreateCollectionRequest) (CreateCollectionResponse, *http.Response, error)
- func (a *CollectionsApiService) CreateStream(body CreateCollectionRequest) (string, *http.Response, error)
- func (a *CollectionsApiService) Delete(collection string) (DeleteCollectionResponse, *http.Response, error)
- func (a *CollectionsApiService) DeleteStream(collection string) (string, *http.Response, error)
- func (a *CollectionsApiService) Get(collection string) (GetCollectionResponse, *http.Response, error)
- func (a *CollectionsApiService) GetStream(collection string) (string, *http.Response, error)
- func (a *CollectionsApiService) List() (ListCollectionsResponse, *http.Response, error)
- func (a *CollectionsApiService) ListStream() (string, *http.Response, error)
- type CommitMark
- type CommitMarkPositions
- type Configuration
- type CreateApiKeyRequest
- type CreateApiKeyResponse
- type CreateCollectionRequest
- type CreateCollectionResponse
- type CreateIntegrationRequest
- type CreateIntegrationResponse
- type CreateUserRequest
- type CreateUserResponse
- type CsvParams
- type DeleteApiKeyResponse
- type DeleteCollectionResponse
- type DeleteDocumentsRequest
- type DeleteDocumentsRequestData
- type DeleteDocumentsResponse
- type DeleteIntegrationResponse
- type DeleteUserResponse
- type DocumentStatus
- type DocumentsApiService
- func (a *DocumentsApiService) Add(collection string, body AddDocumentsRequest) (AddDocumentsResponse, *http.Response, error)
- func (a *DocumentsApiService) AddStream(collection string, body AddDocumentsRequest) (string, *http.Response, error)
- func (a *DocumentsApiService) Delete(collection string, body DeleteDocumentsRequest) (DeleteDocumentsResponse, *http.Response, error)
- func (a *DocumentsApiService) DeleteStream(collection string, body DeleteDocumentsRequest) (string, *http.Response, error)
- type ErrorModel
- type ErrorModelContext
- type EventTimeInfo
- type FieldMapping
- type FieldMappingV2
- type FieldMask
- type FieldMaskMask
- type FormatParams
- type GcpServiceAccount
- type GenericSwaggerError
- type GetCollectionResponse
- type GetIntegrationResponse
- type InputField
- type Integration
- type IntegrationsApiService
- func (a *IntegrationsApiService) Create(body CreateIntegrationRequest) (CreateIntegrationResponse, *http.Response, error)
- func (a *IntegrationsApiService) CreateStream(body CreateIntegrationRequest) (string, *http.Response, error)
- func (a *IntegrationsApiService) Delete(integration string) (DeleteIntegrationResponse, *http.Response, error)
- func (a *IntegrationsApiService) DeleteStream(integration string) (string, *http.Response, error)
- func (a *IntegrationsApiService) Get(integration string) (GetIntegrationResponse, *http.Response, error)
- func (a *IntegrationsApiService) GetStream(integration string) (string, *http.Response, error)
- func (a *IntegrationsApiService) List() (ListIntegrationsResponse, *http.Response, error)
- func (a *IntegrationsApiService) ListStream() (string, *http.Response, error)
- type ListApiKeysResponse
- type ListCollectionsResponse
- type ListIntegrationsResponse
- type ListUsersResponse
- type Organization
- type OrganizationResponse
- type OrganizationsApiService
- type OutputField
- type QueriesApiService
- type QueryFieldType
- type QueryParameter
- type QueryRequest
- type QueryRequestSql
- type QueryResponse
- type QueryResponseStats
- type Resource
- type ResourceStats
- type Response
- type Service
- type Source
- type SourceDynamoDb
- type SourceFileUpload
- type SourceGcs
- type SourceKinesis
- type SourceS3
- type SqlExpression
- type User
- type UsersApiService
- func (a *UsersApiService) Create(body CreateUserRequest) (CreateUserResponse, *http.Response, error)
- func (a *UsersApiService) CreateStream(body CreateUserRequest) (string, *http.Response, error)
- func (a *UsersApiService) Delete(user string) (DeleteUserResponse, *http.Response, error)
- func (a *UsersApiService) DeleteStream(user string) (string, *http.Response, error)
- func (a *UsersApiService) Get() (ListUsersResponse, *http.Response, error)
- func (a *UsersApiService) GetStream() (string, *http.Response, error)
- func (a *UsersApiService) List() (ListUsersResponse, *http.Response, error)
- func (a *UsersApiService) ListStream() (string, *http.Response, error)
- type XmlParams
Constants ¶
This section is empty.
Variables ¶
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 ¶
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 ¶
Change base path to allow switching to mocks
type APIKey ¶
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 { // has value `api_key` for an API key object Type_ string `json:"type,omitempty"` // 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 (*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 (*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 ¶
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 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 CollectionsApiService ¶
type CollectionsApiService Service
func (*CollectionsApiService) Create ¶
func (a *CollectionsApiService) Create(body CreateCollectionRequest) (CreateCollectionResponse, *http.Response, error)
CollectionsApiService Create Collection Create new collection for organization.
- @param body JSON object
@return CreateCollectionResponse
func (*CollectionsApiService) CreateStream ¶
func (a *CollectionsApiService) CreateStream(body CreateCollectionRequest) (string, *http.Response, error)
func (*CollectionsApiService) Delete ¶
func (a *CollectionsApiService) Delete(collection string) (DeleteCollectionResponse, *http.Response, error)
CollectionsApiService Delete Collection Delete a collection and all its documents from Rockset.
- @param collection name of the collection
@return DeleteCollectionResponse
func (*CollectionsApiService) DeleteStream ¶
func (*CollectionsApiService) Get ¶
func (a *CollectionsApiService) Get(collection string) (GetCollectionResponse, *http.Response, error)
CollectionsApiService Get Collection Get the results of a describe call on a collection.
- @param collection name of the collection
@return GetCollectionResponse
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)
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 *Resource `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"` // credentials for an AWS key integration Aws *AwsKeyIntegration `json:"aws,omitempty"` // details for an AWS External Id integration AwsExternalId *AwsExternalIdIntegration `json:"aws_external_id,omitempty"` // details of a GCP Service Account integration GcpServiceAccount *GcpServiceAccount `json:"gcp_service_account,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 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 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"` }
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 *Resource `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 DeleteUserResponse ¶
type DeleteUserResponse struct { // user object that was deleted Data *User `json:"data,omitempty"` }
func (DeleteUserResponse) PrintResponse ¶
func (m DeleteUserResponse) 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"` }
func (DocumentStatus) PrintResponse ¶
func (m DocumentStatus) PrintResponse()
type DocumentsApiService ¶
type DocumentsApiService Service
func (*DocumentsApiService) Add ¶
func (a *DocumentsApiService) Add(collection string, body AddDocumentsRequest) (AddDocumentsResponse, *http.Response, error)
DocumentsApiService Add Documents Add documents to a collection in Rockset.
- @param collection name of the collection
- @param body JSON object
@return AddDocumentsResponse
func (*DocumentsApiService) AddStream ¶
func (a *DocumentsApiService) AddStream(collection string, body AddDocumentsRequest) (string, *http.Response, error)
func (*DocumentsApiService) Delete ¶
func (a *DocumentsApiService) Delete(collection string, body DeleteDocumentsRequest) (DeleteDocumentsResponse, *http.Response, error)
DocumentsApiService Delete Documents Delete documents from a collection in Rockset.
- @param collection name of the collection
- @param body JSON object
@return DeleteDocumentsResponse
func (*DocumentsApiService) DeleteStream ¶
func (a *DocumentsApiService) DeleteStream(collection string, body DeleteDocumentsRequest) (string, *http.Response, error)
type ErrorModel ¶
type ErrorModel struct { // HTTP status code Code int32 `json:"code,omitempty"` // descriptive message about the error Message string `json:"message,omitempty"` // category of the error Type_ string `json:"type,omitempty"` // additional error information Context *ErrorModelContext `json:"context,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 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 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 *Resource `json:"data,omitempty"` }
func (GetCollectionResponse) PrintResponse ¶
func (m GetCollectionResponse) PrintResponse()
type GetIntegrationResponse ¶
type GetIntegrationResponse struct { // integration object Data *Integration `json:"data,omitempty"` // list of collections that use the integration Collections []Resource `json:"collections,omitempty"` }
func (GetIntegrationResponse) PrintResponse ¶
func (m GetIntegrationResponse) 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 { // ISO-8601 date CreatedAt string `json:"created_at,omitempty"` // email of user who created the integration CreatedBy string `json:"created_by"` // descriptive label and unique identifier Name string `json:"name"` // longer explanation for the integration Description string `json:"description,omitempty"` // credentials for an AWS key integration Aws *AwsKeyIntegration `json:"aws,omitempty"` // details of an AWS External Id integration AwsExternalId *AwsExternalIdIntegration `json:"aws_external_id,omitempty"` // details of a GCP Service Account integration GcpServiceAccount *GcpServiceAccount `json:"gcp_service_account,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 (*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) 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 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 []Resource `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 ListUsersResponse ¶
type ListUsersResponse struct { // list of users Data []User `json:"data,omitempty"` }
func (ListUsersResponse) PrintResponse ¶
func (m ListUsersResponse) PrintResponse()
type Organization ¶
type Organization struct { // unique identifier for the organization Id string `json:"id,omitempty"` // name of the organization DisplayName string `json:"display_name,omitempty"` // pricing tier Tier string `json:"tier,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
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 QueriesApiService ¶
type QueriesApiService Service
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)
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"` }
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"` }
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 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 Source ¶
type Source struct { // has value `source` for a source object Type_ string `json:"type,omitempty"` // 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 a dynamodb table Dynamodb *SourceDynamoDb `json:"dynamodb,omitempty"` // configuration for ingestion from GCS Gcs *SourceGcs `json:"gcs,omitempty"` // file upload details FileUpload *SourceFileUpload `json:"file_upload,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 { // name of DynamoDB table containing data TableName string `json:"table_name"` }
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 SourceKinesis ¶
type SourceKinesis struct { // name of kinesis stream StreamName string `json:"stream_name"` }
func (SourceKinesis) PrintResponse ¶
func (m SourceKinesis) 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 User ¶
type User struct { // has value `user` for a user object Type_ string `json:"type,omitempty"` // ISO-8601 date CreatedAt string `json:"created_at,omitempty"` // user email Email string `json:"email"` // List of roles for a given user Roles []string `json:"roles,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 (*UsersApiService) Get ¶
func (a *UsersApiService) Get() (ListUsersResponse, *http.Response, error)
UsersApiService Get Current User Retrieve currently active user.
@return ListUsersResponse
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 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 ¶
- api_api_keys.go
- api_collections.go
- api_documents.go
- api_integrations.go
- api_organizations.go
- api_queries.go
- api_users.go
- client.go
- configuration.go
- model_add_documents_request.go
- model_add_documents_response.go
- model_api_key.go
- model_aws_external_id_integration.go
- model_aws_key_integration.go
- model_commit_mark.go
- model_commit_mark_positions.go
- model_create_api_key_request.go
- model_create_api_key_response.go
- model_create_collection_request.go
- model_create_collection_response.go
- model_create_integration_request.go
- model_create_integration_response.go
- model_create_user_request.go
- model_create_user_response.go
- model_csv_params.go
- model_delete_api_key_response.go
- model_delete_collection_response.go
- model_delete_documents_request.go
- model_delete_documents_request_data.go
- model_delete_documents_response.go
- model_delete_integration_response.go
- model_delete_user_response.go
- model_document_status.go
- model_error_model.go
- model_error_model_context.go
- model_event_time_info.go
- model_field_mapping.go
- model_field_mapping_v2.go
- model_field_mask.go
- model_field_mask_mask.go
- model_format_params.go
- model_gcp_service_account.go
- model_get_collection_response.go
- model_get_integration_response.go
- model_input_field.go
- model_integration.go
- model_list_api_keys_response.go
- model_list_collections_response.go
- model_list_integrations_response.go
- model_list_users_response.go
- model_organization.go
- model_organization_response.go
- model_output_field.go
- model_query_field_type.go
- model_query_parameter.go
- model_query_request.go
- model_query_request_sql.go
- model_query_response.go
- model_query_response_stats.go
- model_resource.go
- model_resource_stats.go
- model_response.go
- model_source.go
- model_source_dynamo_db.go
- model_source_file_upload.go
- model_source_gcs.go
- model_source_kinesis.go
- model_source_s3.go
- model_sql_expression.go
- model_user.go
- model_xml_params.go
- response.go