Debian Codegraph @

docs/dyn/cloudchannel_v1.integrators.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="cloudchannel_v1.html">Cloud Channel API</a> . <a href="cloudchannel_v1.integrators.html">integrators</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#listSubscribers">listSubscribers(integrator, account=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.</p>
83 <p class="toc_element">
84 <code><a href="#listSubscribers_next">listSubscribers_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <code><a href="#registerSubscriber">registerSubscriber(integrator, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.</p>
89 <p class="toc_element">
90 <code><a href="#unregisterSubscriber">unregisterSubscriber(integrator, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="listSubscribers">listSubscribers(integrator, account=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
100 <pre>Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn&#x27;t exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.
101
102 Args:
103 integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
104 account: string, Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
105 pageSize: integer, Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.
106 pageToken: string, Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112 Returns:
113 An object of the form:
114
115 { # Response Message for ListSubscribers.
116 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
117 &quot;serviceAccounts&quot;: [ # List of service accounts which have subscriber access to the topic.
118 &quot;A String&quot;,
119 ],
120 &quot;topic&quot;: &quot;A String&quot;, # Name of the topic registered with the reseller.
121 }</pre>
122 </div>
123
124 <div class="method">
125 <code class="details" id="listSubscribers_next">listSubscribers_next()</code>
126 <pre>Retrieves the next page of results.
127
128 Args:
129 previous_request: The request for the previous page. (required)
130 previous_response: The response from the request for the previous page. (required)
131
132 Returns:
133 A request object that you can call &#x27;execute()&#x27; on to request the next
134 page. Returns None if there are no more items in the collection.
135 </pre>
136 </div>
137
138 <div class="method">
139 <code class="details" id="registerSubscriber">registerSubscriber(integrator, body=None, x__xgafv=None)</code>
140 <pre>Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.
141
142 Args:
143 integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
144 body: object, The request body.
145 The object takes the form of:
146
147 { # Request Message for RegisterSubscriber.
148 &quot;account&quot;: &quot;A String&quot;, # Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
149 &quot;integrator&quot;: &quot;A String&quot;, # Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
150 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. Service account that provides subscriber access to the registered topic.
151 }
152
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158 Returns:
159 An object of the form:
160
161 { # Response Message for RegisterSubscriber.
162 &quot;topic&quot;: &quot;A String&quot;, # Name of the topic the subscriber will listen to.
163 }</pre>
164 </div>
165
166 <div class="method">
167 <code class="details" id="unregisterSubscriber">unregisterSubscriber(integrator, body=None, x__xgafv=None)</code>
168 <pre>Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn&#x27;t exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn&#x27;t registered with the topic.
169
170 Args:
171 integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
172 body: object, The request body.
173 The object takes the form of:
174
175 { # Request Message for UnregisterSubscriber.
176 &quot;account&quot;: &quot;A String&quot;, # Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
177 &quot;integrator&quot;: &quot;A String&quot;, # Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
178 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. Service account to unregister from subscriber access to the topic.
179 }
180
181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186 Returns:
187 An object of the form:
188
189 { # Response Message for UnregisterSubscriber.
190 &quot;topic&quot;: &quot;A String&quot;, # Name of the topic the service account subscriber access was removed from.
191 }</pre>
192 </div>
193
194 </body></html>