Cloud Channel v1 API - Class Entitlement (2.14.0) 

public sealed class Entitlement : IMessage<Entitlement>, IEquatable<Entitlement>, IDeepCloneable<Entitlement>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Channel v1 API class Entitlement.

An entitlement is a representation of a customer's ability to use a service.

Inheritance

object > Entitlement

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

Entitlement()

public Entitlement()

Entitlement(Entitlement)

public Entitlement(Entitlement other)
Parameter
Name Description
other Entitlement

Properties

AssociationInfo

public AssociationInfo AssociationInfo { get; set; }

Association information to other entitlements.

Property Value
Type Description
AssociationInfo

BillingAccount

public string BillingAccount { get; set; }

Optional. The billing account resource name that is used to pay for this entitlement.

Property Value
Type Description
string

CommitmentSettings

public CommitmentSettings CommitmentSettings { get; set; }

Commitment settings for a commitment-based Offer. Required for commitment based offers.

Property Value
Type Description
CommitmentSettings

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time at which the entitlement is created.

Property Value
Type Description
Timestamp

EntitlementName

public EntitlementName EntitlementName { get; set; }

EntitlementName-typed view over the Name resource name property.

Property Value
Type Description
EntitlementName

Name

public string Name { get; set; }

Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

Property Value
Type Description
string

Offer

public string Offer { get; set; }

Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

Property Value
Type Description
string

OfferAsOfferName

public OfferName OfferAsOfferName { get; set; }

OfferName-typed view over the Offer resource name property.

Property Value
Type Description
OfferName

Parameters

public RepeatedField<Parameter> Parameters { get; }

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.
Property Value
Type Description
RepeatedFieldParameter

ProvisionedService

public ProvisionedService ProvisionedService { get; set; }

Output only. Service provisioning details for the entitlement.

Property Value
Type Description
ProvisionedService

ProvisioningState

public Entitlement.Types.ProvisioningState ProvisioningState { get; set; }

Output only. Current provisioning state of the entitlement.

Property Value
Type Description
EntitlementTypesProvisioningState

PurchaseOrderId

public string PurchaseOrderId { get; set; }

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.

Property Value
Type Description
string

SuspensionReasons

public RepeatedField<Entitlement.Types.SuspensionReason> SuspensionReasons { get; }

Output only. Enumerable of all current suspension reasons for an entitlement.

Property Value
Type Description
RepeatedFieldEntitlementTypesSuspensionReason

TrialSettings

public TrialSettings TrialSettings { get; set; }

Output only. Settings for trial offers.

Property Value
Type Description
TrialSettings

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The time at which the entitlement is updated.

Property Value
Type Description
Timestamp