class Google::Apis::CloudcommerceprocurementV1::Entitlement

Represents a procured product of a customer. Next Id: 24

Attributes

account[RW]

Output only. The resource name of the account that this entitlement is based on, if any. Corresponds to the JSON property `account` @return [String]

consumers[RW]

Output only. The resources using this entitlement, if applicable. Corresponds to the JSON property `consumers` @return [Array<Google::Apis::CloudcommerceprocurementV1::Consumer>]

create_time[RW]

Output only. The creation timestamp. Corresponds to the JSON property `createTime` @return [String]

input_properties[RW]

Output only. The custom properties that were collected from the user to create this entitlement. Corresponds to the JSON property `inputProperties` @return [Hash<String,Object>]

message_to_user[RW]

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. Corresponds to the JSON property `messageToUser` @return [String]

name[RW]

Output only. The resource name of the entitlement. Entitlement names have the form `providers/`provider_id`/entitlements/`entitlement_id“. Corresponds to the JSON property `name` @return [String]

new_pending_offer[RW]

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. Corresponds to the JSON property `newPendingOffer` @return [String]

new_pending_plan[RW]

Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. Corresponds to the JSON property `newPendingPlan` @return [String]

offer[RW]

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. Corresponds to the JSON property `offer` @return [String]

offer_end_time[RW]

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. Corresponds to the JSON property `offerEndTime` @return [String]

plan[RW]

Output only. The identifier of the plan that was procured. Required if the product has plans. Corresponds to the JSON property `plan` @return [String]

product[RW]

Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. Corresponds to the JSON property `product` @return [String]

product_external_name[RW]

Output only. The identifier of the product that was procured. Corresponds to the JSON property `productExternalName` @return [String]

provider[RW]

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. Corresponds to the JSON property `provider` @return [String]

quote_external_name[RW]

Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. Corresponds to the JSON property `quoteExternalName` @return [String]

state[RW]

Output only. The state of the entitlement. Corresponds to the JSON property `state` @return [String]

subscription_end_time[RW]

Output only. End time for the subscription corresponding to this entitlement. Corresponds to the JSON property `subscriptionEndTime` @return [String]

update_time[RW]

Output only. The last update timestamp. Corresponds to the JSON property `updateTime` @return [String]

usage_reporting_id[RW]

Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](cloud. google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured. Corresponds to the JSON property `usageReportingId` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudcommerceprocurement_v1/classes.rb, line 362
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudcommerceprocurement_v1/classes.rb, line 367
def update!(**args)
  @account = args[:account] if args.key?(:account)
  @consumers = args[:consumers] if args.key?(:consumers)
  @create_time = args[:create_time] if args.key?(:create_time)
  @input_properties = args[:input_properties] if args.key?(:input_properties)
  @message_to_user = args[:message_to_user] if args.key?(:message_to_user)
  @name = args[:name] if args.key?(:name)
  @new_pending_offer = args[:new_pending_offer] if args.key?(:new_pending_offer)
  @new_pending_plan = args[:new_pending_plan] if args.key?(:new_pending_plan)
  @offer = args[:offer] if args.key?(:offer)
  @offer_end_time = args[:offer_end_time] if args.key?(:offer_end_time)
  @plan = args[:plan] if args.key?(:plan)
  @product = args[:product] if args.key?(:product)
  @product_external_name = args[:product_external_name] if args.key?(:product_external_name)
  @provider = args[:provider] if args.key?(:provider)
  @quote_external_name = args[:quote_external_name] if args.key?(:quote_external_name)
  @state = args[:state] if args.key?(:state)
  @subscription_end_time = args[:subscription_end_time] if args.key?(:subscription_end_time)
  @update_time = args[:update_time] if args.key?(:update_time)
  @usage_reporting_id = args[:usage_reporting_id] if args.key?(:usage_reporting_id)
end