Safe Haskell	None
Language	Haskell2010

Pinecone.Backups

Contents

Main types
Other types
Servant

Description

Backups

Synopsis

newtype Collection = Collection {
- text :: Text
}
data Collections = Collections {
- collections :: Vector CollectionModel
}
data CreateCollection = CreateCollection {
- name :: Text
- source :: Index
}
_CreateCollection :: CreateCollection
data CollectionModel = CollectionModel {
- name :: Collection
- status :: Status
- environment :: Text
- size :: Maybe Natural
- dimension :: Maybe Natural
- vector_count :: Maybe Natural
}
data Status
- = Initializing
- | Ready
- | Terminating
type API = "collections" :> (Get '[JSON] Collections :<|> ((ReqBody '[JSON] CreateCollection :> Post '[JSON] CollectionModel) :<|> ((Capture "collection_name" Collection :> Get '[JSON] CollectionModel) :<|> (Capture "collection_name" Collection :> DeleteAccepted '[JSON] NoContent))))

Main types

newtype Collection Source #

The name of the collection

Constructors

Collection
Fields text :: Text

Instances

Instances details

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

data Collections Source #

The list of collections that exist in the project.

Constructors

Collections
Fields collections :: Vector CollectionModel

Instances

Instances details

FromJSON Collections Source #

Instance details

Defined in Pinecone.Backups

Methods

parseJSON :: Value -> Parser Collections #

parseJSONList :: Value -> Parser [Collections] #

omittedField :: Maybe Collections #

ToJSON Collections Source #

Instance details

Defined in Pinecone.Backups

Methods

toJSON :: Collections -> Value #

toEncoding :: Collections -> Encoding #

toJSONList :: [Collections] -> Value #

toEncodingList :: [Collections] -> Encoding #

omitField :: Collections -> Bool #

Generic Collections Source #

Instance details

Defined in Pinecone.Backups

Associated Types

type Rep Collections
Instance details Defined in Pinecone.Backups type Rep Collections = D1 ('MetaData "Collections" "Pinecone.Backups" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Collections" 'PrefixI 'True) (S1 ('MetaSel ('Just "collections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector CollectionModel))))

Methods

from :: Collections -> Rep Collections x #

to :: Rep Collections x -> Collections #

Show Collections Source #

Instance details

Defined in Pinecone.Backups

Methods

showsPrec :: Int -> Collections -> ShowS #

show :: Collections -> String #

showList :: [Collections] -> ShowS #

Eq Collections Source #

Instance details

Defined in Pinecone.Backups

Methods

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

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

type Rep Collections Source #

Instance details

Defined in Pinecone.Backups

type Rep Collections = D1 ('MetaData "Collections" "Pinecone.Backups" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Collections" 'PrefixI 'True) (S1 ('MetaSel ('Just "collections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector CollectionModel))))

data CreateCollection Source #

The configuration needed to create a Pinecone collection.

Constructors

CreateCollection
Fields name :: Text source :: Index

Instances

Instances details

FromJSON CreateCollection Source #

Instance details

Defined in Pinecone.Backups

Methods

parseJSON :: Value -> Parser CreateCollection #

parseJSONList :: Value -> Parser [CreateCollection] #

omittedField :: Maybe CreateCollection #

ToJSON CreateCollection Source #

Instance details

Defined in Pinecone.Backups

Methods

toJSON :: CreateCollection -> Value #

toEncoding :: CreateCollection -> Encoding #

toJSONList :: [CreateCollection] -> Value #

toEncodingList :: [CreateCollection] -> Encoding #

omitField :: CreateCollection -> Bool #

Generic CreateCollection Source #

Instance details

Defined in Pinecone.Backups

Associated Types

type Rep CreateCollection

Instance details

Defined in Pinecone.Backups

type Rep CreateCollection = D1 ('MetaData "CreateCollection" "Pinecone.Backups" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "CreateCollection" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index)))

Methods

from :: CreateCollection -> Rep CreateCollection x #

to :: Rep CreateCollection x -> CreateCollection #

Show CreateCollection Source #

Instance details

Defined in Pinecone.Backups

Methods

showsPrec :: Int -> CreateCollection -> ShowS #

show :: CreateCollection -> String #

showList :: [CreateCollection] -> ShowS #

Eq CreateCollection Source #

Instance details

Defined in Pinecone.Backups

Methods

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

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

type Rep CreateCollection Source #

Instance details

Defined in Pinecone.Backups

type Rep CreateCollection = D1 ('MetaData "CreateCollection" "Pinecone.Backups" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "CreateCollection" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index)))

_CreateCollection :: CreateCollection Source #

Default CreateCollection

data CollectionModel Source #

The CollectionModel describes the configuration and status of a Pinecone collection.

Constructors

CollectionModel
Fields name :: Collection status :: Status environment :: Text size :: Maybe Natural dimension :: Maybe Natural vector_count :: Maybe Natural

Instances

Instances details

FromJSON CollectionModel Source #

Instance details

Defined in Pinecone.Backups

Methods

parseJSON :: Value -> Parser CollectionModel #

parseJSONList :: Value -> Parser [CollectionModel] #

omittedField :: Maybe CollectionModel #

ToJSON CollectionModel Source #

Instance details

Defined in Pinecone.Backups

Methods

toJSON :: CollectionModel -> Value #

toEncoding :: CollectionModel -> Encoding #

toJSONList :: [CollectionModel] -> Value #

toEncodingList :: [CollectionModel] -> Encoding #

omitField :: CollectionModel -> Bool #

Generic CollectionModel Source #

Instance details

Defined in Pinecone.Backups

Associated Types

type Rep CollectionModel

Instance details

Defined in Pinecone.Backups

type Rep CollectionModel = D1 ('MetaData "CollectionModel" "Pinecone.Backups" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "CollectionModel" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Collection) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status) :*: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "vector_count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))))))

Methods

from :: CollectionModel -> Rep CollectionModel x #

to :: Rep CollectionModel x -> CollectionModel #

Show CollectionModel Source #

Instance details

Defined in Pinecone.Backups

Methods

showsPrec :: Int -> CollectionModel -> ShowS #

show :: CollectionModel -> String #

showList :: [CollectionModel] -> ShowS #

Eq CollectionModel Source #

Instance details

Defined in Pinecone.Backups

Methods

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

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

type Rep CollectionModel Source #

Instance details

Defined in Pinecone.Backups

type Rep CollectionModel = D1 ('MetaData "CollectionModel" "Pinecone.Backups" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "CollectionModel" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Collection) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status) :*: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "vector_count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))))))

Other types

data Status Source #

The status of the operation.

Constructors

Initializing
Ready
Terminating

Instances

Instances details

FromJSON Status Source #

Instance details

Defined in Pinecone.Backups

Methods

parseJSON :: Value -> Parser Status #

parseJSONList :: Value -> Parser [Status] #

omittedField :: Maybe Status #

ToJSON Status Source #

Instance details

Defined in Pinecone.Backups

Methods

toJSON :: Status -> Value #

toEncoding :: Status -> Encoding #

toJSONList :: [Status] -> Value #

toEncodingList :: [Status] -> Encoding #

omitField :: Status -> Bool #

Generic Status Source #

Instance details

Defined in Pinecone.Backups

Associated Types

type Rep Status
Instance details Defined in Pinecone.Backups type Rep Status = D1 ('MetaData "Status" "Pinecone.Backups" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Initializing" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Ready" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Terminating" 'PrefixI 'False) (U1 :: Type -> Type)))