Network.Goggles.GCS

Dependencies

The examples require the following declarations (which in turn mean that the req and bytestring libraries are imported by the user's project). You will also need the OverloadedStrings language extension :

import qualified Data.ByteString.Lazy as LB
import Network.HTTP.Req (responseBody)
import Network.Goggles

Examples

This first example, listBucket, reads content from a cloud storage bucket:

1. it loads the GCP credentials (username and RSA key),
2. retrieves a token via OAuth2,
3. performs a single call to the Cloud Storage API endpoint that lists the metadata related to the contents of a storage bucket, and
4. returns the raw API data to the user as a lazy ByteString.

listBucket :: IO LB.ByteString
listBucket = do
  let usr = "...iam.gserviceaccount.com"
      bucket = "<my-gcs-bucket>"
      key = "<rsa_key>"
  pvtkey <- parseRSAPrivateKey key
  let creds = GCPServiceAccount pvtkey usr Nothing ""
  hdl <- createHandle creds scopesDefault
  responseBody <$> evalWebApiIO hdl (listObjects bucket)

Documentation

data GCP

Instances

HasCredentials GCP

Associated Types

type Credentials GCP :: *

HasToken GCP

Associated Types

type TokenContent GCP :: *

type Options GCP :: *

Methods

tokenFetch :: WebApiM GCP (Token GCP)

Show (Token GCP)

Methods

showsPrec :: Int -> Token GCP -> ShowS

show :: Token GCP -> String

showList :: [Token GCP] -> ShowS

MonadHttp (WebApiM GCP)

We can provide a custom http exception handler rather than throwing exceptions with this instance

Methods

handleHttpException :: HttpException -> WebApiM GCP a

getHttpConfig :: WebApiM GCP HttpConfig

type Credentials GCP

type Credentials GCP

type Options GCP

type Options GCP

type TokenContent GCP

type TokenContent GCP = Text

scopesDefault :: [Text]

OAuth2 scopes for the various Google Cloud Platform services.

Please refer to

https://developers.google.com/identity/protocols/googlescopes

for the full list

getObject :: Text -> Text -> WebApiM GCP LbsResponse

`getObject b p` retrieves the contents of a GCS object (of full path p) in bucket b

getObjectMetadata :: Text -> Text -> WebApiM GCP LbsResponse

`getObjectMetadata b p` retrieves the metadata of a GCS object (of full path p) in bucket b

listObjects :: Text -> WebApiM GCP LbsResponse

`listObjects b` retrieves a list of objects stored in bucket b

putObject :: Text -> Text -> ByteString -> WebApiM GCP LbsResponse

`putObject b p body` uploads a bytestring body into a GCS object (of full path p) in bucket b

requestTokenGCP :: WebApiM GCP (Token GCP)

Implementation of tokenFetch