1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/channel/v1/entitlements.proto 18 19 package com.google.cloud.channel.v1; 20 21 public interface EntitlementOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.channel.v1.Entitlement) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. Resource name of an entitlement in the form: 31 * accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. 32 * </pre> 33 * 34 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 35 * 36 * @return The name. 37 */ getName()38 java.lang.String getName(); 39 /** 40 * 41 * 42 * <pre> 43 * Output only. Resource name of an entitlement in the form: 44 * accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. 45 * </pre> 46 * 47 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 48 * 49 * @return The bytes for name. 50 */ getNameBytes()51 com.google.protobuf.ByteString getNameBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * Output only. The time at which the entitlement is created. 58 * </pre> 59 * 60 * <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 61 * </code> 62 * 63 * @return Whether the createTime field is set. 64 */ hasCreateTime()65 boolean hasCreateTime(); 66 /** 67 * 68 * 69 * <pre> 70 * Output only. The time at which the entitlement is created. 71 * </pre> 72 * 73 * <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 74 * </code> 75 * 76 * @return The createTime. 77 */ getCreateTime()78 com.google.protobuf.Timestamp getCreateTime(); 79 /** 80 * 81 * 82 * <pre> 83 * Output only. The time at which the entitlement is created. 84 * </pre> 85 * 86 * <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 87 * </code> 88 */ getCreateTimeOrBuilder()89 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 90 91 /** 92 * 93 * 94 * <pre> 95 * Output only. The time at which the entitlement is updated. 96 * </pre> 97 * 98 * <code>.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 99 * </code> 100 * 101 * @return Whether the updateTime field is set. 102 */ hasUpdateTime()103 boolean hasUpdateTime(); 104 /** 105 * 106 * 107 * <pre> 108 * Output only. The time at which the entitlement is updated. 109 * </pre> 110 * 111 * <code>.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 112 * </code> 113 * 114 * @return The updateTime. 115 */ getUpdateTime()116 com.google.protobuf.Timestamp getUpdateTime(); 117 /** 118 * 119 * 120 * <pre> 121 * Output only. The time at which the entitlement is updated. 122 * </pre> 123 * 124 * <code>.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 125 * </code> 126 */ getUpdateTimeOrBuilder()127 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 128 129 /** 130 * 131 * 132 * <pre> 133 * Required. The offer resource name for which the entitlement is to be 134 * created. Takes the form: accounts/{account_id}/offers/{offer_id}. 135 * </pre> 136 * 137 * <code> 138 * string offer = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 139 * </code> 140 * 141 * @return The offer. 142 */ getOffer()143 java.lang.String getOffer(); 144 /** 145 * 146 * 147 * <pre> 148 * Required. The offer resource name for which the entitlement is to be 149 * created. Takes the form: accounts/{account_id}/offers/{offer_id}. 150 * </pre> 151 * 152 * <code> 153 * string offer = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 154 * </code> 155 * 156 * @return The bytes for offer. 157 */ getOfferBytes()158 com.google.protobuf.ByteString getOfferBytes(); 159 160 /** 161 * 162 * 163 * <pre> 164 * Commitment settings for a commitment-based Offer. 165 * Required for commitment based offers. 166 * </pre> 167 * 168 * <code>.google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;</code> 169 * 170 * @return Whether the commitmentSettings field is set. 171 */ hasCommitmentSettings()172 boolean hasCommitmentSettings(); 173 /** 174 * 175 * 176 * <pre> 177 * Commitment settings for a commitment-based Offer. 178 * Required for commitment based offers. 179 * </pre> 180 * 181 * <code>.google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;</code> 182 * 183 * @return The commitmentSettings. 184 */ getCommitmentSettings()185 com.google.cloud.channel.v1.CommitmentSettings getCommitmentSettings(); 186 /** 187 * 188 * 189 * <pre> 190 * Commitment settings for a commitment-based Offer. 191 * Required for commitment based offers. 192 * </pre> 193 * 194 * <code>.google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;</code> 195 */ getCommitmentSettingsOrBuilder()196 com.google.cloud.channel.v1.CommitmentSettingsOrBuilder getCommitmentSettingsOrBuilder(); 197 198 /** 199 * 200 * 201 * <pre> 202 * Output only. Current provisioning state of the entitlement. 203 * </pre> 204 * 205 * <code> 206 * .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 207 * </code> 208 * 209 * @return The enum numeric value on the wire for provisioningState. 210 */ getProvisioningStateValue()211 int getProvisioningStateValue(); 212 /** 213 * 214 * 215 * <pre> 216 * Output only. Current provisioning state of the entitlement. 217 * </pre> 218 * 219 * <code> 220 * .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 221 * </code> 222 * 223 * @return The provisioningState. 224 */ getProvisioningState()225 com.google.cloud.channel.v1.Entitlement.ProvisioningState getProvisioningState(); 226 227 /** 228 * 229 * 230 * <pre> 231 * Output only. Service provisioning details for the entitlement. 232 * </pre> 233 * 234 * <code> 235 * .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 236 * </code> 237 * 238 * @return Whether the provisionedService field is set. 239 */ hasProvisionedService()240 boolean hasProvisionedService(); 241 /** 242 * 243 * 244 * <pre> 245 * Output only. Service provisioning details for the entitlement. 246 * </pre> 247 * 248 * <code> 249 * .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 250 * </code> 251 * 252 * @return The provisionedService. 253 */ getProvisionedService()254 com.google.cloud.channel.v1.ProvisionedService getProvisionedService(); 255 /** 256 * 257 * 258 * <pre> 259 * Output only. Service provisioning details for the entitlement. 260 * </pre> 261 * 262 * <code> 263 * .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 264 * </code> 265 */ getProvisionedServiceOrBuilder()266 com.google.cloud.channel.v1.ProvisionedServiceOrBuilder getProvisionedServiceOrBuilder(); 267 268 /** 269 * 270 * 271 * <pre> 272 * Output only. Enumerable of all current suspension reasons for an 273 * entitlement. 274 * </pre> 275 * 276 * <code> 277 * repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; 278 * </code> 279 * 280 * @return A list containing the suspensionReasons. 281 */ 282 java.util.List<com.google.cloud.channel.v1.Entitlement.SuspensionReason> getSuspensionReasonsList()283 getSuspensionReasonsList(); 284 /** 285 * 286 * 287 * <pre> 288 * Output only. Enumerable of all current suspension reasons for an 289 * entitlement. 290 * </pre> 291 * 292 * <code> 293 * repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; 294 * </code> 295 * 296 * @return The count of suspensionReasons. 297 */ getSuspensionReasonsCount()298 int getSuspensionReasonsCount(); 299 /** 300 * 301 * 302 * <pre> 303 * Output only. Enumerable of all current suspension reasons for an 304 * entitlement. 305 * </pre> 306 * 307 * <code> 308 * repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; 309 * </code> 310 * 311 * @param index The index of the element to return. 312 * @return The suspensionReasons at the given index. 313 */ getSuspensionReasons(int index)314 com.google.cloud.channel.v1.Entitlement.SuspensionReason getSuspensionReasons(int index); 315 /** 316 * 317 * 318 * <pre> 319 * Output only. Enumerable of all current suspension reasons for an 320 * entitlement. 321 * </pre> 322 * 323 * <code> 324 * repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; 325 * </code> 326 * 327 * @return A list containing the enum numeric values on the wire for suspensionReasons. 328 */ getSuspensionReasonsValueList()329 java.util.List<java.lang.Integer> getSuspensionReasonsValueList(); 330 /** 331 * 332 * 333 * <pre> 334 * Output only. Enumerable of all current suspension reasons for an 335 * entitlement. 336 * </pre> 337 * 338 * <code> 339 * repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY]; 340 * </code> 341 * 342 * @param index The index of the value to return. 343 * @return The enum numeric value on the wire of suspensionReasons at the given index. 344 */ getSuspensionReasonsValue(int index)345 int getSuspensionReasonsValue(int index); 346 347 /** 348 * 349 * 350 * <pre> 351 * Optional. This purchase order (PO) information is for resellers to use for 352 * their company tracking usage. If a purchaseOrderId value is given, it 353 * appears in the API responses and shows up in the invoice. The property 354 * accepts up to 80 plain text characters. This is only supported for Google 355 * Workspace entitlements. 356 * </pre> 357 * 358 * <code>string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];</code> 359 * 360 * @return The purchaseOrderId. 361 */ getPurchaseOrderId()362 java.lang.String getPurchaseOrderId(); 363 /** 364 * 365 * 366 * <pre> 367 * Optional. This purchase order (PO) information is for resellers to use for 368 * their company tracking usage. If a purchaseOrderId value is given, it 369 * appears in the API responses and shows up in the invoice. The property 370 * accepts up to 80 plain text characters. This is only supported for Google 371 * Workspace entitlements. 372 * </pre> 373 * 374 * <code>string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];</code> 375 * 376 * @return The bytes for purchaseOrderId. 377 */ getPurchaseOrderIdBytes()378 com.google.protobuf.ByteString getPurchaseOrderIdBytes(); 379 380 /** 381 * 382 * 383 * <pre> 384 * Output only. Settings for trial offers. 385 * </pre> 386 * 387 * <code> 388 * .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; 389 * </code> 390 * 391 * @return Whether the trialSettings field is set. 392 */ hasTrialSettings()393 boolean hasTrialSettings(); 394 /** 395 * 396 * 397 * <pre> 398 * Output only. Settings for trial offers. 399 * </pre> 400 * 401 * <code> 402 * .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; 403 * </code> 404 * 405 * @return The trialSettings. 406 */ getTrialSettings()407 com.google.cloud.channel.v1.TrialSettings getTrialSettings(); 408 /** 409 * 410 * 411 * <pre> 412 * Output only. Settings for trial offers. 413 * </pre> 414 * 415 * <code> 416 * .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; 417 * </code> 418 */ getTrialSettingsOrBuilder()419 com.google.cloud.channel.v1.TrialSettingsOrBuilder getTrialSettingsOrBuilder(); 420 421 /** 422 * 423 * 424 * <pre> 425 * Association information to other entitlements. 426 * </pre> 427 * 428 * <code>.google.cloud.channel.v1.AssociationInfo association_info = 23;</code> 429 * 430 * @return Whether the associationInfo field is set. 431 */ hasAssociationInfo()432 boolean hasAssociationInfo(); 433 /** 434 * 435 * 436 * <pre> 437 * Association information to other entitlements. 438 * </pre> 439 * 440 * <code>.google.cloud.channel.v1.AssociationInfo association_info = 23;</code> 441 * 442 * @return The associationInfo. 443 */ getAssociationInfo()444 com.google.cloud.channel.v1.AssociationInfo getAssociationInfo(); 445 /** 446 * 447 * 448 * <pre> 449 * Association information to other entitlements. 450 * </pre> 451 * 452 * <code>.google.cloud.channel.v1.AssociationInfo association_info = 23;</code> 453 */ getAssociationInfoOrBuilder()454 com.google.cloud.channel.v1.AssociationInfoOrBuilder getAssociationInfoOrBuilder(); 455 456 /** 457 * 458 * 459 * <pre> 460 * Extended entitlement parameters. When creating an entitlement, valid 461 * parameter names and values are defined in the 462 * [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions]. 463 * For Google Workspace, the following Parameters may be accepted as input: 464 * - max_units: The maximum assignable units for a flexible offer 465 * OR 466 * - num_units: The total commitment for commitment-based offers 467 * The response may additionally include the following output-only Parameters: 468 * - assigned_units: The number of licenses assigned to users. 469 * For GCP billing subaccounts, the following Parameter may be accepted as 470 * input: 471 * - display_name: The display name of the billing subaccount. 472 * </pre> 473 * 474 * <code>repeated .google.cloud.channel.v1.Parameter parameters = 26;</code> 475 */ getParametersList()476 java.util.List<com.google.cloud.channel.v1.Parameter> getParametersList(); 477 /** 478 * 479 * 480 * <pre> 481 * Extended entitlement parameters. When creating an entitlement, valid 482 * parameter names and values are defined in the 483 * [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions]. 484 * For Google Workspace, the following Parameters may be accepted as input: 485 * - max_units: The maximum assignable units for a flexible offer 486 * OR 487 * - num_units: The total commitment for commitment-based offers 488 * The response may additionally include the following output-only Parameters: 489 * - assigned_units: The number of licenses assigned to users. 490 * For GCP billing subaccounts, the following Parameter may be accepted as 491 * input: 492 * - display_name: The display name of the billing subaccount. 493 * </pre> 494 * 495 * <code>repeated .google.cloud.channel.v1.Parameter parameters = 26;</code> 496 */ getParameters(int index)497 com.google.cloud.channel.v1.Parameter getParameters(int index); 498 /** 499 * 500 * 501 * <pre> 502 * Extended entitlement parameters. When creating an entitlement, valid 503 * parameter names and values are defined in the 504 * [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions]. 505 * For Google Workspace, the following Parameters may be accepted as input: 506 * - max_units: The maximum assignable units for a flexible offer 507 * OR 508 * - num_units: The total commitment for commitment-based offers 509 * The response may additionally include the following output-only Parameters: 510 * - assigned_units: The number of licenses assigned to users. 511 * For GCP billing subaccounts, the following Parameter may be accepted as 512 * input: 513 * - display_name: The display name of the billing subaccount. 514 * </pre> 515 * 516 * <code>repeated .google.cloud.channel.v1.Parameter parameters = 26;</code> 517 */ getParametersCount()518 int getParametersCount(); 519 /** 520 * 521 * 522 * <pre> 523 * Extended entitlement parameters. When creating an entitlement, valid 524 * parameter names and values are defined in the 525 * [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions]. 526 * For Google Workspace, the following Parameters may be accepted as input: 527 * - max_units: The maximum assignable units for a flexible offer 528 * OR 529 * - num_units: The total commitment for commitment-based offers 530 * The response may additionally include the following output-only Parameters: 531 * - assigned_units: The number of licenses assigned to users. 532 * For GCP billing subaccounts, the following Parameter may be accepted as 533 * input: 534 * - display_name: The display name of the billing subaccount. 535 * </pre> 536 * 537 * <code>repeated .google.cloud.channel.v1.Parameter parameters = 26;</code> 538 */ 539 java.util.List<? extends com.google.cloud.channel.v1.ParameterOrBuilder> getParametersOrBuilderList()540 getParametersOrBuilderList(); 541 /** 542 * 543 * 544 * <pre> 545 * Extended entitlement parameters. When creating an entitlement, valid 546 * parameter names and values are defined in the 547 * [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions]. 548 * For Google Workspace, the following Parameters may be accepted as input: 549 * - max_units: The maximum assignable units for a flexible offer 550 * OR 551 * - num_units: The total commitment for commitment-based offers 552 * The response may additionally include the following output-only Parameters: 553 * - assigned_units: The number of licenses assigned to users. 554 * For GCP billing subaccounts, the following Parameter may be accepted as 555 * input: 556 * - display_name: The display name of the billing subaccount. 557 * </pre> 558 * 559 * <code>repeated .google.cloud.channel.v1.Parameter parameters = 26;</code> 560 */ getParametersOrBuilder(int index)561 com.google.cloud.channel.v1.ParameterOrBuilder getParametersOrBuilder(int index); 562 563 /** 564 * 565 * 566 * <pre> 567 * Optional. The billing account resource name that is used to pay for this 568 * entitlement. 569 * </pre> 570 * 571 * <code>string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];</code> 572 * 573 * @return The billingAccount. 574 */ getBillingAccount()575 java.lang.String getBillingAccount(); 576 /** 577 * 578 * 579 * <pre> 580 * Optional. The billing account resource name that is used to pay for this 581 * entitlement. 582 * </pre> 583 * 584 * <code>string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];</code> 585 * 586 * @return The bytes for billingAccount. 587 */ getBillingAccountBytes()588 com.google.protobuf.ByteString getBillingAccountBytes(); 589 } 590