Package com.google.cloud.channel.v1

Interface EntitlementOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Entitlement, Entitlement.Builder
@Generated public interface EntitlementOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. Resource name of an entitlement in the form:
 accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of an entitlement in the form:
 accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time at which the entitlement is created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time at which the entitlement is created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which the entitlement is created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time at which the entitlement is updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time at which the entitlement is updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time at which the entitlement is updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getOffer

      String getOffer()
       Required. The offer resource name for which the entitlement is to be
 created. Takes the form: accounts/{account_id}/offers/{offer_id}.
      string offer = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The offer.

    • getOfferBytes

      com.google.protobuf.ByteString getOfferBytes()
       Required. The offer resource name for which the entitlement is to be
 created. Takes the form: accounts/{account_id}/offers/{offer_id}.
      string offer = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for offer.

    • hasCommitmentSettings

      boolean hasCommitmentSettings()
       Commitment settings for a commitment-based Offer.
 Required for commitment based offers.
      .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
      Returns:
      Whether the commitmentSettings field is set.

    • getCommitmentSettings

      CommitmentSettings getCommitmentSettings()
       Commitment settings for a commitment-based Offer.
 Required for commitment based offers.
      .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
      Returns:
      The commitmentSettings.

    • getCommitmentSettingsOrBuilder

      CommitmentSettingsOrBuilder getCommitmentSettingsOrBuilder()
       Commitment settings for a commitment-based Offer.
 Required for commitment based offers.
      .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;

    • getProvisioningStateValue

      int getProvisioningStateValue()
       Output only. Current provisioning state of the entitlement.
      .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for provisioningState.

    • getProvisioningState

      Entitlement.ProvisioningState getProvisioningState()
       Output only. Current provisioning state of the entitlement.
      .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The provisioningState.

    • hasProvisionedService

      boolean hasProvisionedService()
       Output only. Service provisioning details for the entitlement.
      .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the provisionedService field is set.

    • getProvisionedService

      ProvisionedService getProvisionedService()
       Output only. Service provisioning details for the entitlement.
      .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The provisionedService.

    • getProvisionedServiceOrBuilder

      ProvisionedServiceOrBuilder getProvisionedServiceOrBuilder()
       Output only. Service provisioning details for the entitlement.
      .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSuspensionReasonsList

      List<Entitlement.SuspensionReason> getSuspensionReasonsList()
       Output only. Enumerable of all current suspension reasons for an
 entitlement.
      repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the suspensionReasons.

    • getSuspensionReasonsCount

      int getSuspensionReasonsCount()
       Output only. Enumerable of all current suspension reasons for an
 entitlement.
      repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of suspensionReasons.

    • getSuspensionReasons

      Entitlement.SuspensionReason getSuspensionReasons(int index)
       Output only. Enumerable of all current suspension reasons for an
 entitlement.
      repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The suspensionReasons at the given index.

    • getSuspensionReasonsValueList

      List<Integer> getSuspensionReasonsValueList()
       Output only. Enumerable of all current suspension reasons for an
 entitlement.
      repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the enum numeric values on the wire for suspensionReasons.

    • getSuspensionReasonsValue

      int getSuspensionReasonsValue(int index)
       Output only. Enumerable of all current suspension reasons for an
 entitlement.
      repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of suspensionReasons at the given index.

    • getPurchaseOrderId

      String getPurchaseOrderId()
       Optional. This purchase order (PO) information is for resellers to use for
 their company tracking usage. If a purchaseOrderId value is given, it
 appears in the API responses and shows up in the invoice. The property
 accepts up to 80 plain text characters. This is only supported for Google
 Workspace entitlements.
      string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The purchaseOrderId.

    • getPurchaseOrderIdBytes

      com.google.protobuf.ByteString getPurchaseOrderIdBytes()
       Optional. This purchase order (PO) information is for resellers to use for
 their company tracking usage. If a purchaseOrderId value is given, it
 appears in the API responses and shows up in the invoice. The property
 accepts up to 80 plain text characters. This is only supported for Google
 Workspace entitlements.
      string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for purchaseOrderId.

    • hasTrialSettings

      boolean hasTrialSettings()
       Output only. Settings for trial offers.
      .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the trialSettings field is set.

    • getTrialSettings

      TrialSettings getTrialSettings()
       Output only. Settings for trial offers.
      .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The trialSettings.

    • getTrialSettingsOrBuilder

      TrialSettingsOrBuilder getTrialSettingsOrBuilder()
       Output only. Settings for trial offers.
      .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasAssociationInfo

      boolean hasAssociationInfo()
       Association information to other entitlements.
      .google.cloud.channel.v1.AssociationInfo association_info = 23;
      Returns:
      Whether the associationInfo field is set.

    • getAssociationInfo

      AssociationInfo getAssociationInfo()
       Association information to other entitlements.
      .google.cloud.channel.v1.AssociationInfo association_info = 23;
      Returns:
      The associationInfo.

    • getAssociationInfoOrBuilder

      AssociationInfoOrBuilder getAssociationInfoOrBuilder()
       Association information to other entitlements.
      .google.cloud.channel.v1.AssociationInfo association_info = 23;

    • getParametersList

      List<Parameter> getParametersList()
       Extended entitlement parameters. When creating an entitlement, valid
 parameter names and values are defined in the
 [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
      repeated .google.cloud.channel.v1.Parameter parameters = 26;

    • getParameters

      Parameter getParameters(int index)
       Extended entitlement parameters. When creating an entitlement, valid
 parameter names and values are defined in the
 [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
      repeated .google.cloud.channel.v1.Parameter parameters = 26;

    • getParametersCount

      int getParametersCount()
       Extended entitlement parameters. When creating an entitlement, valid
 parameter names and values are defined in the
 [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
      repeated .google.cloud.channel.v1.Parameter parameters = 26;

    • getParametersOrBuilderList

      List<? extends ParameterOrBuilder> getParametersOrBuilderList()
       Extended entitlement parameters. When creating an entitlement, valid
 parameter names and values are defined in the
 [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
      repeated .google.cloud.channel.v1.Parameter parameters = 26;

    • getParametersOrBuilder

      ParameterOrBuilder getParametersOrBuilder(int index)
       Extended entitlement parameters. When creating an entitlement, valid
 parameter names and values are defined in the
 [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
      repeated .google.cloud.channel.v1.Parameter parameters = 26;

    • getBillingAccount

      String getBillingAccount()
       Optional. The billing account resource name that is used to pay for this
 entitlement.
      string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The billingAccount.

    • getBillingAccountBytes

      com.google.protobuf.ByteString getBillingAccountBytes()
       Optional. The billing account resource name that is used to pay for this
 entitlement.
      string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for billingAccount.

    • getPriceReferenceId

      String getPriceReferenceId()
       Optional. Price reference ID for the offer. Only for offers that require
 additional price information. Used to guarantee that the pricing is
 consistent between quoting the offer and placing the order.
      string price_reference_id = 29 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The priceReferenceId.

    • getPriceReferenceIdBytes

      com.google.protobuf.ByteString getPriceReferenceIdBytes()
       Optional. Price reference ID for the offer. Only for offers that require
 additional price information. Used to guarantee that the pricing is
 consistent between quoting the offer and placing the order.
      string price_reference_id = 29 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for priceReferenceId.