| 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 |
Network.Google.PubSub.Types
Contents
- Service Configuration
- OAuth Scopes
- PushConfig
- ReceivedMessage
- ModifyAckDeadlineRequest
- ModifyPushConfigRequest
- Empty
- PubsubMessage
- ListTopicSubscriptionsResponse
- ListTopicsResponse
- PullResponse
- SetIAMPolicyRequest
- Topic
- PullRequest
- PubsubMessageAttributes
- Xgafv
- TestIAMPermissionsRequest
- PublishResponse
- PublishRequest
- TestIAMPermissionsResponse
- Policy
- PushConfigAttributes
- Subscription
- ListSubscriptionsResponse
- Binding
- AcknowledgeRequest
Description
- pubSubService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- pubSubScope :: Proxy '["https://www.googleapis.com/auth/pubsub"]
- 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 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
- ltsrNextPageToken :: Lens' ListTopicSubscriptionsResponse (Maybe Text)
- ltsrSubscriptions :: 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 SetIAMPolicyRequest
- setIAMPolicyRequest :: SetIAMPolicyRequest
- siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy)
- data Topic
- topic :: Topic
- tName :: Lens' Topic (Maybe Text)
- 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 PushConfigAttributes
- pushConfigAttributes :: HashMap Text Text -> PushConfigAttributes
- pcaAddtional :: Lens' PushConfigAttributes (HashMap Text Text)
- data Subscription
- subscription :: Subscription
- sPushConfig :: Lens' Subscription (Maybe PushConfig)
- sTopic :: Lens' Subscription (Maybe Text)
- sName :: Lens' Subscription (Maybe Text)
- sAckDeadlineSeconds :: Lens' Subscription (Maybe Int32)
- data ListSubscriptionsResponse
- listSubscriptionsResponse :: ListSubscriptionsResponse
- lsrNextPageToken :: Lens' ListSubscriptionsResponse (Maybe Text)
- lsrSubscriptions :: Lens' ListSubscriptionsResponse [Subscription]
- data Binding
- binding :: Binding
- bMembers :: Lens' Binding [Text]
- bRole :: Lens' Binding (Maybe Text)
- data AcknowledgeRequest
- acknowledgeRequest :: AcknowledgeRequest
- arAckIds :: Lens' AcknowledgeRequest [Text]
Service Configuration
pubSubService :: ServiceConfig #
Default request referring to version v1 of the Google 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"] #
View and manage your data across Google Cloud Platform services
pubSubScope :: Proxy '["https://www.googleapis.com/auth/pubsub"] #
View and manage Pub/Sub topics and subscriptions
PushConfig
data PushConfig #
Configuration for a push delivery endpoint.
See: pushConfig smart constructor.
Instances
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) #
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 push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (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) #
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 #
A message and its corresponding acknowledgment ID.
See: receivedMessage smart constructor.
receivedMessage :: ReceivedMessage #
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) #
This ID can be used to acknowledge the received message.
rmMessage :: Lens' ReceivedMessage (Maybe PubsubMessage) #
The message.
ModifyAckDeadlineRequest
data ModifyAckDeadlineRequest #
Request for the ModifyAckDeadline method.
See: modifyAckDeadlineRequest smart constructor.
modifyAckDeadlineRequest :: ModifyAckDeadlineRequest #
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] #
List of acknowledgment IDs.
madrAckDeadlineSeconds :: Lens' ModifyAckDeadlineRequest (Maybe Int32) #
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 may immediately make the message available for another pull request. The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
ModifyPushConfigRequest
data ModifyPushConfigRequest #
Request for the ModifyPushConfig method.
See: modifyPushConfigRequest smart constructor.
modifyPushConfigRequest :: ModifyPushConfigRequest #
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) #
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` 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.
PubsubMessage
data PubsubMessage #
A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
See: pubsubMessage smart constructor.
Instances
pubsubMessage :: PubsubMessage #
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) #
The message payload.
pmPublishTime :: Lens' PubsubMessage (Maybe UTCTime) #
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) #
Optional attributes for this message.
pmMessageId :: Lens' PubsubMessage (Maybe Text) #
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 #
Response for the `ListTopicSubscriptions` method.
See: listTopicSubscriptionsResponse smart constructor.
listTopicSubscriptionsResponse :: ListTopicSubscriptionsResponse #
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:
ltsrNextPageToken :: Lens' ListTopicSubscriptionsResponse (Maybe Text) #
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.
ltsrSubscriptions :: Lens' ListTopicSubscriptionsResponse [Text] #
The names of the subscriptions that match the request.
ListTopicsResponse
data ListTopicsResponse #
Response for the `ListTopics` method.
See: listTopicsResponse smart constructor.
listTopicsResponse :: ListTopicsResponse #
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) #
If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.
ltrTopics :: Lens' ListTopicsResponse [Topic] #
The resulting topics.
PullResponse
pullResponse :: PullResponse #
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] #
Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.
SetIAMPolicyRequest
data SetIAMPolicyRequest #
Request message for `SetIamPolicy` method.
See: setIAMPolicyRequest smart constructor.
setIAMPolicyRequest :: SetIAMPolicyRequest #
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) #
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.
Topic
A topic resource.
See: topic smart constructor.
tName :: Lens' Topic (Maybe Text) #
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"`.
PullRequest
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) #
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) #
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. The client may cancel the request if it does not wish to wait any longer for the response.
PubsubMessageAttributes
data PubsubMessageAttributes #
Optional attributes for this message.
See: pubsubMessageAttributes smart constructor.
Arguments
| :: HashMap Text Text | |
| -> PubsubMessageAttributes |
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.
TestIAMPermissionsRequest
data TestIAMPermissionsRequest #
Request message for `TestIamPermissions` method.
See: testIAMPermissionsRequest smart constructor.
testIAMPermissionsRequest :: TestIAMPermissionsRequest #
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] #
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 #
Response for the `Publish` method.
See: publishResponse smart constructor.
publishResponse :: PublishResponse #
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] #
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
publishRequest :: PublishRequest #
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] #
The messages to publish.
TestIAMPermissionsResponse
data TestIAMPermissionsResponse #
Response message for `TestIamPermissions` method.
See: testIAMPermissionsResponse smart constructor.
testIAMPermissionsResponse :: TestIAMPermissionsResponse #
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] #
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. **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"] } ] } For a description of IAM and its features, see the IAM developer's guide.
See: policy smart constructor.
pEtag :: Lens' Policy (Maybe ByteString) #
`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] #
Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
PushConfigAttributes
data PushConfigAttributes #
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 push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (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.
Arguments
| :: HashMap Text Text | |
| -> PushConfigAttributes |
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
subscription :: Subscription #
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:
sPushConfig :: Lens' Subscription (Maybe PushConfig) #
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.
sTopic :: Lens' Subscription (Maybe Text) #
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.
sName :: Lens' Subscription (Maybe Text) #
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"`.
sAckDeadlineSeconds :: Lens' Subscription (Maybe Int32) #
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (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 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.
ListSubscriptionsResponse
data ListSubscriptionsResponse #
Response for the `ListSubscriptions` method.
See: listSubscriptionsResponse smart constructor.
listSubscriptionsResponse :: ListSubscriptionsResponse #
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:
lsrNextPageToken :: Lens' ListSubscriptionsResponse (Maybe Text) #
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.
lsrSubscriptions :: Lens' ListSubscriptionsResponse [Subscription] #
The subscriptions that match the request.
Binding
Associates `members` with a `role`.
See: binding smart constructor.
bMembers :: Lens' Binding [Text] #
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` or `joe'example.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) #
Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
AcknowledgeRequest
data AcknowledgeRequest #
Request for the Acknowledge method.
See: acknowledgeRequest smart constructor.
acknowledgeRequest :: AcknowledgeRequest #
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:
arAckIds :: Lens' AcknowledgeRequest [Text] #
The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty.