Blame - docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.html - platform/external/python/google-api-python-client

<h1><a href="cloudchannel_v1.html">Cloud Channel API</a> . <a href="cloudchannel_v1.accounts.html">accounts</a> . <a href="cloudchannel_v1.accounts.channelPartnerLinks.html">channelPartnerLinks</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="cloudchannel_v1.accounts.channelPartnerLinks.customers.html">customers()</a></code>

79

</p>

80

<p class="firstline">Returns the customers Resource.</p>

81

82

83

<code><a href="#close">close()</a></code></p>

84

<p class="firstline">Close httplib2 connections.</p>

85

86

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

87

<p class="firstline">Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * 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 new ChannelPartnerLink resource.</p>

88

89

<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>

yoshi-code-bot

bfa2f1c

2021-05-08 07:21:27 -0700

[diff] [blame]

90

<p class="firstline">Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.</p>

Anthonios Partheniou

10f4b67

2021-04-13 14:47:53 -0400

[diff] [blame]

91

92

<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>

93

<p class="firstline">List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: The list of the distributor account's ChannelPartnerLink resources.</p>

94

95

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

96

<p class="firstline">Retrieves the next page of results.</p>

97

98

<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>

99

<p class="firstline">Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * 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 updated ChannelPartnerLink resource.</p>

100

<h3>Method Details</h3>

101

102

<code class="details" id="close">close()</code>

103

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

108

<pre>Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * 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 new ChannelPartnerLink resource.

109

110

Args:

111

parent: string, Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id} (required)

112

body: object, The request body.

113

The object takes the form of:

114

115

{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

116

"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).

117

"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.

118

"alternateEmail": "A String", # The alternate email.

119

"customerType": "A String", # CustomerType indicates verification type needed for using services.

120

"eduData": { # Required Edu Attributes # Edu information about the customer.

121

"instituteSize": "A String", # Size of the institute.

122

"instituteType": "A String", # Designated institute type of customer.

123

"website": "A String", # Web address for the edu customer's institution.

124

},

125

"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

126

"languageCode": "A String", # Language code.

127

"phoneNumber": "A String", # Phone number associated with the Cloud Identity.

128

"primaryDomain": "A String", # Output only. The primary domain name.

129

},

130

"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.

131

"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.

132

"linkState": "A String", # Required. State of the channel partner link.

133

"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.

134

"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.

135

"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.

136

"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.

137

}

138

139

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

146

147

{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

148

"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).

149

"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.

150

"alternateEmail": "A String", # The alternate email.

151

"customerType": "A String", # CustomerType indicates verification type needed for using services.

152

"eduData": { # Required Edu Attributes # Edu information about the customer.

153

"instituteSize": "A String", # Size of the institute.

154

"instituteType": "A String", # Designated institute type of customer.

155

"website": "A String", # Web address for the edu customer's institution.

156

},

157

"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

158

"languageCode": "A String", # Language code.

159

"phoneNumber": "A String", # Phone number associated with the Cloud Identity.

160

"primaryDomain": "A String", # Output only. The primary domain name.

161

},

162

"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.

163

"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.

164

"linkState": "A String", # Required. State of the channel partner link.

165

"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.

166

"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.

167

"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.

168

"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.

}</pre>

</div>

<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>

yoshi-code-bot

bfa2f1c

2021-05-08 07:21:27 -0700

[diff] [blame]

174

<pre>Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.

Anthonios Partheniou

10f4b67

2021-04-13 14:47:53 -0400

[diff] [blame]

175

176

Args:

177

name: string, Required. The resource name of the channel partner link to retrieve. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner. (required)

178

view: string, Optional. The level of granularity the ChannelPartnerLink will display.

179

Allowed values

180

UNSPECIFIED - The default / unset value. The API will default to the BASIC view.

181

BASIC - Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.

182

FULL - Includes all fields.

183

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

190

191

{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

192

"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).

193

"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.

194

"alternateEmail": "A String", # The alternate email.

195

"customerType": "A String", # CustomerType indicates verification type needed for using services.

196

"eduData": { # Required Edu Attributes # Edu information about the customer.

197

"instituteSize": "A String", # Size of the institute.

198

"instituteType": "A String", # Designated institute type of customer.

199

"website": "A String", # Web address for the edu customer's institution.

200

},

201

"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

202

"languageCode": "A String", # Language code.

203

"phoneNumber": "A String", # Phone number associated with the Cloud Identity.

204

"primaryDomain": "A String", # Output only. The primary domain name.

205

},

