blob: b7a241c086a37b3535f62ca2cab6f2dd91c9bb8d [file] [log] [blame]
yoshi-code-bot807277b2021-04-22 04:38:02 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="cloudcommerceprocurement_v1.html">Cloud Commerce Partner Procurement API</a> . <a href="cloudcommerceprocurement_v1.providers.html">providers</a> . <a href="cloudcommerceprocurement_v1.providers.entitlements.html">entitlements</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.</p>
80<p class="toc_element">
81 <code><a href="#approvePlanChange">approvePlanChange(name, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.</p>
83<p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85<p class="firstline">Close httplib2 connections.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets a requested Entitlement resource.</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists Entitlements for which the provider has read access.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates an existing Entitlement.</p>
98<p class="toc_element">
99 <code><a href="#reject">reject(name, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.</p>
101<p class="toc_element">
102 <code><a href="#rejectPlanChange">rejectPlanChange(name, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.</p>
104<p class="toc_element">
105 <code><a href="#suspend">suspend(name, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Requests suspension of an active Entitlement. This is not yet supported.</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code>
110 <pre>Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.
111
112Args:
113 name: string, The resource name of the entitlement. Required. (required)
114 body: object, The request body.
115 The object takes the form of:
116
117{ # Request message for [PartnerProcurementService.ApproveEntitlement[].
118 &quot;properties&quot;: { # Set of properties that should be associated with the entitlement. Optional.
119 &quot;a_key&quot;: &quot;A String&quot;,
120 },
121}
122
123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
127
128Returns:
129 An object of the form:
130
131 { # 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 `{}`.
132}</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="approvePlanChange">approvePlanChange(name, body=None, x__xgafv=None)</code>
137 <pre>Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.
138
139Args:
140 name: string, The resource name of the entitlement. Required. (required)
141 body: object, The request body.
142 The object takes the form of:
143
144{ # Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[].
145 &quot;pendingPlanName&quot;: &quot;A String&quot;, # Name of the pending plan that is being approved. Required.
146}
147
148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153Returns:
154 An object of the form:
155
156 { # 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 `{}`.
157}</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="close">close()</code>
162 <pre>Close httplib2 connections.</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="get">get(name, x__xgafv=None)</code>
167 <pre>Gets a requested Entitlement resource.
168
169Args:
170 name: string, The name of the entitlement to retrieve. (required)
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176Returns:
177 An object of the form:
178
179 { # Represents a procured product of a customer. Next Id: 23
180 &quot;account&quot;: &quot;A String&quot;, # Output only. The resource name of the account that this entitlement is based on, if any.
181 &quot;consumers&quot;: [ # Output only. The resources using this entitlement, if applicable.
182 { # A resource using (consuming) this entitlement.
183 &quot;project&quot;: &quot;A String&quot;, # A project name with format `projects/`.
184 },
185 ],
186 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp.
187 &quot;inputProperties&quot;: { # Output only. The custom properties that were collected from the user to create this entitlement.
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
189 },
190 &quot;messageToUser&quot;: &quot;A String&quot;, # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
191 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
192 &quot;newPendingOffer&quot;: &quot;A String&quot;, # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: &#x27;projects/{project}/services/{service}/privateOffers/{offer-id}&#x27; OR &#x27;projects/{project}/services/{service}/standardOffers/{offer-id}&#x27;, depending on whether the offer is private or public.
193 &quot;newPendingPlan&quot;: &quot;A String&quot;, # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
194 &quot;offer&quot;: &quot;A String&quot;, # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: &#x27;projects/{project}/services/{service}/privateOffers/{offer-id}&#x27; OR &#x27;projects/{project}/services/{service}/standardOffers/{offer-id}&#x27;, depending on whether the offer is private or public.
195 &quot;offerEndTime&quot;: &quot;A String&quot;, # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
196 &quot;plan&quot;: &quot;A String&quot;, # Output only. The identifier of the plan that was procured. Required if the product has plans.
197 &quot;product&quot;: &quot;A String&quot;, # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
198 &quot;productExternalName&quot;: &quot;A String&quot;, # Output only. The identifier of the product that was procured.
199 &quot;provider&quot;: &quot;A String&quot;, # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
200 &quot;quoteExternalName&quot;: &quot;A String&quot;, # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
201 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the entitlement.
202 &quot;subscriptionEndTime&quot;: &quot;A String&quot;, # Output only. End time for the subscription corresponding to this entitlement.
203 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp.
204 &quot;usageReportingId&quot;: &quot;A String&quot;, # Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
205}</pre>
206</div>
207
208<div class="method">
209 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
210 <pre>Lists Entitlements for which the provider has read access.
211
212Args:
213 parent: string, The parent resource name. (required)
214 filter: string, The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `consumers.project` Note that the consumers match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. Also note that the state name match is case-insensitive and query can omit the prefix &quot;ENTITLEMENT_&quot;. For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product=&quot;providerId:productId&quot;`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.
215 pageSize: integer, The maximum number of entries that are requested.
216 pageToken: string, The token for fetching the next page.
217 x__xgafv: string, V1 error format.
218 Allowed values
219 1 - v1 error format
220 2 - v2 error format
221
222Returns:
223 An object of the form:
224
225 { # Response message for PartnerProcurementService.ListEntitlements.
226 &quot;entitlements&quot;: [ # The list of entitlements in this response.
227 { # Represents a procured product of a customer. Next Id: 23
228 &quot;account&quot;: &quot;A String&quot;, # Output only. The resource name of the account that this entitlement is based on, if any.
229 &quot;consumers&quot;: [ # Output only. The resources using this entitlement, if applicable.
230 { # A resource using (consuming) this entitlement.
231 &quot;project&quot;: &quot;A String&quot;, # A project name with format `projects/`.
232 },
233 ],
234 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp.
235 &quot;inputProperties&quot;: { # Output only. The custom properties that were collected from the user to create this entitlement.
236 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
237 },
238 &quot;messageToUser&quot;: &quot;A String&quot;, # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
239 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
240 &quot;newPendingOffer&quot;: &quot;A String&quot;, # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: &#x27;projects/{project}/services/{service}/privateOffers/{offer-id}&#x27; OR &#x27;projects/{project}/services/{service}/standardOffers/{offer-id}&#x27;, depending on whether the offer is private or public.
241 &quot;newPendingPlan&quot;: &quot;A String&quot;, # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
242 &quot;offer&quot;: &quot;A String&quot;, # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: &#x27;projects/{project}/services/{service}/privateOffers/{offer-id}&#x27; OR &#x27;projects/{project}/services/{service}/standardOffers/{offer-id}&#x27;, depending on whether the offer is private or public.
243 &quot;offerEndTime&quot;: &quot;A String&quot;, # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
244 &quot;plan&quot;: &quot;A String&quot;, # Output only. The identifier of the plan that was procured. Required if the product has plans.
245 &quot;product&quot;: &quot;A String&quot;, # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
246 &quot;productExternalName&quot;: &quot;A String&quot;, # Output only. The identifier of the product that was procured.
247 &quot;provider&quot;: &quot;A String&quot;, # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
248 &quot;quoteExternalName&quot;: &quot;A String&quot;, # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
249 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the entitlement.
250 &quot;subscriptionEndTime&quot;: &quot;A String&quot;, # Output only. End time for the subscription corresponding to this entitlement.
251 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp.
252 &quot;usageReportingId&quot;: &quot;A String&quot;, # Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
253 },
254 ],
255 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for fetching the next page.
256}</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
261 <pre>Retrieves the next page of results.
262
263Args:
264 previous_request: The request for the previous page. (required)
265 previous_response: The response from the request for the previous page. (required)
266
267Returns:
268 A request object that you can call &#x27;execute()&#x27; on to request the next
269 page. Returns None if there are no more items in the collection.
270 </pre>
271</div>
272
273<div class="method">
274 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
275 <pre>Updates an existing Entitlement.
276
277Args:
278 name: string, The name of the entitlement to update. (required)
279 body: object, The request body.
280 The object takes the form of:
281
282{ # Represents a procured product of a customer. Next Id: 23
283 &quot;account&quot;: &quot;A String&quot;, # Output only. The resource name of the account that this entitlement is based on, if any.
284 &quot;consumers&quot;: [ # Output only. The resources using this entitlement, if applicable.
285 { # A resource using (consuming) this entitlement.
286 &quot;project&quot;: &quot;A String&quot;, # A project name with format `projects/`.
287 },
288 ],
289 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp.
290 &quot;inputProperties&quot;: { # Output only. The custom properties that were collected from the user to create this entitlement.
291 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
292 },
293 &quot;messageToUser&quot;: &quot;A String&quot;, # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
294 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
295 &quot;newPendingOffer&quot;: &quot;A String&quot;, # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: &#x27;projects/{project}/services/{service}/privateOffers/{offer-id}&#x27; OR &#x27;projects/{project}/services/{service}/standardOffers/{offer-id}&#x27;, depending on whether the offer is private or public.
296 &quot;newPendingPlan&quot;: &quot;A String&quot;, # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
297 &quot;offer&quot;: &quot;A String&quot;, # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: &#x27;projects/{project}/services/{service}/privateOffers/{offer-id}&#x27; OR &#x27;projects/{project}/services/{service}/standardOffers/{offer-id}&#x27;, depending on whether the offer is private or public.
298 &quot;offerEndTime&quot;: &quot;A String&quot;, # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
299 &quot;plan&quot;: &quot;A String&quot;, # Output only. The identifier of the plan that was procured. Required if the product has plans.
300 &quot;product&quot;: &quot;A String&quot;, # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
301 &quot;productExternalName&quot;: &quot;A String&quot;, # Output only. The identifier of the product that was procured.
302 &quot;provider&quot;: &quot;A String&quot;, # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
303 &quot;quoteExternalName&quot;: &quot;A String&quot;, # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
304 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the entitlement.
305 &quot;subscriptionEndTime&quot;: &quot;A String&quot;, # Output only. End time for the subscription corresponding to this entitlement.
306 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp.
307 &quot;usageReportingId&quot;: &quot;A String&quot;, # Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
308}
309
310 updateMask: string, The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details.
311 x__xgafv: string, V1 error format.
312 Allowed values
313 1 - v1 error format
314 2 - v2 error format
315
316Returns:
317 An object of the form:
318
319 { # Represents a procured product of a customer. Next Id: 23
320 &quot;account&quot;: &quot;A String&quot;, # Output only. The resource name of the account that this entitlement is based on, if any.
321 &quot;consumers&quot;: [ # Output only. The resources using this entitlement, if applicable.
322 { # A resource using (consuming) this entitlement.
323 &quot;project&quot;: &quot;A String&quot;, # A project name with format `projects/`.
324 },
325 ],
326 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp.
327 &quot;inputProperties&quot;: { # Output only. The custom properties that were collected from the user to create this entitlement.
328 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
329 },
330 &quot;messageToUser&quot;: &quot;A String&quot;, # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
331 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
332 &quot;newPendingOffer&quot;: &quot;A String&quot;, # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: &#x27;projects/{project}/services/{service}/privateOffers/{offer-id}&#x27; OR &#x27;projects/{project}/services/{service}/standardOffers/{offer-id}&#x27;, depending on whether the offer is private or public.
333 &quot;newPendingPlan&quot;: &quot;A String&quot;, # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
334 &quot;offer&quot;: &quot;A String&quot;, # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: &#x27;projects/{project}/services/{service}/privateOffers/{offer-id}&#x27; OR &#x27;projects/{project}/services/{service}/standardOffers/{offer-id}&#x27;, depending on whether the offer is private or public.
335 &quot;offerEndTime&quot;: &quot;A String&quot;, # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
336 &quot;plan&quot;: &quot;A String&quot;, # Output only. The identifier of the plan that was procured. Required if the product has plans.
337 &quot;product&quot;: &quot;A String&quot;, # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
338 &quot;productExternalName&quot;: &quot;A String&quot;, # Output only. The identifier of the product that was procured.
339 &quot;provider&quot;: &quot;A String&quot;, # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
340 &quot;quoteExternalName&quot;: &quot;A String&quot;, # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
341 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the entitlement.
342 &quot;subscriptionEndTime&quot;: &quot;A String&quot;, # Output only. End time for the subscription corresponding to this entitlement.
343 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp.
344 &quot;usageReportingId&quot;: &quot;A String&quot;, # Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
345}</pre>
346</div>
347
348<div class="method">
349 <code class="details" id="reject">reject(name, body=None, x__xgafv=None)</code>
350 <pre>Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.
351
352Args:
353 name: string, The resource name of the entitlement. Required. (required)
354 body: object, The request body.
355 The object takes the form of:
356
357{ # Request message for PartnerProcurementService.RejectEntitlement.
358 &quot;reason&quot;: &quot;A String&quot;, # Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.
359}
360
361 x__xgafv: string, V1 error format.
362 Allowed values
363 1 - v1 error format
364 2 - v2 error format
365
366Returns:
367 An object of the form:
368
369 { # 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 `{}`.
370}</pre>
371</div>
372
373<div class="method">
374 <code class="details" id="rejectPlanChange">rejectPlanChange(name, body=None, x__xgafv=None)</code>
375 <pre>Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.
376
377Args:
378 name: string, The resource name of the entitlement. Required. (required)
379 body: object, The request body.
380 The object takes the form of:
381
382{ # Request message for PartnerProcurementService.RejectEntitlementPlanChange.
383 &quot;pendingPlanName&quot;: &quot;A String&quot;, # Name of the pending plan that is being rejected. Required.
384 &quot;reason&quot;: &quot;A String&quot;, # Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.
385}
386
387 x__xgafv: string, V1 error format.
388 Allowed values
389 1 - v1 error format
390 2 - v2 error format
391
392Returns:
393 An object of the form:
394
395 { # 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 `{}`.
396}</pre>
397</div>
398
399<div class="method">
400 <code class="details" id="suspend">suspend(name, body=None, x__xgafv=None)</code>
401 <pre>Requests suspension of an active Entitlement. This is not yet supported.
402
403Args:
404 name: string, The name of the entitlement to suspend. (required)
405 body: object, The request body.
406 The object takes the form of:
407
408{ # Request message for ParterProcurementService.SuspendEntitlement. This is not yet supported.
409 &quot;reason&quot;: &quot;A String&quot;, # A free-form reason string, explaining the reason for suspension request.
410}
411
412 x__xgafv: string, V1 error format.
413 Allowed values
414 1 - v1 error format
415 2 - v2 error format
416
417Returns:
418 An object of the form:
419
420 { # 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 `{}`.
421}</pre>
422</div>
423
424</body></html>