Network.Google.Resource.Storage.Objects.Get

Retrieves an object or its metadata.

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

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))))))))))))))

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

Creating a Request

objectsGet

Arguments

:: Text

ogBucket

-> Text

ogObject

-> ObjectsGet

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:

• ogIfMetagenerationMatch
• ogIfGenerationNotMatch
• ogIfGenerationMatch
• ogBucket
• ogUserProject
• ogIfMetagenerationNotMatch
• ogObject
• ogProjection
• ogGeneration

data ObjectsGet

Retrieves an object or its metadata.

See: objectsGet smart constructor.

Instances

Eq ObjectsGet

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

Methods

(==) :: ObjectsGet -> ObjectsGet -> Bool

(/=) :: ObjectsGet -> ObjectsGet -> Bool

Data ObjectsGet

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

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

Methods

showsPrec :: Int -> ObjectsGet -> ShowS

show :: ObjectsGet -> String

showList :: [ObjectsGet] -> ShowS

Generic ObjectsGet

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

Associated Types

type Rep ObjectsGet :: Type -> Type

Methods

from :: ObjectsGet -> Rep ObjectsGet x

to :: Rep ObjectsGet x -> ObjectsGet

GoogleRequest ObjectsGet

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

Associated Types

type Rs ObjectsGet :: Type

type Scopes ObjectsGet :: [Symbol]

Methods

requestClient :: ObjectsGet -> GClient (Rs ObjectsGet)

GoogleRequest (MediaDownload ObjectsGet)

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

Associated Types

type Rs (MediaDownload ObjectsGet) :: Type

type Scopes (MediaDownload ObjectsGet) :: [Symbol]

Methods

requestClient :: MediaDownload ObjectsGet -> GClient (Rs (MediaDownload ObjectsGet))

type Rep ObjectsGet

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

type Rep ObjectsGet = D1 (MetaData "ObjectsGet" "Network.Google.Resource.Storage.Objects.Get" "gogol-storage-0.4.0-F1QXZopXJqf9Y2QJKwfuR3" False) (C1 (MetaCons "ObjectsGet'" PrefixI True) (((S1 (MetaSel (Just "_ogIfMetagenerationMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_ogIfGenerationNotMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) :*: (S1 (MetaSel (Just "_ogIfGenerationMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_ogBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_ogUserProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ogIfMetagenerationNotMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) :*: (S1 (MetaSel (Just "_ogObject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_ogProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ObjectsGetProjection)) :*: S1 (MetaSel (Just "_ogGeneration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))))))))

type Scopes ObjectsGet

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

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

type Rs ObjectsGet = Object

type Scopes (MediaDownload ObjectsGet)

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

type Scopes (MediaDownload ObjectsGet) = Scopes ObjectsGet

type Rs (MediaDownload ObjectsGet)

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

type Rs (MediaDownload ObjectsGet) = Stream

Request Lenses

ogIfMetagenerationMatch :: Lens' ObjectsGet (Maybe Int64)

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

ogIfGenerationNotMatch :: Lens' ObjectsGet (Maybe Int64)

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)

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

Name of the bucket in which the object resides.

ogUserProject :: Lens' ObjectsGet (Maybe Text)

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

ogIfMetagenerationNotMatch :: Lens' ObjectsGet (Maybe Int64)

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

ogObject :: Lens' ObjectsGet Text

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)

Set of properties to return. Defaults to noAcl.

ogGeneration :: Lens' ObjectsGet (Maybe Int64)

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