gogol-storage-0.4.0: Google Cloud Storage JSON SDK.

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

Network.Google.Resource.Storage.Objects.Get

Contents

Description

Retrieves an object or its metadata.

See: Cloud Storage JSON API Reference for storage.objects.get.

Synopsis

REST Resource

type ObjectsGetResource = ("storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (Capture "object" Text :> (QueryParam "ifMetagenerationMatch" (Textual Int64) :> (QueryParam "ifGenerationNotMatch" (Textual Int64) :> (QueryParam "ifGenerationMatch" (Textual Int64) :> (QueryParam "userProject" Text :> (QueryParam "ifMetagenerationNotMatch" (Textual Int64) :> (QueryParam "projection" ObjectsGetProjection :> (QueryParam "generation" (Textual Int64) :> (QueryParam "alt" AltJSON :> Get '[JSON] Object)))))))))))))) :<|> ("storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (Capture "object" Text :> (QueryParam "ifMetagenerationMatch" (Textual Int64) :> (QueryParam "ifGenerationNotMatch" (Textual Int64) :> (QueryParam "ifGenerationMatch" (Textual Int64) :> (QueryParam "userProject" Text :> (QueryParam "ifMetagenerationNotMatch" (Textual Int64) :> (QueryParam "projection" ObjectsGetProjection :> (QueryParam "generation" (Textual Int64) :> (QueryParam "alt" AltMedia :> Get '[OctetStream] Stream)))))))))))))) Source #

A resource alias for storage.objects.get method which the ObjectsGet request conforms to.

Creating a Request

objectsGet Source #

Creates a value of ObjectsGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ObjectsGet Source #

Retrieves an object or its metadata.

See: objectsGet smart constructor.

Instances
Eq ObjectsGet Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

Data ObjectsGet Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

Methods

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

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

toConstr :: ObjectsGet -> Constr #

dataTypeOf :: ObjectsGet -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ObjectsGet Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

Generic ObjectsGet Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

Associated Types

type Rep ObjectsGet :: Type -> Type #

GoogleRequest ObjectsGet Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

Associated Types

type Rs ObjectsGet :: Type #

type Scopes ObjectsGet :: [Symbol] #

GoogleRequest (MediaDownload ObjectsGet) Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

Associated Types

type Rs (MediaDownload ObjectsGet) :: Type #

type Scopes (MediaDownload ObjectsGet) :: [Symbol] #

type Rep ObjectsGet Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

type Scopes ObjectsGet Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

type Scopes ObjectsGet = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/cloud-platform.read-only" ': ("https://www.googleapis.com/auth/devstorage.full_control" ': ("https://www.googleapis.com/auth/devstorage.read_only" ': ("https://www.googleapis.com/auth/devstorage.read_write" ': ([] :: [Symbol])))))
type Rs ObjectsGet Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

type Scopes (MediaDownload ObjectsGet) Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

type Rs (MediaDownload ObjectsGet) Source # 
Instance details

Defined in Network.Google.Resource.Storage.Objects.Get

Request Lenses

ogIfMetagenerationMatch :: Lens' ObjectsGet (Maybe Int64) Source #

Makes the operation conditional on whether the object's current metageneration matches the given value.

ogIfGenerationNotMatch :: Lens' ObjectsGet (Maybe Int64) Source #

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

ogIfGenerationMatch :: Lens' ObjectsGet (Maybe Int64) Source #

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

ogBucket :: Lens' ObjectsGet Text Source #

Name of the bucket in which the object resides.

ogUserProject :: Lens' ObjectsGet (Maybe Text) Source #

The project to be billed for this request. Required for Requester Pays buckets.

ogIfMetagenerationNotMatch :: Lens' ObjectsGet (Maybe Int64) Source #

Makes the operation conditional on whether the object's current metageneration does not match the given value.

ogObject :: Lens' ObjectsGet Text Source #

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

ogProjection :: Lens' ObjectsGet (Maybe ObjectsGetProjection) Source #

Set of properties to return. Defaults to noAcl.

ogGeneration :: Lens' ObjectsGet (Maybe Int64) Source #

If present, selects a specific revision of this object (as opposed to the latest version, the default).