yoshi-code-bot | 807277b | 2021-04-22 04:38:02 -0700 | [diff] [blame] | 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="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 | |
| 112 | Args: |
| 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 | "properties": { # Set of properties that should be associated with the entitlement. Optional. |
| 119 | "a_key": "A String", |
| 120 | }, |
| 121 | } |
| 122 | |
| 123 | x__xgafv: string, V1 error format. |
| 124 | Allowed values |
| 125 | 1 - v1 error format |
| 126 | 2 - v2 error format |
| 127 | |
| 128 | Returns: |
| 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 | |
| 139 | Args: |
| 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 | "pendingPlanName": "A String", # 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 | |
| 153 | Returns: |
| 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 | |
| 169 | Args: |
| 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 | |
| 176 | Returns: |
| 177 | An object of the form: |
| 178 | |
| 179 | { # Represents a procured product of a customer. Next Id: 23 |
| 180 | "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any. |
| 181 | "consumers": [ # Output only. The resources using this entitlement, if applicable. |
| 182 | { # A resource using (consuming) this entitlement. |
| 183 | "project": "A String", # A project name with format `projects/`. |
| 184 | }, |
| 185 | ], |
| 186 | "createTime": "A String", # Output only. The creation timestamp. |
| 187 | "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement. |
| 188 | "a_key": "", # Properties of the object. |
| 189 | }, |
| 190 | "messageToUser": "A String", # 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 | "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`. |
| 192 | "newPendingOffer": "A String", # 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: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. |
| 193 | "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. |
| 194 | "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. |
| 195 | "offerEndTime": "A String", # 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 | "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans. |
| 197 | "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. |
| 198 | "productExternalName": "A String", # Output only. The identifier of the product that was procured. |
| 199 | "provider": "A String", # 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 | "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. |
| 201 | "state": "A String", # Output only. The state of the entitlement. |
| 202 | "subscriptionEndTime": "A String", # Output only. End time for the subscription corresponding to this entitlement. |
| 203 | "updateTime": "A String", # Output only. The last update timestamp. |
| 204 | "usageReportingId": "A String", # 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 | |
| 212 | Args: |
| 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 "ENTITLEMENT_". 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="providerId:productId"`, 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 | |
| 222 | Returns: |
| 223 | An object of the form: |
| 224 | |
| 225 | { # Response message for PartnerProcurementService.ListEntitlements. |
| 226 | "entitlements": [ # The list of entitlements in this response. |
| 227 | { # Represents a procured product of a customer. Next Id: 23 |
| 228 | "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any. |
| 229 | "consumers": [ # Output only. The resources using this entitlement, if applicable. |
| 230 | { # A resource using (consuming) this entitlement. |
| 231 | "project": "A String", # A project name with format `projects/`. |
| 232 | }, |
| 233 | ], |
| 234 | "createTime": "A String", # Output only. The creation timestamp. |
| 235 | "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement. |
| 236 | "a_key": "", # Properties of the object. |
| 237 | }, |
| 238 | "messageToUser": "A String", # 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 | "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`. |
| 240 | "newPendingOffer": "A String", # 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: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. |
| 241 | "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. |
| 242 | "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. |
| 243 | "offerEndTime": "A String", # 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 | "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans. |
| 245 | "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. |
| 246 | "productExternalName": "A String", # Output only. The identifier of the product that was procured. |
| 247 | "provider": "A String", # 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 | "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. |
| 249 | "state": "A String", # Output only. The state of the entitlement. |
| 250 | "subscriptionEndTime": "A String", # Output only. End time for the subscription corresponding to this entitlement. |
| 251 | "updateTime": "A String", # Output only. The last update timestamp. |
| 252 | "usageReportingId": "A String", # 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 | "nextPageToken": "A String", # 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 | |
| 263 | Args: |
| 264 | previous_request: The request for the previous page. (required) |
| 265 | previous_response: The response from the request for the previous page. (required) |
| 266 | |
| 267 | Returns: |
| 268 | A request object that you can call 'execute()' 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 | |
| 277 | Args: |
| 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 | "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any. |
| 284 | "consumers": [ # Output only. The resources using this entitlement, if applicable. |
| 285 | { # A resource using (consuming) this entitlement. |
| 286 | "project": "A String", # A project name with format `projects/`. |
| 287 | }, |
| 288 | ], |
| 289 | "createTime": "A String", # Output only. The creation timestamp. |
| 290 | "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement. |
| 291 | "a_key": "", # Properties of the object. |
| 292 | }, |
| 293 | "messageToUser": "A String", # 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 | "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`. |
| 295 | "newPendingOffer": "A String", # 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: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. |
| 296 | "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. |
| 297 | "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. |
| 298 | "offerEndTime": "A String", # 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 | "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans. |
| 300 | "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. |
| 301 | "productExternalName": "A String", # Output only. The identifier of the product that was procured. |
| 302 | "provider": "A String", # 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 | "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. |
| 304 | "state": "A String", # Output only. The state of the entitlement. |
| 305 | "subscriptionEndTime": "A String", # Output only. End time for the subscription corresponding to this entitlement. |
| 306 | "updateTime": "A String", # Output only. The last update timestamp. |
| 307 | "usageReportingId": "A String", # 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 | |
| 316 | Returns: |
| 317 | An object of the form: |
| 318 | |
| 319 | { # Represents a procured product of a customer. Next Id: 23 |
| 320 | "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any. |
| 321 | "consumers": [ # Output only. The resources using this entitlement, if applicable. |
| 322 | { # A resource using (consuming) this entitlement. |
| 323 | "project": "A String", # A project name with format `projects/`. |
| 324 | }, |
| 325 | ], |
| 326 | "createTime": "A String", # Output only. The creation timestamp. |
| 327 | "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement. |
| 328 | "a_key": "", # Properties of the object. |
| 329 | }, |
| 330 | "messageToUser": "A String", # 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 | "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`. |
| 332 | "newPendingOffer": "A String", # 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: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. |
| 333 | "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. |
| 334 | "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. |
| 335 | "offerEndTime": "A String", # 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 | "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans. |
| 337 | "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. |
| 338 | "productExternalName": "A String", # Output only. The identifier of the product that was procured. |
| 339 | "provider": "A String", # 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 | "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. |
| 341 | "state": "A String", # Output only. The state of the entitlement. |
| 342 | "subscriptionEndTime": "A String", # Output only. End time for the subscription corresponding to this entitlement. |
| 343 | "updateTime": "A String", # Output only. The last update timestamp. |
| 344 | "usageReportingId": "A String", # 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 | |
| 352 | Args: |
| 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 | "reason": "A String", # 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 | |
| 366 | Returns: |
| 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 | |
| 377 | Args: |
| 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 | "pendingPlanName": "A String", # Name of the pending plan that is being rejected. Required. |
| 384 | "reason": "A String", # 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 | |
| 392 | Returns: |
| 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 | |
| 403 | Args: |
| 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 | "reason": "A String", # 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 | |
| 417 | Returns: |
| 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> |