Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- pubsub.projects.snapshots.create
- pubsub.projects.snapshots.delete
- pubsub.projects.snapshots.get
- pubsub.projects.snapshots.getIamPolicy
- pubsub.projects.snapshots.list
- pubsub.projects.snapshots.patch
- pubsub.projects.snapshots.setIamPolicy
- pubsub.projects.snapshots.testIamPermissions
- pubsub.projects.subscriptions.acknowledge
- pubsub.projects.subscriptions.create
- pubsub.projects.subscriptions.delete
- pubsub.projects.subscriptions.get
- pubsub.projects.subscriptions.getIamPolicy
- pubsub.projects.subscriptions.list
- pubsub.projects.subscriptions.modifyAckDeadline
- pubsub.projects.subscriptions.modifyPushConfig
- pubsub.projects.subscriptions.patch
- pubsub.projects.subscriptions.pull
- pubsub.projects.subscriptions.seek
- pubsub.projects.subscriptions.setIamPolicy
- pubsub.projects.subscriptions.testIamPermissions
- pubsub.projects.topics.create
- pubsub.projects.topics.delete
- pubsub.projects.topics.get
- pubsub.projects.topics.getIamPolicy
- pubsub.projects.topics.list
- pubsub.projects.topics.patch
- pubsub.projects.topics.publish
- pubsub.projects.topics.setIamPolicy
- pubsub.projects.topics.snapshots.list
- pubsub.projects.topics.subscriptions.list
- pubsub.projects.topics.testIamPermissions
- Types
- PushConfig
- ReceivedMessage
- Snapshot
- ListTopicSnapshotsResponse
- Expr
- ModifyAckDeadlineRequest
- ModifyPushConfigRequest
- Empty
- PubsubMessage
- ListTopicSubscriptionsResponse
- ListTopicsResponse
- PullResponse
- ListSnapshotsResponse
- SetIAMPolicyRequest
- CreateSnapshotRequest
- SeekRequest
- Topic
- TopicLabels
- CreateSnapshotRequestLabels
- UpdateSnapshotRequest
- PullRequest
- PubsubMessageAttributes
- Xgafv
- TestIAMPermissionsRequest
- PublishResponse
- PublishRequest
- TestIAMPermissionsResponse
- Policy
- SeekResponse
- ExpirationPolicy
- PushConfigAttributes
- Subscription
- UpdateSubscriptionRequest
- SubscriptionLabels
- SnapshotLabels
- ListSubscriptionsResponse
- Binding
- UpdateTopicRequest
- AcknowledgeRequest
Provides reliable, many-to-many, asynchronous messaging between applications.
Synopsis
- pubSubService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- pubSubScope :: Proxy '["https://www.googleapis.com/auth/pubsub"]
- type PubSubAPI = ProjectsTopicsSnapshotsListResource :<|> (ProjectsTopicsSubscriptionsListResource :<|> (ProjectsTopicsListResource :<|> (ProjectsTopicsGetIAMPolicyResource :<|> (ProjectsTopicsPatchResource :<|> (ProjectsTopicsGetResource :<|> (ProjectsTopicsCreateResource :<|> (ProjectsTopicsSetIAMPolicyResource :<|> (ProjectsTopicsTestIAMPermissionsResource :<|> (ProjectsTopicsDeleteResource :<|> (ProjectsTopicsPublishResource :<|> (ProjectsSnapshotsListResource :<|> (ProjectsSnapshotsGetIAMPolicyResource :<|> (ProjectsSnapshotsPatchResource :<|> (ProjectsSnapshotsGetResource :<|> (ProjectsSnapshotsCreateResource :<|> (ProjectsSnapshotsSetIAMPolicyResource :<|> (ProjectsSnapshotsTestIAMPermissionsResource :<|> (ProjectsSnapshotsDeleteResource :<|> (ProjectsSubscriptionsListResource :<|> (ProjectsSubscriptionsAcknowledgeResource :<|> (ProjectsSubscriptionsGetIAMPolicyResource :<|> (ProjectsSubscriptionsModifyAckDeadlineResource :<|> (ProjectsSubscriptionsPatchResource :<|> (ProjectsSubscriptionsGetResource :<|> (ProjectsSubscriptionsModifyPushConfigResource :<|> (ProjectsSubscriptionsCreateResource :<|> (ProjectsSubscriptionsSetIAMPolicyResource :<|> (ProjectsSubscriptionsPullResource :<|> (ProjectsSubscriptionsSeekResource :<|> (ProjectsSubscriptionsTestIAMPermissionsResource :<|> ProjectsSubscriptionsDeleteResource))))))))))))))))))))))))))))))
- module Network.Google.Resource.PubSub.Projects.Snapshots.Create
- module Network.Google.Resource.PubSub.Projects.Snapshots.Delete
- module Network.Google.Resource.PubSub.Projects.Snapshots.Get
- module Network.Google.Resource.PubSub.Projects.Snapshots.GetIAMPolicy
- module Network.Google.Resource.PubSub.Projects.Snapshots.List
- module Network.Google.Resource.PubSub.Projects.Snapshots.Patch
- module Network.Google.Resource.PubSub.Projects.Snapshots.SetIAMPolicy
- module Network.Google.Resource.PubSub.Projects.Snapshots.TestIAMPermissions
- module Network.Google.Resource.PubSub.Projects.Subscriptions.Acknowledge
- module Network.Google.Resource.PubSub.Projects.Subscriptions.Create
- module Network.Google.Resource.PubSub.Projects.Subscriptions.Delete
- module Network.Google.Resource.PubSub.Projects.Subscriptions.Get
- module Network.Google.Resource.PubSub.Projects.Subscriptions.GetIAMPolicy
- module Network.Google.Resource.PubSub.Projects.Subscriptions.List
- module Network.Google.Resource.PubSub.Projects.Subscriptions.ModifyAckDeadline
- module Network.Google.Resource.PubSub.Projects.Subscriptions.ModifyPushConfig
- module Network.Google.Resource.PubSub.Projects.Subscriptions.Patch
- module Network.Google.Resource.PubSub.Projects.Subscriptions.Pull
- module Network.Google.Resource.PubSub.Projects.Subscriptions.Seek
- module Network.Google.Resource.PubSub.Projects.Subscriptions.SetIAMPolicy
- module Network.Google.Resource.PubSub.Projects.Subscriptions.TestIAMPermissions
- module Network.Google.Resource.PubSub.Projects.Topics.Create
- module Network.Google.Resource.PubSub.Projects.Topics.Delete
- module Network.Google.Resource.PubSub.Projects.Topics.Get
- module Network.Google.Resource.PubSub.Projects.Topics.GetIAMPolicy
- module Network.Google.Resource.PubSub.Projects.Topics.List
- module Network.Google.Resource.PubSub.Projects.Topics.Patch
- module Network.Google.Resource.PubSub.Projects.Topics.Publish
- module Network.Google.Resource.PubSub.Projects.Topics.SetIAMPolicy
- module Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List
- module Network.Google.Resource.PubSub.Projects.Topics.Subscriptions.List
- module Network.Google.Resource.PubSub.Projects.Topics.TestIAMPermissions
- data PushConfig
- pushConfig :: PushConfig
- pcAttributes :: Lens' PushConfig (Maybe PushConfigAttributes)
- pcPushEndpoint :: Lens' PushConfig (Maybe Text)
- data ReceivedMessage
- receivedMessage :: ReceivedMessage
- rmAckId :: Lens' ReceivedMessage (Maybe Text)
- rmMessage :: Lens' ReceivedMessage (Maybe PubsubMessage)
- data Snapshot
- snapshot :: Snapshot
- sTopic :: Lens' Snapshot (Maybe Text)
- sName :: Lens' Snapshot (Maybe Text)
- sLabels :: Lens' Snapshot (Maybe SnapshotLabels)
- sExpireTime :: Lens' Snapshot (Maybe UTCTime)
- data ListTopicSnapshotsResponse
- listTopicSnapshotsResponse :: ListTopicSnapshotsResponse
- ltsrNextPageToken :: Lens' ListTopicSnapshotsResponse (Maybe Text)
- ltsrSnapshots :: Lens' ListTopicSnapshotsResponse [Text]
- data Expr
- expr :: Expr
- eLocation :: Lens' Expr (Maybe Text)
- eExpression :: Lens' Expr (Maybe Text)
- eTitle :: Lens' Expr (Maybe Text)
- eDescription :: Lens' Expr (Maybe Text)
- data ModifyAckDeadlineRequest
- modifyAckDeadlineRequest :: ModifyAckDeadlineRequest
- madrAckIds :: Lens' ModifyAckDeadlineRequest [Text]
- madrAckDeadlineSeconds :: Lens' ModifyAckDeadlineRequest (Maybe Int32)
- data ModifyPushConfigRequest
- modifyPushConfigRequest :: ModifyPushConfigRequest
- mpcrPushConfig :: Lens' ModifyPushConfigRequest (Maybe PushConfig)
- data Empty
- empty :: Empty
- data PubsubMessage
- pubsubMessage :: PubsubMessage
- pmData :: Lens' PubsubMessage (Maybe ByteString)
- pmPublishTime :: Lens' PubsubMessage (Maybe UTCTime)
- pmAttributes :: Lens' PubsubMessage (Maybe PubsubMessageAttributes)
- pmMessageId :: Lens' PubsubMessage (Maybe Text)
- data ListTopicSubscriptionsResponse
- listTopicSubscriptionsResponse :: ListTopicSubscriptionsResponse
- lNextPageToken :: Lens' ListTopicSubscriptionsResponse (Maybe Text)
- lSubscriptions :: Lens' ListTopicSubscriptionsResponse [Text]
- data ListTopicsResponse
- listTopicsResponse :: ListTopicsResponse
- ltrNextPageToken :: Lens' ListTopicsResponse (Maybe Text)
- ltrTopics :: Lens' ListTopicsResponse [Topic]
- data PullResponse
- pullResponse :: PullResponse
- prReceivedMessages :: Lens' PullResponse [ReceivedMessage]
- data ListSnapshotsResponse
- listSnapshotsResponse :: ListSnapshotsResponse
- lsrNextPageToken :: Lens' ListSnapshotsResponse (Maybe Text)
- lsrSnapshots :: Lens' ListSnapshotsResponse [Snapshot]
- data SetIAMPolicyRequest
- setIAMPolicyRequest :: SetIAMPolicyRequest
- siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy)
- data CreateSnapshotRequest
- createSnapshotRequest :: CreateSnapshotRequest
- csrLabels :: Lens' CreateSnapshotRequest (Maybe CreateSnapshotRequestLabels)
- csrSubscription :: Lens' CreateSnapshotRequest (Maybe Text)
- data SeekRequest
- seekRequest :: SeekRequest
- srSnapshot :: Lens' SeekRequest (Maybe Text)
- srTime :: Lens' SeekRequest (Maybe UTCTime)
- data Topic
- topic :: Topic
- tName :: Lens' Topic (Maybe Text)
- tLabels :: Lens' Topic (Maybe TopicLabels)
- data TopicLabels
- topicLabels :: HashMap Text Text -> TopicLabels
- tlAddtional :: Lens' TopicLabels (HashMap Text Text)
- data CreateSnapshotRequestLabels
- createSnapshotRequestLabels :: HashMap Text Text -> CreateSnapshotRequestLabels
- csrlAddtional :: Lens' CreateSnapshotRequestLabels (HashMap Text Text)
- data UpdateSnapshotRequest
- updateSnapshotRequest :: UpdateSnapshotRequest
- usrSnapshot :: Lens' UpdateSnapshotRequest (Maybe Snapshot)
- usrUpdateMask :: Lens' UpdateSnapshotRequest (Maybe GFieldMask)
- data PullRequest
- pullRequest :: PullRequest
- prMaxMessages :: Lens' PullRequest (Maybe Int32)
- prReturnImmediately :: Lens' PullRequest (Maybe Bool)
- data PubsubMessageAttributes
- pubsubMessageAttributes :: HashMap Text Text -> PubsubMessageAttributes
- pmaAddtional :: Lens' PubsubMessageAttributes (HashMap Text Text)
- data Xgafv
- data TestIAMPermissionsRequest
- testIAMPermissionsRequest :: TestIAMPermissionsRequest
- tiprPermissions :: Lens' TestIAMPermissionsRequest [Text]
- data PublishResponse
- publishResponse :: PublishResponse
- prMessageIds :: Lens' PublishResponse [Text]
- data PublishRequest
- publishRequest :: PublishRequest
- prMessages :: Lens' PublishRequest [PubsubMessage]
- data TestIAMPermissionsResponse
- testIAMPermissionsResponse :: TestIAMPermissionsResponse
- tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text]
- data Policy
- policy :: Policy
- pEtag :: Lens' Policy (Maybe ByteString)
- pVersion :: Lens' Policy (Maybe Int32)
- pBindings :: Lens' Policy [Binding]
- data SeekResponse
- seekResponse :: SeekResponse
- data ExpirationPolicy
- expirationPolicy :: ExpirationPolicy
- epTtl :: Lens' ExpirationPolicy (Maybe Scientific)
- data PushConfigAttributes
- pushConfigAttributes :: HashMap Text Text -> PushConfigAttributes
- pcaAddtional :: Lens' PushConfigAttributes (HashMap Text Text)
- data Subscription
- subscription :: Subscription
- subPushConfig :: Lens' Subscription (Maybe PushConfig)
- subMessageRetentionDuration :: Lens' Subscription (Maybe Scientific)
- subTopic :: Lens' Subscription (Maybe Text)
- subName :: Lens' Subscription (Maybe Text)
- subLabels :: Lens' Subscription (Maybe SubscriptionLabels)
- subRetainAckedMessages :: Lens' Subscription (Maybe Bool)
- subAckDeadlineSeconds :: Lens' Subscription (Maybe Int32)
- subExpirationPolicy :: Lens' Subscription (Maybe ExpirationPolicy)
- data UpdateSubscriptionRequest
- updateSubscriptionRequest :: UpdateSubscriptionRequest
- uUpdateMask :: Lens' UpdateSubscriptionRequest (Maybe GFieldMask)
- uSubscription :: Lens' UpdateSubscriptionRequest (Maybe Subscription)
- data SubscriptionLabels
- subscriptionLabels :: HashMap Text Text -> SubscriptionLabels
- slAddtional :: Lens' SubscriptionLabels (HashMap Text Text)
- data SnapshotLabels
- snapshotLabels :: HashMap Text Text -> SnapshotLabels
- sAddtional :: Lens' SnapshotLabels (HashMap Text Text)
- data ListSubscriptionsResponse
- listSubscriptionsResponse :: ListSubscriptionsResponse
- lisNextPageToken :: Lens' ListSubscriptionsResponse (Maybe Text)
- lisSubscriptions :: Lens' ListSubscriptionsResponse [Subscription]
- data Binding
- binding :: Binding
- bMembers :: Lens' Binding [Text]
- bRole :: Lens' Binding (Maybe Text)
- bCondition :: Lens' Binding (Maybe Expr)
- data UpdateTopicRequest
- updateTopicRequest :: UpdateTopicRequest
- utrUpdateMask :: Lens' UpdateTopicRequest (Maybe GFieldMask)
- utrTopic :: Lens' UpdateTopicRequest (Maybe Topic)
- data AcknowledgeRequest
- acknowledgeRequest :: AcknowledgeRequest
- arAckIds :: Lens' AcknowledgeRequest [Text]
Service Configuration
pubSubService :: ServiceConfig Source #
Default request referring to version v1
of the Cloud Pub/Sub API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
pubSubScope :: Proxy '["https://www.googleapis.com/auth/pubsub"] Source #
View and manage Pub/Sub topics and subscriptions
API Declaration
type PubSubAPI = ProjectsTopicsSnapshotsListResource :<|> (ProjectsTopicsSubscriptionsListResource :<|> (ProjectsTopicsListResource :<|> (ProjectsTopicsGetIAMPolicyResource :<|> (ProjectsTopicsPatchResource :<|> (ProjectsTopicsGetResource :<|> (ProjectsTopicsCreateResource :<|> (ProjectsTopicsSetIAMPolicyResource :<|> (ProjectsTopicsTestIAMPermissionsResource :<|> (ProjectsTopicsDeleteResource :<|> (ProjectsTopicsPublishResource :<|> (ProjectsSnapshotsListResource :<|> (ProjectsSnapshotsGetIAMPolicyResource :<|> (ProjectsSnapshotsPatchResource :<|> (ProjectsSnapshotsGetResource :<|> (ProjectsSnapshotsCreateResource :<|> (ProjectsSnapshotsSetIAMPolicyResource :<|> (ProjectsSnapshotsTestIAMPermissionsResource :<|> (ProjectsSnapshotsDeleteResource :<|> (ProjectsSubscriptionsListResource :<|> (ProjectsSubscriptionsAcknowledgeResource :<|> (ProjectsSubscriptionsGetIAMPolicyResource :<|> (ProjectsSubscriptionsModifyAckDeadlineResource :<|> (ProjectsSubscriptionsPatchResource :<|> (ProjectsSubscriptionsGetResource :<|> (ProjectsSubscriptionsModifyPushConfigResource :<|> (ProjectsSubscriptionsCreateResource :<|> (ProjectsSubscriptionsSetIAMPolicyResource :<|> (ProjectsSubscriptionsPullResource :<|> (ProjectsSubscriptionsSeekResource :<|> (ProjectsSubscriptionsTestIAMPermissionsResource :<|> ProjectsSubscriptionsDeleteResource)))))))))))))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Cloud Pub/Sub API service.
Resources
pubsub.projects.snapshots.create
pubsub.projects.snapshots.delete
pubsub.projects.snapshots.get
pubsub.projects.snapshots.getIamPolicy
pubsub.projects.snapshots.list
pubsub.projects.snapshots.patch
pubsub.projects.snapshots.setIamPolicy
pubsub.projects.snapshots.testIamPermissions
pubsub.projects.subscriptions.acknowledge
pubsub.projects.subscriptions.create
pubsub.projects.subscriptions.delete
pubsub.projects.subscriptions.get
pubsub.projects.subscriptions.getIamPolicy
pubsub.projects.subscriptions.list
pubsub.projects.subscriptions.modifyAckDeadline
pubsub.projects.subscriptions.modifyPushConfig
pubsub.projects.subscriptions.patch
pubsub.projects.subscriptions.pull
pubsub.projects.subscriptions.seek
pubsub.projects.subscriptions.setIamPolicy
pubsub.projects.subscriptions.testIamPermissions
pubsub.projects.topics.create
pubsub.projects.topics.delete
pubsub.projects.topics.get
pubsub.projects.topics.getIamPolicy
pubsub.projects.topics.list
pubsub.projects.topics.patch
pubsub.projects.topics.publish
pubsub.projects.topics.setIamPolicy
pubsub.projects.topics.snapshots.list
pubsub.projects.topics.subscriptions.list
pubsub.projects.topics.testIamPermissions
Types
PushConfig
data PushConfig Source #
Configuration for a push delivery endpoint.
See: pushConfig
smart constructor.
Instances
pushConfig :: PushConfig Source #
Creates a value of PushConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcAttributes :: Lens' PushConfig (Maybe PushConfigAttributes) Source #
Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
pcPushEndpoint :: Lens' PushConfig (Maybe Text) Source #
A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
ReceivedMessage
data ReceivedMessage Source #
A message and its corresponding acknowledgment ID.
See: receivedMessage
smart constructor.
Instances
receivedMessage :: ReceivedMessage Source #
Creates a value of ReceivedMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmAckId :: Lens' ReceivedMessage (Maybe Text) Source #
This ID can be used to acknowledge the received message.
rmMessage :: Lens' ReceivedMessage (Maybe PubsubMessage) Source #
The message.
Snapshot
A snapshot resource. 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: snapshot
smart constructor.
Instances
Creates a value of Snapshot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sTopic :: Lens' Snapshot (Maybe Text) Source #
The name of the topic from which this snapshot is retaining messages.
sExpireTime :: Lens' Snapshot (Maybe UTCTime) Source #
The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.
ListTopicSnapshotsResponse
data ListTopicSnapshotsResponse Source #
Response for the `ListTopicSnapshots` method. 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: listTopicSnapshotsResponse
smart constructor.
Instances
listTopicSnapshotsResponse :: ListTopicSnapshotsResponse Source #
Creates a value of ListTopicSnapshotsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltsrNextPageToken :: Lens' ListTopicSnapshotsResponse (Maybe Text) Source #
If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new `ListTopicSnapshotsRequest` to get more snapshots.
ltsrSnapshots :: Lens' ListTopicSnapshotsResponse [Text] Source #
The names of the snapshots that match the request.
Expr
Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
See: expr
smart constructor.
Instances
Eq Expr Source # | |
Data Expr Source # | |
Defined in Network.Google.PubSub.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Expr -> c Expr # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Expr # dataTypeOf :: Expr -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Expr) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Expr) # gmapT :: (forall b. Data b => b -> b) -> Expr -> Expr # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Expr -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Expr -> r # gmapQ :: (forall d. Data d => d -> u) -> Expr -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Expr -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Expr -> m Expr # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Expr -> m Expr # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Expr -> m Expr # | |
Show Expr Source # | |
Generic Expr Source # | |
ToJSON Expr Source # | |
Defined in Network.Google.PubSub.Types.Product | |
FromJSON Expr Source # | |
type Rep Expr Source # | |
Defined in Network.Google.PubSub.Types.Product type Rep Expr = D1 (MetaData "Expr" "Network.Google.PubSub.Types.Product" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "Expr'" PrefixI True) ((S1 (MetaSel (Just "_eLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_eTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
Creates a value of Expr
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eLocation :: Lens' Expr (Maybe Text) Source #
An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
eExpression :: Lens' Expr (Maybe Text) Source #
Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
eTitle :: Lens' Expr (Maybe Text) Source #
An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
eDescription :: Lens' Expr (Maybe Text) Source #
An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
ModifyAckDeadlineRequest
data ModifyAckDeadlineRequest Source #
Request for the ModifyAckDeadline method.
See: modifyAckDeadlineRequest
smart constructor.
Instances
modifyAckDeadlineRequest :: ModifyAckDeadlineRequest Source #
Creates a value of ModifyAckDeadlineRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
madrAckIds :: Lens' ModifyAckDeadlineRequest [Text] Source #
List of acknowledgment IDs.
madrAckDeadlineSeconds :: Lens' ModifyAckDeadlineRequest (Maybe Int32) Source #
The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
ModifyPushConfigRequest
data ModifyPushConfigRequest Source #
Request for the ModifyPushConfig method.
See: modifyPushConfigRequest
smart constructor.
Instances
modifyPushConfigRequest :: ModifyPushConfigRequest Source #
Creates a value of ModifyPushConfigRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mpcrPushConfig :: Lens' ModifyPushConfigRequest (Maybe PushConfig) Source #
The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
Instances
Eq Empty Source # | |
Data Empty Source # | |
Defined in Network.Google.PubSub.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
Defined in Network.Google.PubSub.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
PubsubMessage
data PubsubMessage Source #
A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See Quotas and limits for more information about message limits.
See: pubsubMessage
smart constructor.
Instances
pubsubMessage :: PubsubMessage Source #
Creates a value of PubsubMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pmData :: Lens' PubsubMessage (Maybe ByteString) Source #
The message data field. If this field is empty, the message must contain at least one attribute.
pmPublishTime :: Lens' PubsubMessage (Maybe UTCTime) Source #
The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
pmAttributes :: Lens' PubsubMessage (Maybe PubsubMessageAttributes) Source #
Optional attributes for this message.
pmMessageId :: Lens' PubsubMessage (Maybe Text) Source #
ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
ListTopicSubscriptionsResponse
data ListTopicSubscriptionsResponse Source #
Response for the `ListTopicSubscriptions` method.
See: listTopicSubscriptionsResponse
smart constructor.
Instances
listTopicSubscriptionsResponse :: ListTopicSubscriptionsResponse Source #
Creates a value of ListTopicSubscriptionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lNextPageToken :: Lens' ListTopicSubscriptionsResponse (Maybe Text) Source #
If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.
lSubscriptions :: Lens' ListTopicSubscriptionsResponse [Text] Source #
The names of the subscriptions that match the request.
ListTopicsResponse
data ListTopicsResponse Source #
Response for the `ListTopics` method.
See: listTopicsResponse
smart constructor.
Instances
listTopicsResponse :: ListTopicsResponse Source #
Creates a value of ListTopicsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltrNextPageToken :: Lens' ListTopicsResponse (Maybe Text) Source #
If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.
PullResponse
data PullResponse Source #
Response for the `Pull` method.
See: pullResponse
smart constructor.
Instances
pullResponse :: PullResponse Source #
Creates a value of PullResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prReceivedMessages :: Lens' PullResponse [ReceivedMessage] Source #
Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.
ListSnapshotsResponse
data ListSnapshotsResponse Source #
Response for the `ListSnapshots` method. 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: listSnapshotsResponse
smart constructor.
Instances
listSnapshotsResponse :: ListSnapshotsResponse Source #
Creates a value of ListSnapshotsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsrNextPageToken :: Lens' ListSnapshotsResponse (Maybe Text) Source #
If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new `ListSnapshotsRequest`.
lsrSnapshots :: Lens' ListSnapshotsResponse [Snapshot] Source #
The resulting snapshots.
SetIAMPolicyRequest
data SetIAMPolicyRequest Source #
Request message for `SetIamPolicy` method.
See: setIAMPolicyRequest
smart constructor.
Instances
setIAMPolicyRequest :: SetIAMPolicyRequest Source #
Creates a value of SetIAMPolicyRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy) Source #
REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
CreateSnapshotRequest
data CreateSnapshotRequest Source #
Request for the `CreateSnapshot` method. 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: createSnapshotRequest
smart constructor.
Instances
createSnapshotRequest :: CreateSnapshotRequest Source #
Creates a value of CreateSnapshotRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csrSubscription :: Lens' CreateSnapshotRequest (Maybe Text) Source #
The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.
SeekRequest
data SeekRequest Source #
Request for the `Seek` method. 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: seekRequest
smart constructor.
Instances
seekRequest :: SeekRequest Source #
Creates a value of SeekRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srSnapshot :: Lens' SeekRequest (Maybe Text) Source #
The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is `projects/{project}/snapshots/{snap}`.
srTime :: Lens' SeekRequest (Maybe UTCTime) Source #
The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of `message_retention_duration` and `retain_acked_messages`). For example, if `time` corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored.
Topic
A topic resource.
See: topic
smart constructor.
Instances
Eq Topic Source # | |
Data Topic Source # | |
Defined in Network.Google.PubSub.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Topic -> c Topic # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Topic # dataTypeOf :: Topic -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Topic) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Topic) # gmapT :: (forall b. Data b => b -> b) -> Topic -> Topic # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Topic -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Topic -> r # gmapQ :: (forall d. Data d => d -> u) -> Topic -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Topic -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Topic -> m Topic # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Topic -> m Topic # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Topic -> m Topic # | |
Show Topic Source # | |
Generic Topic Source # | |
ToJSON Topic Source # | |
Defined in Network.Google.PubSub.Types.Product | |
FromJSON Topic Source # | |
type Rep Topic Source # | |
Defined in Network.Google.PubSub.Types.Product type Rep Topic = D1 (MetaData "Topic" "Network.Google.PubSub.Types.Product" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "Topic'" PrefixI True) (S1 (MetaSel (Just "_tName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tLabels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TopicLabels)))) |
tName :: Lens' Topic (Maybe Text) Source #
The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
TopicLabels
data TopicLabels Source #
See Creating and managing labels.
See: topicLabels
smart constructor.
Instances
Creates a value of TopicLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CreateSnapshotRequestLabels
data CreateSnapshotRequestLabels Source #
See Creating and managing labels.
See: createSnapshotRequestLabels
smart constructor.
Instances
createSnapshotRequestLabels Source #
Creates a value of CreateSnapshotRequestLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
UpdateSnapshotRequest
data UpdateSnapshotRequest Source #
Request for the UpdateSnapshot method. 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: updateSnapshotRequest
smart constructor.
Instances
updateSnapshotRequest :: UpdateSnapshotRequest Source #
Creates a value of UpdateSnapshotRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
usrSnapshot :: Lens' UpdateSnapshotRequest (Maybe Snapshot) Source #
The updated snapshot object.
usrUpdateMask :: Lens' UpdateSnapshotRequest (Maybe GFieldMask) Source #
Indicates which fields in the provided snapshot to update. Must be specified and non-empty.
PullRequest
data PullRequest Source #
Request for the `Pull` method.
See: pullRequest
smart constructor.
Instances
pullRequest :: PullRequest Source #
Creates a value of PullRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prMaxMessages :: Lens' PullRequest (Maybe Int32) Source #
The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
prReturnImmediately :: Lens' PullRequest (Maybe Bool) Source #
If this field set to true, the system will respond immediately even if it there are no messages available to return in the `Pull` response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages.
PubsubMessageAttributes
data PubsubMessageAttributes Source #
Optional attributes for this message.
See: pubsubMessageAttributes
smart constructor.
Instances
pubsubMessageAttributes Source #
Creates a value of PubsubMessageAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Xgafv
V1 error format.
Instances
TestIAMPermissionsRequest
data TestIAMPermissionsRequest Source #
Request message for `TestIamPermissions` method.
See: testIAMPermissionsRequest
smart constructor.
Instances
testIAMPermissionsRequest :: TestIAMPermissionsRequest Source #
Creates a value of TestIAMPermissionsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiprPermissions :: Lens' TestIAMPermissionsRequest [Text] Source #
The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
PublishResponse
data PublishResponse Source #
Response for the `Publish` method.
See: publishResponse
smart constructor.
Instances
publishResponse :: PublishResponse Source #
Creates a value of PublishResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prMessageIds :: Lens' PublishResponse [Text] Source #
The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
PublishRequest
data PublishRequest Source #
Request for the Publish method.
See: publishRequest
smart constructor.
Instances
publishRequest :: PublishRequest Source #
Creates a value of PublishRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prMessages :: Lens' PublishRequest [PubsubMessage] Source #
The messages to publish.
TestIAMPermissionsResponse
data TestIAMPermissionsResponse Source #
Response message for `TestIamPermissions` method.
See: testIAMPermissionsResponse
smart constructor.
Instances
testIAMPermissionsResponse :: TestIAMPermissionsResponse Source #
Creates a value of TestIAMPermissionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text] Source #
A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
Policy
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike'example.com", "group:admins'example.com", "domain:google.com", "serviceAccount:my-other-app'appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean'example.com"] } ] } **YAML Example** bindings: - members: - user:mike'example.com - group:admins'example.com - domain:google.com - serviceAccount:my-other-app'appspot.gserviceaccount.com role: roles/owner - members: - user:sean'example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide.
See: policy
smart constructor.
Instances
Eq Policy Source # | |
Data Policy Source # | |
Defined in Network.Google.PubSub.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Policy -> c Policy # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Policy # toConstr :: Policy -> Constr # dataTypeOf :: Policy -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Policy) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Policy) # gmapT :: (forall b. Data b => b -> b) -> Policy -> Policy # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Policy -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Policy -> r # gmapQ :: (forall d. Data d => d -> u) -> Policy -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Policy -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Policy -> m Policy # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Policy -> m Policy # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Policy -> m Policy # | |
Show Policy Source # | |
Generic Policy Source # | |
ToJSON Policy Source # | |
Defined in Network.Google.PubSub.Types.Product | |
FromJSON Policy Source # | |
type Rep Policy Source # | |
Defined in Network.Google.PubSub.Types.Product type Rep Policy = D1 (MetaData "Policy" "Network.Google.PubSub.Types.Product" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "Policy'" PrefixI True) (S1 (MetaSel (Just "_pEtag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bytes)) :*: (S1 (MetaSel (Just "_pVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_pBindings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Binding]))))) |
pEtag :: Lens' Policy (Maybe ByteString) Source #
`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
pBindings :: Lens' Policy [Binding] Source #
Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
SeekResponse
data SeekResponse Source #
Response for the `Seek` method (this response is empty).
See: seekResponse
smart constructor.
Instances
seekResponse :: SeekResponse Source #
Creates a value of SeekResponse
with the minimum fields required to make a request.
ExpirationPolicy
data ExpirationPolicy Source #
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
See: expirationPolicy
smart constructor.
Instances
expirationPolicy :: ExpirationPolicy Source #
Creates a value of ExpirationPolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epTtl :: Lens' ExpirationPolicy (Maybe Scientific) Source #
Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of `ttl`. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for `ttl` depend on the type of the associated resource, as well. If `ttl` is not set, the associated resource never expires.
PushConfigAttributes
data PushConfigAttributes Source #
Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
See: pushConfigAttributes
smart constructor.
Instances
Creates a value of PushConfigAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Subscription
data Subscription Source #
A subscription resource.
See: subscription
smart constructor.
Instances
subscription :: Subscription Source #
Creates a value of Subscription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
subPushConfig :: Lens' Subscription (Maybe PushConfig) Source #
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
subMessageRetentionDuration :: Lens' Subscription (Maybe Scientific) Source #
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. 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.
subTopic :: Lens' Subscription (Maybe Text) Source #
The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.
subName :: Lens' Subscription (Maybe Text) Source #
The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
subRetainAckedMessages :: Lens' Subscription (Maybe Bool) Source #
Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to Seek to a timestamp. 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.
subAckDeadlineSeconds :: Lens' Subscription (Maybe Int32) Source #
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.
subExpirationPolicy :: Lens' Subscription (Maybe ExpirationPolicy) Source #
A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. 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.
UpdateSubscriptionRequest
data UpdateSubscriptionRequest Source #
Request for the UpdateSubscription method.
See: updateSubscriptionRequest
smart constructor.
Instances
updateSubscriptionRequest :: UpdateSubscriptionRequest Source #
Creates a value of UpdateSubscriptionRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uUpdateMask :: Lens' UpdateSubscriptionRequest (Maybe GFieldMask) Source #
Indicates which fields in the provided subscription to update. Must be specified and non-empty.
uSubscription :: Lens' UpdateSubscriptionRequest (Maybe Subscription) Source #
The updated subscription object.
SubscriptionLabels
data SubscriptionLabels Source #
See Creating and managing labels.
See: subscriptionLabels
smart constructor.
Instances
Creates a value of SubscriptionLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SnapshotLabels
data SnapshotLabels Source #
See Creating and managing labels.
See: snapshotLabels
smart constructor.
Instances
Creates a value of SnapshotLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListSubscriptionsResponse
data ListSubscriptionsResponse Source #
Response for the `ListSubscriptions` method.
See: listSubscriptionsResponse
smart constructor.
Instances
listSubscriptionsResponse :: ListSubscriptionsResponse Source #
Creates a value of ListSubscriptionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lisNextPageToken :: Lens' ListSubscriptionsResponse (Maybe Text) Source #
If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.
lisSubscriptions :: Lens' ListSubscriptionsResponse [Subscription] Source #
The subscriptions that match the request.
Binding
Associates `members` with a `role`.
See: binding
smart constructor.
Instances
Eq Binding Source # | |
Data Binding Source # | |
Defined in Network.Google.PubSub.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Binding -> c Binding # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Binding # toConstr :: Binding -> Constr # dataTypeOf :: Binding -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Binding) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Binding) # gmapT :: (forall b. Data b => b -> b) -> Binding -> Binding # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Binding -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Binding -> r # gmapQ :: (forall d. Data d => d -> u) -> Binding -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Binding -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Binding -> m Binding # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Binding -> m Binding # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Binding -> m Binding # | |
Show Binding Source # | |
Generic Binding Source # | |
ToJSON Binding Source # | |
Defined in Network.Google.PubSub.Types.Product | |
FromJSON Binding Source # | |
type Rep Binding Source # | |
Defined in Network.Google.PubSub.Types.Product type Rep Binding = D1 (MetaData "Binding" "Network.Google.PubSub.Types.Product" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "Binding'" PrefixI True) (S1 (MetaSel (Just "_bMembers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_bRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bCondition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Expr))))) |
Creates a value of Binding
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bMembers :: Lens' Binding [Text] Source #
Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice'gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app'appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins'example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
bRole :: Lens' Binding (Maybe Text) Source #
Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
bCondition :: Lens' Binding (Maybe Expr) Source #
Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
UpdateTopicRequest
data UpdateTopicRequest Source #
Request for the UpdateTopic method.
See: updateTopicRequest
smart constructor.
Instances
updateTopicRequest :: UpdateTopicRequest Source #
Creates a value of UpdateTopicRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
utrUpdateMask :: Lens' UpdateTopicRequest (Maybe GFieldMask) Source #
Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" then the new value will be determined based on the policy configured at the project or organization level. The `message_storage_policy` must not be set in the `topic` provided above.
AcknowledgeRequest
data AcknowledgeRequest Source #
Request for the Acknowledge method.
See: acknowledgeRequest
smart constructor.
Instances
acknowledgeRequest :: AcknowledgeRequest Source #
Creates a value of AcknowledgeRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired: