Network.Google.Resource.PubSub.Projects.Snapshots.Get

Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. BETA: This feature is part of a beta release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

See: Cloud Pub/Sub API Reference for pubsub.projects.snapshots.get.

REST Resource

type ProjectsSnapshotsGetResource = "v1" :> (Capture "snapshot" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Snapshot)))))))

A resource alias for pubsub.projects.snapshots.get method which the ProjectsSnapshotsGet request conforms to.

Creating a Request

projectsSnapshotsGet

Arguments

:: Text

psgsSnapshot

-> ProjectsSnapshotsGet

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

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

• psgsXgafv
• psgsSnapshot
• psgsUploadProtocol
• psgsAccessToken
• psgsUploadType
• psgsCallback

data ProjectsSnapshotsGet

Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. BETA: This feature is part of a beta release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

See: projectsSnapshotsGet smart constructor.

Instances

Eq ProjectsSnapshotsGet

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.Get

Methods

(==) :: ProjectsSnapshotsGet -> ProjectsSnapshotsGet -> Bool

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

Data ProjectsSnapshotsGet

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.Get

Methods

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

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

toConstr :: ProjectsSnapshotsGet -> Constr

dataTypeOf :: ProjectsSnapshotsGet -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ProjectsSnapshotsGet -> ProjectsSnapshotsGet

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

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

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

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

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

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

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

Show ProjectsSnapshotsGet

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.Get

Methods

showsPrec :: Int -> ProjectsSnapshotsGet -> ShowS

show :: ProjectsSnapshotsGet -> String

showList :: [ProjectsSnapshotsGet] -> ShowS

Generic ProjectsSnapshotsGet

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.Get

Associated Types

type Rep ProjectsSnapshotsGet :: Type -> Type

Methods

from :: ProjectsSnapshotsGet -> Rep ProjectsSnapshotsGet x

to :: Rep ProjectsSnapshotsGet x -> ProjectsSnapshotsGet

GoogleRequest ProjectsSnapshotsGet

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.Get

Associated Types

type Rs ProjectsSnapshotsGet :: Type

type Scopes ProjectsSnapshotsGet :: [Symbol]

Methods

requestClient :: ProjectsSnapshotsGet -> GClient (Rs ProjectsSnapshotsGet)

type Rep ProjectsSnapshotsGet

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.Get

type Rep ProjectsSnapshotsGet = D1 (MetaData "ProjectsSnapshotsGet" "Network.Google.Resource.PubSub.Projects.Snapshots.Get" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "ProjectsSnapshotsGet'" PrefixI True) ((S1 (MetaSel (Just "_psgsXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_psgsSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_psgsUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_psgsAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_psgsUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_psgsCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes ProjectsSnapshotsGet

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.Get

type Scopes ProjectsSnapshotsGet = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/pubsub" ': ([] :: [Symbol]))

type Rs ProjectsSnapshotsGet

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.Get

type Rs ProjectsSnapshotsGet = Snapshot

Request Lenses

psgsXgafv :: Lens' ProjectsSnapshotsGet (Maybe Xgafv)

V1 error format.

psgsSnapshot :: Lens' ProjectsSnapshotsGet Text

The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`.

psgsUploadProtocol :: Lens' ProjectsSnapshotsGet (Maybe Text)

Upload protocol for media (e.g. "raw", "multipart").

psgsAccessToken :: Lens' ProjectsSnapshotsGet (Maybe Text)

OAuth access token.

psgsUploadType :: Lens' ProjectsSnapshotsGet (Maybe Text)

Legacy upload protocol for media (e.g. "media", "multipart").

psgsCallback :: Lens' ProjectsSnapshotsGet (Maybe Text)

JSONP