gogol-core-0.3.0: Core data types and functionality for Gogol libraries.

Copyright(c) 2015-2016 Brendan Hay <brendan.g.hay@gmail.com>
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityprovisional
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Types

Description

 

Synopsis

Documentation

data AltJSON #

Constructors

AltJSON 

Instances

Eq AltJSON # 

Methods

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

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

Ord AltJSON # 
Read AltJSON # 
Show AltJSON # 
Generic AltJSON # 

Associated Types

type Rep AltJSON :: * -> * #

Methods

from :: AltJSON -> Rep AltJSON x #

to :: Rep AltJSON x -> AltJSON #

ToHttpApiData AltJSON # 
type Rep AltJSON # 
type Rep AltJSON = D1 (MetaData "AltJSON" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" False) (C1 (MetaCons "AltJSON" PrefixI False) U1)

data AltMedia #

Constructors

AltMedia 

Instances

Eq AltMedia # 
Ord AltMedia # 
Read AltMedia # 
Show AltMedia # 
Generic AltMedia # 

Associated Types

type Rep AltMedia :: * -> * #

Methods

from :: AltMedia -> Rep AltMedia x #

to :: Rep AltMedia x -> AltMedia #

ToHttpApiData AltMedia # 
GoogleClient fn => GoogleClient ((:>) * * AltMedia fn) # 

Associated Types

type Fn ((:>) * * AltMedia fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) AltMedia fn) -> Request -> Fn ((* :> *) AltMedia fn) #