206

"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.

207

"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.

208

"linkState": "A String", # Required. State of the channel partner link.

209

"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.

210

"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.

211

"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.

212

"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.

}</pre>

</div>

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>

218

<pre>List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: The list of the distributor account's ChannelPartnerLink resources.

219

220

Args:

221

parent: string, Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id} (required)

222

pageSize: integer, Optional. Requested page size. Server might return fewer results than requested. If unspecified, server will pick a default size (25). The maximum value is 200; the server will coerce values above 200.

223

pageToken: string, Optional. A token for a page of results other than the first page. Obtained using ListChannelPartnerLinksResponse.next_page_token of the previous CloudChannelService.ListChannelPartnerLinks call.

224

view: string, Optional. The level of granularity the ChannelPartnerLink will display.

225

Allowed values

226

UNSPECIFIED - The default / unset value. The API will default to the BASIC view.

227

BASIC - Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.

228

FULL - Includes all fields.

229

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

236

237

{ # Response message for CloudChannelService.ListChannelPartnerLinks.

238

"channelPartnerLinks": [ # The Channel partner links for a reseller.

239

{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

240

"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).

241

"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.

242

"alternateEmail": "A String", # The alternate email.

243

"customerType": "A String", # CustomerType indicates verification type needed for using services.

244

"eduData": { # Required Edu Attributes # Edu information about the customer.

245

"instituteSize": "A String", # Size of the institute.

246

"instituteType": "A String", # Designated institute type of customer.

247

"website": "A String", # Web address for the edu customer's institution.

248

},

249

"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

250

"languageCode": "A String", # Language code.

251

"phoneNumber": "A String", # Phone number associated with the Cloud Identity.

252

"primaryDomain": "A String", # Output only. The primary domain name.

253

},

254

"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.

255

"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.

256

"linkState": "A String", # Required. State of the channel partner link.

257

"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.

258

"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.

259

"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.

260

"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.

261

},

262

],

263

"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.page_token to obtain that page.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

269

<pre>Retrieves the next page of results.

270

271

Args:

272

previous_request: The request for the previous page. (required)

273

previous_response: The response from the request for the previous page. (required)

274

275

Returns:

276

A request object that you can call 'execute()' on to request the next

277

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>

283

<pre>Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * 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 updated ChannelPartnerLink resource.

284

285

Args:

286

name: string, Required. The resource name of the channel partner link to cancel. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner. (required)

287

body: object, The request body.

288

The object takes the form of:

289

290

{ # Request message for CloudChannelService.UpdateChannelPartnerLink

291

"channelPartnerLink": { # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. # Required. The channel partner link to update. Only channel_partner_link.link_state is allowed for updates.

292

"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).

293

"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.

294

"alternateEmail": "A String", # The alternate email.

295

"customerType": "A String", # CustomerType indicates verification type needed for using services.

296

"eduData": { # Required Edu Attributes # Edu information about the customer.

297

"instituteSize": "A String", # Size of the institute.

298

"instituteType": "A String", # Designated institute type of customer.

299

"website": "A String", # Web address for the edu customer's institution.

300

},

301

"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

302

"languageCode": "A String", # Language code.

303

"phoneNumber": "A String", # Phone number associated with the Cloud Identity.

304

"primaryDomain": "A String", # Output only. The primary domain name.

305

},

306

"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.

307

"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.

308

"linkState": "A String", # Required. State of the channel partner link.

309

"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.

310

"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.

311

"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.

312

"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.

313

},

314

"updateMask": "A String", # Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state.

315

}

316

317

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

324

325

{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

326

"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).

327

"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.

328

"alternateEmail": "A String", # The alternate email.

329

"customerType": "A String", # CustomerType indicates verification type needed for using services.

330

"eduData": { # Required Edu Attributes # Edu information about the customer.

331

"instituteSize": "A String", # Size of the institute.

332

"instituteType": "A String", # Designated institute type of customer.

333

"website": "A String", # Web address for the edu customer's institution.

334

},

335

"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.

336

"languageCode": "A String", # Language code.

337

"phoneNumber": "A String", # Phone number associated with the Cloud Identity.

338

"primaryDomain": "A String", # Output only. The primary domain name.

339

},

340

"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.

341

"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.

342

"linkState": "A String", # Required. State of the channel partner link.

343

"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.

344

"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.

345

"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.

346

"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.

}</pre>

</div>

</body></html>