Safe Haskell	None
Language	Haskell2010

Pinecone.Imports

Contents

Main types
Other types
Servant

Description

Imports

Synopsis

newtype Import = Import {
- text :: Text
}
data StartImport = StartImport {
- uri :: Text
- integrationId :: Maybe Text
- errorMode :: Maybe ErrorMode
}
_StartImport :: StartImport
data StartImportResponse = StartImportResponse {
- id :: Import
}
data Imports = ListImport {
- data_ :: Vector ImportModel
- pagination :: Maybe Pagination
}
data ImportModel = ImportModel {
- id :: Import
- uri :: Text
- status :: Status
- createdAt :: POSIXTime
- finishedAt :: POSIXTime
- percentComplete :: Double
- recordsImported :: Natural
- error :: Text
}
data ErrorMode = ErrorMode {
- onError :: OnError
}
data OnError
- = Abort
- | Continue
data Status
- = Pending
- | InProgress
- | Failed
- | Completed
- | Cancelled
type API = "bulk" :> ("imports" :> ((ReqBody '[JSON] StartImport :> Post '[JSON] StartImportResponse) :<|> ((QueryParam "limit" Natural :> (QueryParam "paginationToken" Text :> Get '[JSON] Imports)) :<|> ((Capture "id" Import :> Get '[JSON] ImportModel) :<|> (Capture "id" Import :> Delete '[JSON] NoContent)))))

Main types

newtype Import Source #

Unique identifier for the import operation

Constructors

Import
Fields text :: Text

Instances

Instances details

FromJSON Import Source #
Instance details Defined in Pinecone.Imports Methods parseJSON :: Value -> Parser Import # parseJSONList :: Value -> Parser [Import] # omittedField :: Maybe Import #
ToJSON Import Source #
Instance details Defined in Pinecone.Imports Methods toJSON :: Import -> Value # toEncoding :: Import -> Encoding # toJSONList :: [Import] -> Value # toEncodingList :: [Import] -> Encoding # omitField :: Import -> Bool #
IsString Import Source #
Instance details Defined in Pinecone.Imports Methods fromString :: String -> Import #
Show Import Source #
Instance details Defined in Pinecone.Imports Methods showsPrec :: Int -> Import -> ShowS # show :: Import -> String # showList :: [Import] -> ShowS #
Eq Import Source #
Instance details Defined in Pinecone.Imports Methods (==) :: Import -> Import -> Bool # (/=) :: Import -> Import -> Bool #
ToHttpApiData Import Source #
Instance details Defined in Pinecone.Imports Methods toUrlPiece :: Import -> Text # toEncodedUrlPiece :: Import -> Builder # toHeader :: Import -> ByteString # toQueryParam :: Import -> Text # toEncodedQueryParam :: Import -> Builder #

data StartImport Source #

Request body for /bulk/imports

Constructors

StartImport
Fields uri :: Text integrationId :: Maybe Text errorMode :: Maybe ErrorMode

Instances

Instances details

FromJSON StartImport Source #

Instance details

Defined in Pinecone.Imports

Methods

parseJSON :: Value -> Parser StartImport #

parseJSONList :: Value -> Parser [StartImport] #

omittedField :: Maybe StartImport #

ToJSON StartImport Source #

Instance details

Defined in Pinecone.Imports

Methods

toJSON :: StartImport -> Value #

toEncoding :: StartImport -> Encoding #

toJSONList :: [StartImport] -> Value #

toEncodingList :: [StartImport] -> Encoding #

omitField :: StartImport -> Bool #

Generic StartImport Source #

Instance details

Defined in Pinecone.Imports

Associated Types

type Rep StartImport

Instance details

Defined in Pinecone.Imports

type Rep StartImport = D1 ('MetaData "StartImport" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "StartImport" 'PrefixI 'True) (S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "integrationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ErrorMode)))))

Methods

from :: StartImport -> Rep StartImport x #

to :: Rep StartImport x -> StartImport #

Show StartImport Source #

Instance details

Defined in Pinecone.Imports

Methods

showsPrec :: Int -> StartImport -> ShowS #

show :: StartImport -> String #

showList :: [StartImport] -> ShowS #

Eq StartImport Source #

Instance details

Defined in Pinecone.Imports

Methods

(==) :: StartImport -> StartImport -> Bool #

(/=) :: StartImport -> StartImport -> Bool #

type Rep StartImport Source #

Instance details

Defined in Pinecone.Imports

type Rep StartImport = D1 ('MetaData "StartImport" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "StartImport" 'PrefixI 'True) (S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "integrationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ErrorMode)))))

_StartImport :: StartImport Source #

Default StartImport

data StartImportResponse Source #

Response body for /bulk/imports

Constructors

StartImportResponse
Fields id :: Import

Instances

Instances details

FromJSON StartImportResponse Source #

Instance details

Defined in Pinecone.Imports

Methods

parseJSON :: Value -> Parser StartImportResponse #

parseJSONList :: Value -> Parser [StartImportResponse] #

omittedField :: Maybe StartImportResponse #

ToJSON StartImportResponse Source #

Instance details

Defined in Pinecone.Imports

Methods

toJSON :: StartImportResponse -> Value #

toEncoding :: StartImportResponse -> Encoding #

toJSONList :: [StartImportResponse] -> Value #

toEncodingList :: [StartImportResponse] -> Encoding #

omitField :: StartImportResponse -> Bool #

Generic StartImportResponse Source #

Instance details

Defined in Pinecone.Imports

Associated Types

type Rep StartImportResponse
Instance details Defined in Pinecone.Imports type Rep StartImportResponse = D1 ('MetaData "StartImportResponse" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "StartImportResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Import)))

Methods

from :: StartImportResponse -> Rep StartImportResponse x #

to :: Rep StartImportResponse x -> StartImportResponse #

Show StartImportResponse Source #

Instance details

Defined in Pinecone.Imports

Methods

showsPrec :: Int -> StartImportResponse -> ShowS #

show :: StartImportResponse -> String #

showList :: [StartImportResponse] -> ShowS #

Eq StartImportResponse Source #

Instance details

Defined in Pinecone.Imports

Methods

(==) :: StartImportResponse -> StartImportResponse -> Bool #

(/=) :: StartImportResponse -> StartImportResponse -> Bool #

type Rep StartImportResponse Source #

Instance details

Defined in Pinecone.Imports

type Rep StartImportResponse = D1 ('MetaData "StartImportResponse" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "StartImportResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Import)))

data Imports Source #

A list of import operations

Constructors

ListImport
Fields data_ :: Vector ImportModel pagination :: Maybe Pagination

Instances

Instances details

FromJSON Imports Source #

Instance details

Defined in Pinecone.Imports

Methods

parseJSON :: Value -> Parser Imports #

parseJSONList :: Value -> Parser [Imports] #

omittedField :: Maybe Imports #

ToJSON Imports Source #

Instance details

Defined in Pinecone.Imports

Methods

toJSON :: Imports -> Value #

toEncoding :: Imports -> Encoding #

toJSONList :: [Imports] -> Value #

toEncodingList :: [Imports] -> Encoding #

omitField :: Imports -> Bool #

Generic Imports Source #

Instance details

Defined in Pinecone.Imports

Associated Types

type Rep Imports

Instance details

Defined in Pinecone.Imports

type Rep Imports = D1 ('MetaData "Imports" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "ListImport" 'PrefixI 'True) (S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector ImportModel)) :*: S1 ('MetaSel ('Just "pagination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Pagination))))

Methods

from :: Imports -> Rep Imports x #

to :: Rep Imports x -> Imports #

Show Imports Source #

Instance details

Defined in Pinecone.Imports

Methods

showsPrec :: Int -> Imports -> ShowS #

show :: Imports -> String #

showList :: [Imports] -> ShowS #

Eq Imports Source #

Instance details

Defined in Pinecone.Imports

Methods

(==) :: Imports -> Imports -> Bool #

(/=) :: Imports -> Imports -> Bool #

type Rep Imports Source #

Instance details

Defined in Pinecone.Imports

type Rep Imports = D1 ('MetaData "Imports" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "ListImport" 'PrefixI 'True) (S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector ImportModel)) :*: S1 ('MetaSel ('Just "pagination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Pagination))))

data ImportModel Source #

The model for an import operation.

Constructors

ImportModel
Fields id :: Import uri :: Text status :: Status createdAt :: POSIXTime finishedAt :: POSIXTime percentComplete :: Double recordsImported :: Natural error :: Text

Instances

Instances details

FromJSON ImportModel Source #

Instance details

Defined in Pinecone.Imports

Methods

parseJSON :: Value -> Parser ImportModel #

parseJSONList :: Value -> Parser [ImportModel] #

omittedField :: Maybe ImportModel #

ToJSON ImportModel Source #

Instance details

Defined in Pinecone.Imports

Methods

toJSON :: ImportModel -> Value #

toEncoding :: ImportModel -> Encoding #

toJSONList :: [ImportModel] -> Value #

toEncodingList :: [ImportModel] -> Encoding #

omitField :: ImportModel -> Bool #

Generic ImportModel Source #

Instance details

Defined in Pinecone.Imports

Associated Types

type Rep ImportModel

Instance details

Defined in Pinecone.Imports

Methods

from :: ImportModel -> Rep ImportModel x #

to :: Rep ImportModel x -> ImportModel #

Show ImportModel Source #

Instance details

Defined in Pinecone.Imports

Methods

showsPrec :: Int -> ImportModel -> ShowS #

show :: ImportModel -> String #

showList :: [ImportModel] -> ShowS #

Eq ImportModel Source #

Instance details

Defined in Pinecone.Imports

Methods

(==) :: ImportModel -> ImportModel -> Bool #

(/=) :: ImportModel -> ImportModel -> Bool #

type Rep ImportModel Source #

Instance details

Defined in Pinecone.Imports

Other types

data ErrorMode Source #

Indicates how to respond to errors during the import process.

Constructors

ErrorMode
Fields onError :: OnError

Instances

Instances details

FromJSON ErrorMode Source #

Instance details

Defined in Pinecone.Imports

Methods

parseJSON :: Value -> Parser ErrorMode #

parseJSONList :: Value -> Parser [ErrorMode] #

omittedField :: Maybe ErrorMode #

ToJSON ErrorMode Source #

Instance details

Defined in Pinecone.Imports

Methods

toJSON :: ErrorMode -> Value #

toEncoding :: ErrorMode -> Encoding #

toJSONList :: [ErrorMode] -> Value #

toEncodingList :: [ErrorMode] -> Encoding #

omitField :: ErrorMode -> Bool #

Generic ErrorMode Source #

Instance details

Defined in Pinecone.Imports

Associated Types

type Rep ErrorMode
Instance details Defined in Pinecone.Imports type Rep ErrorMode = D1 ('MetaData "ErrorMode" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "ErrorMode" 'PrefixI 'True) (S1 ('MetaSel ('Just "onError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OnError)))

Methods

from :: ErrorMode -> Rep ErrorMode x #

to :: Rep ErrorMode x -> ErrorMode #

Show ErrorMode Source #

Instance details

Defined in Pinecone.Imports

Methods

showsPrec :: Int -> ErrorMode -> ShowS #

show :: ErrorMode -> String #

showList :: [ErrorMode] -> ShowS #

Eq ErrorMode Source #

Instance details

Defined in Pinecone.Imports

Methods

(==) :: ErrorMode -> ErrorMode -> Bool #

(/=) :: ErrorMode -> ErrorMode -> Bool #

type Rep ErrorMode Source #

Instance details

Defined in Pinecone.Imports

type Rep ErrorMode = D1 ('MetaData "ErrorMode" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "ErrorMode" 'PrefixI 'True) (S1 ('MetaSel ('Just "onError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OnError)))

data OnError Source #

Indicates how to respond to errors during the import process.

Constructors

Abort
Continue

Instances

Instances details

FromJSON OnError Source #

Instance details

Defined in Pinecone.Imports

Methods

parseJSON :: Value -> Parser OnError #

parseJSONList :: Value -> Parser [OnError] #

omittedField :: Maybe OnError #

ToJSON OnError Source #

Instance details

Defined in Pinecone.Imports

Methods

toJSON :: OnError -> Value #

toEncoding :: OnError -> Encoding #

toJSONList :: [OnError] -> Value #

toEncodingList :: [OnError] -> Encoding #

omitField :: OnError -> Bool #

Generic OnError Source #

Instance details

Defined in Pinecone.Imports

Associated Types

type Rep OnError
Instance details Defined in Pinecone.Imports type Rep OnError = D1 ('MetaData "OnError" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Abort" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Continue" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: OnError -> Rep OnError x #

to :: Rep OnError x -> OnError #

Show OnError Source #

Instance details

Defined in Pinecone.Imports

Methods

showsPrec :: Int -> OnError -> ShowS #

show :: OnError -> String #

showList :: [OnError] -> ShowS #

Eq OnError Source #

Instance details

Defined in Pinecone.Imports

Methods

(==) :: OnError -> OnError -> Bool #

(/=) :: OnError -> OnError -> Bool #

type Rep OnError Source #

Instance details

Defined in Pinecone.Imports

type Rep OnError = D1 ('MetaData "OnError" "Pinecone.Imports" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Abort" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Continue" 'PrefixI 'False) (U1 :: Type -> Type))

data Status Source #

The status of the operation.

Constructors