on develop help sign in
Regenerating gogol-pubsub from latest service definition
21c23b1Brendan Hay
gogol-pubsub/gen/Network/Google/PubSub/Types/Product.hs+21−12
@@ -662,7 +662,8 @@ testIAMPermissionsRequest =
662 }
662 }
663
663
664-- | The set of permissions to check for the \`resource\`. Permissions with
664-- | The set of permissions to check for the \`resource\`. Permissions with
665−-- wildcards (such as \'*\' or \'storage.*\') are not allowed.
665+-- wildcards (such as \'*\' or \'storage.*\') are not allowed. For more
666+-- information see IAM Overview.
666tiprPermissions :: Lens' TestIAMPermissionsRequest [Text]
667tiprPermissions :: Lens' TestIAMPermissionsRequest [Text]
667tiprPermissions
668tiprPermissions
668 = lens _tiprPermissions
669 = lens _tiprPermissions
@@ -808,7 +809,7 @@ instance ToJSON TestIAMPermissionsResponse where
808-- \"bindings\": [ { \"role\": \"roles\/owner\", \"members\": [
809-- \"bindings\": [ { \"role\": \"roles\/owner\", \"members\": [
809-- \"user:mike\'example.com\", \"group:admins\'example.com\",
810-- \"user:mike\'example.com\", \"group:admins\'example.com\",
810-- \"domain:google.com\",
811-- \"domain:google.com\",
811−-- \"serviceAccount:my-other-app\'appspot.gserviceaccount.com\"] }, {
812+-- \"serviceAccount:my-other-app\'appspot.gserviceaccount.com\", ] }, {
812-- \"role\": \"roles\/viewer\", \"members\": [\"user:sean\'example.com\"] }
813-- \"role\": \"roles\/viewer\", \"members\": [\"user:sean\'example.com\"] }
813-- ] } For a description of IAM and its features, see the [IAM developer\'s
814-- ] } For a description of IAM and its features, see the [IAM developer\'s
814-- guide](https:\/\/cloud.google.com\/iam).
815-- guide](https:\/\/cloud.google.com\/iam).
@@ -838,7 +839,15 @@ policy =
838 , _pBindings = Nothing
839 , _pBindings = Nothing
839 }
840 }
840
841
841−-- | Can be used to perform a read-modify-write.
842+-- | \`etag\` is used for optimistic concurrency control as a way to help
843+-- prevent simultaneous updates of a policy from overwriting each other. It
844+-- is strongly suggested that systems make use of the \`etag\` in the
845+-- read-modify-write cycle to perform policy updates in order to avoid race
846+-- conditions: An \`etag\` is returned in the response to \`getIamPolicy\`,
847+-- and systems are expected to put that etag in the request to
848+-- \`setIamPolicy\` to ensure that their change will be applied to the same
849+-- version of the policy. If no \`etag\` is provided in the call to
850+-- \`setIamPolicy\`, then the existing policy is overwritten blindly.
842pEtag :: Lens' Policy (Maybe Word8)
851pEtag :: Lens' Policy (Maybe Word8)
843pEtag
852pEtag
844 = lens _pEtag (\ s a -> s{_pEtag = a}) .
853 = lens _pEtag (\ s a -> s{_pEtag = a}) .
@@ -981,14 +990,14 @@ sName = lens _sName (\ s a -> s{_sName = a})
981-- before the subscriber should acknowledge the message. After message
990-- before the subscriber should acknowledge the message. After message
982-- delivery but before the ack deadline expires and before the message is
991-- delivery but before the ack deadline expires and before the message is
983-- acknowledged, it is an outstanding message and will not be delivered
992-- acknowledged, it is an outstanding message and will not be delivered
984−-- again during that time (on a best-effort basis). For pull delivery this
993+-- again during that time (on a best-effort basis). For pull subscriptions,
985−-- value is used as the initial value for the ack deadline. To override
994+-- this value is used as the initial value for the ack deadline. To
986−-- this value for a given message, call \`ModifyAckDeadline\` with the
995+-- override this value for a given message, call \`ModifyAckDeadline\` with
987−-- corresponding \`ack_id\`. For push delivery, this value is also used to
996+-- the corresponding \`ack_id\` if using pull. For push delivery, this
988−-- set the request timeout for the call to the push endpoint. If the
997+-- value is also used to set the request timeout for the call to the push
989−-- subscriber never acknowledges the message, the Pub\/Sub system will
998+-- endpoint. If the subscriber never acknowledges the message, the Pub\/Sub
990−-- eventually redeliver the message. If this parameter is not set, the
999+-- system will eventually redeliver the message. If this parameter is not
991−-- default value of 10 seconds is used.
1000+-- set, the default value of 10 seconds is used.
992sAckDeadlineSeconds :: Lens' Subscription (Maybe Int32)
1001sAckDeadlineSeconds :: Lens' Subscription (Maybe Int32)
993sAckDeadlineSeconds
1002sAckDeadlineSeconds
994 = lens _sAckDeadlineSeconds
1003 = lens _sAckDeadlineSeconds
@@ -1090,7 +1099,7 @@ binding =
1090 }
1099 }
1091
1100
1092-- | Specifies the identities requesting access for a Cloud Platform
1101-- | Specifies the identities requesting access for a Cloud Platform
1093−-- resource. \`members\` can have the following formats: * \`allUsers\`: A
1102+-- resource. \`members\` can have the following values: * \`allUsers\`: A
1094-- special identifier that represents anyone who is on the internet; with
1103-- special identifier that represents anyone who is on the internet; with
1095-- or without a Google account. * \`allAuthenticatedUsers\`: A special
1104-- or without a Google account. * \`allAuthenticatedUsers\`: A special
1096-- identifier that represents anyone who is authenticated with a Google
1105-- identifier that represents anyone who is authenticated with a Google
gogol-pubsub/gen/Network/Google/Resource/PubSub/Projects/Subscriptions/Create.hs+10−10
@@ -20,11 +20,11 @@
20-- Stability : auto-generated
20-- Stability : auto-generated
21-- Portability : non-portable (GHC extensions)
21-- Portability : non-portable (GHC extensions)
22--
22--
23−-- Creates a subscription to a given topic for a given subscriber. If the
23+-- Creates a subscription to a given topic. If the subscription already
24−-- subscription already exists, returns \`ALREADY_EXISTS\`. If the
24+-- exists, returns \`ALREADY_EXISTS\`. If the corresponding topic doesn\'t
25−-- corresponding topic doesn\'t exist, returns \`NOT_FOUND\`. If the name
25+-- exist, returns \`NOT_FOUND\`. If the name is not provided in the
26−-- is not provided in the request, the server will assign a random name for
26+-- request, the server will assign a random name for this subscription on
27−-- this subscription on the same project as the topic.
27+-- the same project as the topic.
28--
28--
29-- /See:/ <https://cloud.google.com/pubsub/docs Google Cloud Pub/Sub API Reference> for @pubsub.projects.subscriptions.create@.
29-- /See:/ <https://cloud.google.com/pubsub/docs Google Cloud Pub/Sub API Reference> for @pubsub.projects.subscriptions.create@.
30module Network.Google.Resource.PubSub.Projects.Subscriptions.Create
30module Network.Google.Resource.PubSub.Projects.Subscriptions.Create
@@ -67,11 +67,11 @@ type ProjectsSubscriptionsCreateResource =
67 ReqBody '[JSON] Subscription :>
67 ReqBody '[JSON] Subscription :>
68 Put '[JSON] Subscription
68 Put '[JSON] Subscription
69
69
70−-- | Creates a subscription to a given topic for a given subscriber. If the
70+-- | Creates a subscription to a given topic. If the subscription already
71−-- subscription already exists, returns \`ALREADY_EXISTS\`. If the
71+-- exists, returns \`ALREADY_EXISTS\`. If the corresponding topic doesn\'t
72−-- corresponding topic doesn\'t exist, returns \`NOT_FOUND\`. If the name
72+-- exist, returns \`NOT_FOUND\`. If the name is not provided in the
73−-- is not provided in the request, the server will assign a random name for
73+-- request, the server will assign a random name for this subscription on
74−-- this subscription on the same project as the topic.
74+-- the same project as the topic.
75--
75--
76-- /See:/ 'projectsSubscriptionsCreate' smart constructor.
76-- /See:/ 'projectsSubscriptionsCreate' smart constructor.
77data ProjectsSubscriptionsCreate = ProjectsSubscriptionsCreate'
77data ProjectsSubscriptionsCreate = ProjectsSubscriptionsCreate'
gogol-pubsub/gen/Network/Google/Resource/PubSub/Projects/Subscriptions/GetIAMPolicy.hs+8−8
@@ -20,8 +20,8 @@
20-- Stability : auto-generated
20-- Stability : auto-generated
21-- Portability : non-portable (GHC extensions)
21-- Portability : non-portable (GHC extensions)
22--
22--
23−-- Gets the access control policy for a \`resource\`. Is empty if the
23+-- Gets the access control policy for a \`resource\`. Returns an empty
24−-- policy or the resource does not exist.
24+-- policy if the resource exists and does not have a policy set.
25--
25--
26-- /See:/ <https://cloud.google.com/pubsub/docs Google Cloud Pub/Sub API Reference> for @pubsub.projects.subscriptions.getIamPolicy@.
26-- /See:/ <https://cloud.google.com/pubsub/docs Google Cloud Pub/Sub API Reference> for @pubsub.projects.subscriptions.getIamPolicy@.
27module Network.Google.Resource.PubSub.Projects.Subscriptions.GetIAMPolicy
27module Network.Google.Resource.PubSub.Projects.Subscriptions.GetIAMPolicy
@@ -61,8 +61,8 @@ type ProjectsSubscriptionsGetIAMPolicyResource =
61 QueryParam "callback" Text :>
61 QueryParam "callback" Text :>
62 QueryParam "alt" AltJSON :> Get '[JSON] Policy
62 QueryParam "alt" AltJSON :> Get '[JSON] Policy
63
63
64−-- | Gets the access control policy for a \`resource\`. Is empty if the
64+-- | Gets the access control policy for a \`resource\`. Returns an empty
65−-- policy or the resource does not exist.
65+-- policy if the resource exists and does not have a policy set.
66--
66--
67-- /See:/ 'projectsSubscriptionsGetIAMPolicy' smart constructor.
67-- /See:/ 'projectsSubscriptionsGetIAMPolicy' smart constructor.
68data ProjectsSubscriptionsGetIAMPolicy = ProjectsSubscriptionsGetIAMPolicy'
68data ProjectsSubscriptionsGetIAMPolicy = ProjectsSubscriptionsGetIAMPolicy'
@@ -143,11 +143,11 @@ psgipBearerToken
143 = lens _psgipBearerToken
143 = lens _psgipBearerToken
144 (\ s a -> s{_psgipBearerToken = a})
144 (\ s a -> s{_psgipBearerToken = a})
145
145
146−-- | REQUIRED: The resource for which policy is being requested. \`resource\`
146+-- | REQUIRED: The resource for which the policy is being requested.
147−-- is usually specified as a path, such as,
147+-- \`resource\` is usually specified as a path, such as
148−-- \`projects\/{project}\/zones\/{zone}\/disks\/{disk}\`. The format for
148+-- \`projects\/*project*\/zones\/*zone*\/disks\/*disk*\`. The format for
149-- the path specified in this value is resource specific and is specified
149-- the path specified in this value is resource specific and is specified
150−-- in the documentation for the respective GetIamPolicy rpc.
150+-- in the \`getIamPolicy\` documentation.
151psgipResource :: Lens' ProjectsSubscriptionsGetIAMPolicy Text
151psgipResource :: Lens' ProjectsSubscriptionsGetIAMPolicy Text
152psgipResource
152psgipResource
153 = lens _psgipResource
153 = lens _psgipResource
gogol-pubsub/gen/Network/Google/Resource/PubSub/Projects/Subscriptions/SetIAMPolicy.hs+4−4
@@ -156,11 +156,11 @@ pssipBearerToken
156 = lens _pssipBearerToken
156 = lens _pssipBearerToken
157 (\ s a -> s{_pssipBearerToken = a})
157 (\ s a -> s{_pssipBearerToken = a})
158
158
159−-- | REQUIRED: The resource for which policy is being specified. \`resource\`
159+-- | REQUIRED: The resource for which the policy is being specified.
160−-- is usually specified as a path, such as,
160+-- \`resource\` is usually specified as a path, such as
161−-- \`projects\/{project}\/zones\/{zone}\/disks\/{disk}\`. The format for
161+-- \`projects\/*project*\/zones\/*zone*\/disks\/*disk*\`. The format for
162-- the path specified in this value is resource specific and is specified
162-- the path specified in this value is resource specific and is specified
163−-- in the documentation for the respective SetIamPolicy rpc.
163+-- in the \`setIamPolicy\` documentation.
164pssipResource :: Lens' ProjectsSubscriptionsSetIAMPolicy Text
164pssipResource :: Lens' ProjectsSubscriptionsSetIAMPolicy Text
165pssipResource
165pssipResource
166 = lens _pssipResource
166 = lens _pssipResource
gogol-pubsub/gen/Network/Google/Resource/PubSub/Projects/Subscriptions/TestIAMPermissions.hs+4−4
@@ -155,11 +155,11 @@ pstipBearerToken
155 = lens _pstipBearerToken
155 = lens _pstipBearerToken
156 (\ s a -> s{_pstipBearerToken = a})
156 (\ s a -> s{_pstipBearerToken = a})
157
157
158−-- | REQUIRED: The resource for which policy detail is being requested.
158+-- | REQUIRED: The resource for which the policy detail is being requested.
159−-- \`resource\` is usually specified as a path, such as,
159+-- \`resource\` is usually specified as a path, such as
160−-- \`projects\/{project}\/zones\/{zone}\/disks\/{disk}\`. The format for
160+-- \`projects\/*project*\/zones\/*zone*\/disks\/*disk*\`. The format for
161-- the path specified in this value is resource specific and is specified
161-- the path specified in this value is resource specific and is specified
162−-- in the documentation for the respective TestIamPermissions rpc.
162+-- in the \`testIamPermissions\` documentation.
163pstipResource :: Lens' ProjectsSubscriptionsTestIAMPermissions Text
163pstipResource :: Lens' ProjectsSubscriptionsTestIAMPermissions Text
164pstipResource
164pstipResource
165 = lens _pstipResource
165 = lens _pstipResource
gogol-pubsub/gen/Network/Google/Resource/PubSub/Projects/Topics/GetIAMPolicy.hs+8−8
@@ -20,8 +20,8 @@
20-- Stability : auto-generated
20-- Stability : auto-generated
21-- Portability : non-portable (GHC extensions)
21-- Portability : non-portable (GHC extensions)
22--
22--
23−-- Gets the access control policy for a \`resource\`. Is empty if the
23+-- Gets the access control policy for a \`resource\`. Returns an empty
24−-- policy or the resource does not exist.
24+-- policy if the resource exists and does not have a policy set.
25--
25--
26-- /See:/ <https://cloud.google.com/pubsub/docs Google Cloud Pub/Sub API Reference> for @pubsub.projects.topics.getIamPolicy@.
26-- /See:/ <https://cloud.google.com/pubsub/docs Google Cloud Pub/Sub API Reference> for @pubsub.projects.topics.getIamPolicy@.
27module Network.Google.Resource.PubSub.Projects.Topics.GetIAMPolicy
27module Network.Google.Resource.PubSub.Projects.Topics.GetIAMPolicy
@@ -61,8 +61,8 @@ type ProjectsTopicsGetIAMPolicyResource =
61 QueryParam "callback" Text :>
61 QueryParam "callback" Text :>
62 QueryParam "alt" AltJSON :> Get '[JSON] Policy
62 QueryParam "alt" AltJSON :> Get '[JSON] Policy
63
63
64−-- | Gets the access control policy for a \`resource\`. Is empty if the
64+-- | Gets the access control policy for a \`resource\`. Returns an empty
65−-- policy or the resource does not exist.
65+-- policy if the resource exists and does not have a policy set.
66--
66--
67-- /See:/ 'projectsTopicsGetIAMPolicy' smart constructor.
67-- /See:/ 'projectsTopicsGetIAMPolicy' smart constructor.
68data ProjectsTopicsGetIAMPolicy = ProjectsTopicsGetIAMPolicy'
68data ProjectsTopicsGetIAMPolicy = ProjectsTopicsGetIAMPolicy'
@@ -143,11 +143,11 @@ ptgipBearerToken
143 = lens _ptgipBearerToken
143 = lens _ptgipBearerToken
144 (\ s a -> s{_ptgipBearerToken = a})
144 (\ s a -> s{_ptgipBearerToken = a})
145
145
146−-- | REQUIRED: The resource for which policy is being requested. \`resource\`
146+-- | REQUIRED: The resource for which the policy is being requested.
147−-- is usually specified as a path, such as,
147+-- \`resource\` is usually specified as a path, such as
148−-- \`projects\/{project}\/zones\/{zone}\/disks\/{disk}\`. The format for
148+-- \`projects\/*project*\/zones\/*zone*\/disks\/*disk*\`. The format for
149-- the path specified in this value is resource specific and is specified
149-- the path specified in this value is resource specific and is specified
150−-- in the documentation for the respective GetIamPolicy rpc.
150+-- in the \`getIamPolicy\` documentation.
151ptgipResource :: Lens' ProjectsTopicsGetIAMPolicy Text
151ptgipResource :: Lens' ProjectsTopicsGetIAMPolicy Text
152ptgipResource
152ptgipResource
153 = lens _ptgipResource
153 = lens _ptgipResource
gogol-pubsub/gen/Network/Google/Resource/PubSub/Projects/Topics/SetIAMPolicy.hs+4−4
@@ -156,11 +156,11 @@ ptsipBearerToken
156 = lens _ptsipBearerToken
156 = lens _ptsipBearerToken
157 (\ s a -> s{_ptsipBearerToken = a})
157 (\ s a -> s{_ptsipBearerToken = a})
158
158
159−-- | REQUIRED: The resource for which policy is being specified. \`resource\`
159+-- | REQUIRED: The resource for which the policy is being specified.
160−-- is usually specified as a path, such as,
160+-- \`resource\` is usually specified as a path, such as
161−-- \`projects\/{project}\/zones\/{zone}\/disks\/{disk}\`. The format for
161+-- \`projects\/*project*\/zones\/*zone*\/disks\/*disk*\`. The format for
162-- the path specified in this value is resource specific and is specified
162-- the path specified in this value is resource specific and is specified
163−-- in the documentation for the respective SetIamPolicy rpc.
163+-- in the \`setIamPolicy\` documentation.
164ptsipResource :: Lens' ProjectsTopicsSetIAMPolicy Text
164ptsipResource :: Lens' ProjectsTopicsSetIAMPolicy Text
165ptsipResource
165ptsipResource
166 = lens _ptsipResource
166 = lens _ptsipResource
gogol-pubsub/gen/Network/Google/Resource/PubSub/Projects/Topics/TestIAMPermissions.hs+4−4
@@ -154,11 +154,11 @@ pttipBearerToken
154 = lens _pttipBearerToken
154 = lens _pttipBearerToken
155 (\ s a -> s{_pttipBearerToken = a})
155 (\ s a -> s{_pttipBearerToken = a})
156
156
157−-- | REQUIRED: The resource for which policy detail is being requested.
157+-- | REQUIRED: The resource for which the policy detail is being requested.
158−-- \`resource\` is usually specified as a path, such as,
158+-- \`resource\` is usually specified as a path, such as
159−-- \`projects\/{project}\/zones\/{zone}\/disks\/{disk}\`. The format for
159+-- \`projects\/*project*\/zones\/*zone*\/disks\/*disk*\`. The format for
160-- the path specified in this value is resource specific and is specified
160-- the path specified in this value is resource specific and is specified
161−-- in the documentation for the respective TestIamPermissions rpc.
161+-- in the \`testIamPermissions\` documentation.
162pttipResource :: Lens' ProjectsTopicsTestIAMPermissions Text
162pttipResource :: Lens' ProjectsTopicsTestIAMPermissions Text
163pttipResource
163pttipResource
164 = lens _pttipResource
164 = lens _pttipResource