type Rep AltMedia # 
type Rep AltMedia = D1 (MetaData "AltMedia" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" False) (C1 (MetaCons "AltMedia" PrefixI False) U1)
type Fn ((:>) * * AltMedia fn) # 
type Fn ((:>) * * AltMedia fn) = Body -> Fn fn

newtype OAuthScope #

An OAuth2 scope.

Constructors

OAuthScope Text 

Instances

Eq OAuthScope # 
Ord OAuthScope # 
Read OAuthScope # 
Show OAuthScope # 
IsString OAuthScope # 
Generic OAuthScope # 

Associated Types

type Rep OAuthScope :: * -> * #

ToJSON OAuthScope # 
FromJSON OAuthScope # 
ToHttpApiData OAuthScope # 
FromHttpApiData OAuthScope # 
type Rep OAuthScope # 
type Rep OAuthScope = D1 (MetaData "OAuthScope" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" True) (C1 (MetaCons "OAuthScope" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype AccessToken #

An OAuth2 access token.

Constructors

AccessToken Text 

Instances

Eq AccessToken # 
Ord AccessToken # 
Read AccessToken # 
Show AccessToken # 
IsString AccessToken # 
Generic AccessToken # 

Associated Types

type Rep AccessToken :: * -> * #

ToJSON AccessToken # 
FromJSON AccessToken # 
ToHttpApiData AccessToken # 
FromHttpApiData AccessToken # 
type Rep AccessToken # 
type Rep AccessToken = D1 (MetaData "AccessToken" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" True) (C1 (MetaCons "AccessToken" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype RefreshToken #

An OAuth2 refresh token.

Constructors

RefreshToken Text 

Instances

Eq RefreshToken # 
Ord RefreshToken # 
Read RefreshToken # 
Show RefreshToken # 
IsString RefreshToken # 
Generic RefreshToken # 

Associated Types

type Rep RefreshToken :: * -> * #

ToJSON RefreshToken # 
FromJSON RefreshToken # 
ToHttpApiData RefreshToken # 
FromHttpApiData RefreshToken # 
type Rep RefreshToken # 
type Rep RefreshToken = D1 (MetaData "RefreshToken" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" True) (C1 (MetaCons "RefreshToken" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ClientId #

A client identifier.

Constructors

ClientId Text 

Instances

Eq ClientId # 
Ord ClientId # 
Read ClientId # 
Show ClientId # 
IsString ClientId # 
Generic ClientId # 

Associated Types

type Rep ClientId :: * -> * #

Methods

from :: ClientId -> Rep ClientId x #

to :: Rep ClientId x -> ClientId #

ToJSON ClientId # 
FromJSON ClientId # 
ToHttpApiData ClientId # 
FromHttpApiData ClientId # 
type Rep ClientId # 
type Rep ClientId = D1 (MetaData "ClientId" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" True) (C1 (MetaCons "ClientId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ServiceId #

A service identifier.

Constructors

ServiceId Text 

Instances

Eq ServiceId # 
Ord ServiceId # 
Read ServiceId # 
Show ServiceId # 
IsString ServiceId # 
Generic ServiceId # 

Associated Types

type Rep ServiceId :: * -> * #

ToJSON ServiceId # 
FromJSON ServiceId # 
ToHttpApiData ServiceId # 
FromHttpApiData ServiceId # 
type Rep ServiceId # 
type Rep ServiceId = D1 (MetaData "ServiceId" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" True) (C1 (MetaCons "ServiceId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype Secret #

An opaque client secret.

Constructors

Secret Text 

Instances

Eq Secret # 

Methods

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

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

Ord Secret # 
Read Secret # 
Show Secret # 
IsString Secret # 

Methods

fromString :: String -> Secret #

Generic Secret # 

Associated Types

type Rep Secret :: * -> * #

Methods

from :: Secret -> Rep Secret x #

to :: Rep Secret x -> Secret #

ToJSON Secret # 
FromJSON Secret # 
ToHttpApiData Secret # 
FromHttpApiData Secret # 
type Rep Secret # 
type Rep Secret = D1 (MetaData "Secret" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" True) (C1 (MetaCons "Secret" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype MediaDownload a #

Constructors

MediaDownload a 

data MediaUpload a #

Constructors

MediaUpload a Body 

_Coerce :: (Coercible a b, Coercible b a) => Iso' a b #

_Default :: Monoid a => Iso' (Maybe a) a #

Invalid Iso, exists for ease of composition with the current 'Lens . Iso' chaining to hide internal types from the user.

class AsError a where #

Minimal complete definition

_Error

Methods

_Error :: Prism' a Error #

A general Amazonka error.

_TransportError :: Prism' a HttpException #

An error occured while communicating over HTTP with a remote service.

_SerializeError :: Prism' a SerializeError #

A serialisation error occured when attempting to deserialise a response.

_ServiceError :: Prism' a ServiceError #

A service specific error returned by the remote service.

serviceHost :: Lens' ServiceConfig ByteString #

The remote host name, used for both the IP address to connect to and the host request header.

servicePort :: Lens' ServiceConfig Int #

The remote port to connect to.

Defaults to 443.

servicePath :: Lens' ServiceConfig Builder #

A path prefix that is prepended to any sent HTTP request.

Defaults to mempty.

serviceSecure :: Lens' ServiceConfig Bool #

Whether to use HTTPS/SSL.

Defaults to True.

serviceTimeout :: Lens' ServiceConfig (Maybe Seconds) #

Number of seconds to wait for a response.

data Body #

A single part of a (potentially multipart) request body.

Note: The IsString instance defaults to a text/plain MIME type.

Constructors

Body !MediaType !RequestBody 

Instances

bodyContentType :: Lens' Body MediaType #

A lens into the MediaType of a request Body.

data Request #

An intermediary request builder.

data Client a #

A materialised 'http-client' request and associated response parser.

mime :: FromStream c a => Proxy c -> Method -> [Int] -> Request -> ServiceConfig -> Client a #

class Accept c => ToBody c a where #

Minimal complete definition

toBody

Methods

toBody :: Proxy c -> a -> Body #

class GoogleRequest a where #

Minimal complete definition

requestClient

Associated Types

type Rs a :: * #

type Scopes a :: [Symbol] #

Methods

requestClient :: a -> Client (Rs a) #

class GoogleClient fn where #

Minimal complete definition

buildClient

Associated Types

type Fn fn :: * #

Methods

buildClient :: Proxy fn -> Request -> Fn fn #

Instances

(GoogleClient a, GoogleClient b) => GoogleClient ((:<|>) a b) # 

Associated Types

type Fn ((:<|>) a b) :: * #

Methods

buildClient :: Proxy * (a :<|> b) -> Request -> Fn (a :<|> b) #

FromStream c a => GoogleClient (Get * ((:) * c cs) a) # 

Associated Types

type Fn (Get * ((:) * c cs) a) :: * #

Methods

buildClient :: Proxy * (Get * ((* ': c) cs) a) -> Request -> Fn (Get * ((* ': c) cs) a) #

GoogleClient (Get * ((:) * c cs) ()) # 

Associated Types

type Fn (Get * ((:) * c cs) ()) :: * #

Methods

buildClient :: Proxy * (Get * ((* ': c) cs) ()) -> Request -> Fn (Get * ((* ': c) cs) ()) #

GoogleClient (Post * cs ()) # 

Associated Types

type Fn (Post * cs ()) :: * #

Methods

buildClient :: Proxy * (Post * cs ()) -> Request -> Fn (Post * cs ()) #

(FromStream c a, (~) [*] cs' ((:) * c cs)) => GoogleClient (Post * cs' a) # 

Associated Types

type Fn (Post * cs' a) :: * #

Methods

buildClient :: Proxy * (Post * cs' a) -> Request -> Fn (Post * cs' a) #

FromStream c a => GoogleClient (Put * ((:) * c cs) a) # 

Associated Types

type Fn (Put * ((:) * c cs) a) :: * #

Methods

buildClient :: Proxy * (Put * ((* ': c) cs) a) -> Request -> Fn (Put * ((* ': c) cs) a) #

GoogleClient (Put * ((:) * c cs) ()) # 

Associated Types

type Fn (Put * ((:) * c cs) ()) :: * #

Methods

buildClient :: Proxy * (Put * ((* ': c) cs) ()) -> Request -> Fn (Put * ((* ': c) cs) ()) #

FromStream c a => GoogleClient (Delete * ((:) * c cs) a) # 

Associated Types

type Fn (Delete * ((:) * c cs) a) :: * #

Methods

buildClient :: Proxy * (Delete * ((* ': c) cs) a) -> Request -> Fn (Delete * ((* ': c) cs) a) #

GoogleClient (Delete * ((:) * c cs) ()) # 

Associated Types

type Fn (Delete * ((:) * c cs) ()) :: * #

Methods

buildClient :: Proxy * (Delete * ((* ': c) cs) ()) -> Request -> Fn (Delete * ((* ': c) cs) ()) #

FromStream c a => GoogleClient (Patch * ((:) * c cs) a) # 

Associated Types

type Fn (Patch * ((:) * c cs) a) :: * #

Methods

buildClient :: Proxy * (Patch * ((* ': c) cs) a) -> Request -> Fn (Patch * ((* ': c) cs) a) #

GoogleClient (Patch * ((:) * c cs) ()) # 

Associated Types

type Fn (Patch * ((:) * c cs) ()) :: * #

Methods

buildClient :: Proxy * (Patch * ((* ': c) cs) ()) -> Request -> Fn (Patch * ((* ': c) cs) ()) #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient ((:>) * * (Capture * s a) fn) # 

Associated Types

type Fn ((:>) * * (Capture * s a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (Capture * s a) fn) -> Request -> Fn ((* :> *) (Capture * s a) fn) #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient ((:>) * * (Header s a) fn) # 

Associated Types

type Fn ((:>) * * (Header s a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (Header s a) fn) -> Request -> Fn ((* :> *) (Header s a) fn) #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient ((:>) * * (QueryParam * s a) fn) # 

Associated Types

type Fn ((:>) * * (QueryParam * s a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (QueryParam * s a) fn) -> Request -> Fn ((* :> *) (QueryParam * s a) fn) #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient ((:>) * * (QueryParams * s a) fn) # 

Associated Types

type Fn ((:>) * * (QueryParams * s a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (QueryParams * s a) fn) -> Request -> Fn ((* :> *) (QueryParams * s a) fn) #

(ToBody c a, GoogleClient fn) => GoogleClient ((:>) * * (ReqBody * ((:) * c cs) a) fn) # 

Associated Types

type Fn ((:>) * * (ReqBody * ((:) * c cs) a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (ReqBody * ((* ': c) cs) a) fn) -> Request -> Fn ((* :> *) (ReqBody * ((* ': c) cs) a) fn) #

(ToBody c m, GoogleClient fn) => GoogleClient ((:>) * * (MultipartRelated ((:) * c cs) m) fn) # 

Associated Types

type Fn ((:>) * * (MultipartRelated ((:) * c cs) m) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (MultipartRelated ((* ': c) cs) m) fn) -> Request -> Fn ((* :> *) (MultipartRelated ((* ': c) cs) m) fn) #

(KnownSymbol s, KnownSymbol m, ToHttpApiData a, GoogleClient fn) => GoogleClient ((:>) * * (CaptureMode s m a) fn) # 

Associated Types

type Fn ((:>) * * (CaptureMode s m a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (CaptureMode s m a) fn) -> Request -> Fn ((* :> *) (CaptureMode s m a) fn) #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient ((:>) * * (Captures s a) fn) # 

Associated Types

type Fn ((:>) * * (Captures s a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (Captures s a) fn) -> Request -> Fn ((* :> *) (Captures s a) fn) #

GoogleClient fn => GoogleClient ((:>) * * AltMedia fn) # 

Associated Types

type Fn ((:>) * * AltMedia fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) AltMedia fn) -> Request -> Fn ((* :> *) AltMedia fn) #

(KnownSymbol s, GoogleClient fn) => GoogleClient ((:>) * Symbol s fn) # 

Associated Types

type Fn ((:>) * Symbol s fn) :: * #

Methods

buildClient :: Proxy * ((* :> Symbol) s fn) -> Request -> Fn ((* :> Symbol) s fn) #

data Captures s a #

Multiple path captures, with [xs] forming x1x2x2....

Instances

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient ((:>) * * (Captures s a) fn) # 

Associated Types

type Fn ((:>) * * (Captures s a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (Captures s a) fn) -> Request -> Fn ((* :> *) (Captures s a) fn) #

type Fn ((:>) * * (Captures s a) fn) # 
type Fn ((:>) * * (Captures s a) fn) = [a] -> Fn fn

data CaptureMode s m a #

Form a Google style sub-resource, such as /capture:mode.

Instances

(KnownSymbol s, KnownSymbol m, ToHttpApiData a, GoogleClient fn) => GoogleClient ((:>) * * (CaptureMode s m a) fn) # 

Associated Types

type Fn ((:>) * * (CaptureMode s m a) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (CaptureMode s m a) fn) -> Request -> Fn ((* :> *) (CaptureMode s m a) fn) #

type Fn ((:>) * * (CaptureMode s m a) fn) # 
type Fn ((:>) * * (CaptureMode s m a) fn) = a -> Fn fn

data MultipartRelated cs m #

Instances

(ToBody c m, GoogleClient fn) => GoogleClient ((:>) * * (MultipartRelated ((:) * c cs) m) fn) # 

Associated Types

type Fn ((:>) * * (MultipartRelated ((:) * c cs) m) fn) :: * #

Methods

buildClient :: Proxy * ((* :> *) (MultipartRelated ((* ': c) cs) m) fn) -> Request -> Fn ((* :> *) (MultipartRelated ((* ': c) cs) m) fn) #

type Fn ((:>) * * (MultipartRelated ((:) * c cs) m) fn) # 
type Fn ((:>) * * (MultipartRelated ((:) * c cs) m) fn) = m -> Body -> Fn fn

buildSymbol :: forall n proxy. KnownSymbol n => proxy n -> Builder #

byteSymbol :: forall n proxy. KnownSymbol n => proxy n -> ByteString #

newtype Seconds #

An integral value representing seconds.

Constructors

Seconds Int 

Instances

Bounded Seconds # 
Enum Seconds # 
Eq Seconds # 

Methods

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

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

Integral Seconds # 
Data Seconds # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Seconds -> c Seconds #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Seconds #

toConstr :: Seconds -> Constr #

dataTypeOf :: Seconds -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Seconds) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Seconds) #

gmapT :: (forall b. Data b => b -> b) -> Seconds -> Seconds #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Seconds -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Seconds -> r #

gmapQ :: (forall d. Data d => d -> u) -> Seconds -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Seconds -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Seconds -> m Seconds #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Seconds -> m Seconds #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Seconds -> m Seconds #

Num Seconds # 
Ord Seconds # 
Read Seconds # 
Real Seconds # 
Show Seconds # 
Generic Seconds # 

Associated Types

type Rep Seconds :: * -> * #

Methods

from :: Seconds -> Rep Seconds x #

to :: Rep Seconds x -> Seconds #

type Rep Seconds # 
type Rep Seconds = D1 (MetaData "Seconds" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" True) (C1 (MetaCons "Seconds" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

newtype FieldMask #

Constructors

FieldMask Text 

Instances

Eq FieldMask # 
Data FieldMask # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FieldMask -> c FieldMask #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FieldMask #

toConstr :: FieldMask -> Constr #

dataTypeOf :: FieldMask -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c FieldMask) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FieldMask) #

gmapT :: (forall b. Data b => b -> b) -> FieldMask -> FieldMask #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FieldMask -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FieldMask -> r #

gmapQ :: (forall d. Data d => d -> u) -> FieldMask -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> FieldMask -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FieldMask -> m FieldMask #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldMask -> m FieldMask #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldMask -> m FieldMask #

Ord FieldMask # 
Read FieldMask # 
Show FieldMask # 
IsString FieldMask # 
Generic FieldMask # 

Associated Types

type Rep FieldMask :: * -> * #

ToJSON FieldMask # 
FromJSON FieldMask # 
ToHttpApiData FieldMask # 
FromHttpApiData FieldMask # 
type Rep FieldMask # 
type Rep FieldMask = D1 (MetaData "FieldMask" "Network.Google.Types" "gogol-core-0.3.0-5vygRZZYJCn1NAeiaNwNF9" True) (C1 (MetaCons "FieldMask" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))