Console
    Contact Us Start free

    Google Cloud Channel V1 Client - Class Entitlement (1.0.1)

    Reference documentation and code samples for the Google Cloud Channel V1 Client class Entitlement.

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

    Generated from protobuf message google.cloud.channel.v1.Entitlement

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ create_time
    Google\Protobuf\Timestamp

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

    ↳ update_time
    Google\Protobuf\Timestamp

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

    ↳ offer
    string

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

    ↳ commitment_settings
    Google\Cloud\Channel\V1\CommitmentSettings

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

    ↳ provisioning_state
    int

    Output only. Current provisioning state of the entitlement.

    ↳ provisioned_service
    Google\Cloud\Channel\V1\ProvisionedService

    Output only. Service provisioning details for the entitlement.

    ↳ suspension_reasons
    int[]

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

    ↳ purchase_order_id
    string

    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.

    ↳ trial_settings
    Google\Cloud\Channel\V1\TrialSettings

    Output only. Settings for trial offers.

    ↳ association_info
    Google\Cloud\Channel\V1\AssociationInfo

    Association information to other entitlements.

    ↳ parameters
    array< Google\Cloud\Channel\V1\Parameter >

    Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions . The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.

    getName

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

    Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    string

    setName

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

    Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

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

    Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasCreateTime

    clearCreateTime

    setCreateTime

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

    Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

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

    Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

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

    Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getOffer

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

    Generated from protobuf field string offer = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

    Returns
    Type
    Description
    string

    setOffer

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

    Generated from protobuf field string offer = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCommitmentSettings

    Commitment settings for a commitment-based Offer.

    Required for commitment based offers.

    Generated from protobuf field .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;

    Returns
    Type
    Description
    Google\Cloud\Channel\V1\CommitmentSettings |null

    hasCommitmentSettings

    clearCommitmentSettings

    setCommitmentSettings

    Commitment settings for a commitment-based Offer.

    Required for commitment based offers.

    Generated from protobuf field .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;

    Parameter
    Name
    Description
    var
    Google\Cloud\Channel\V1\CommitmentSettings
    Returns
    Type
    Description
    $this

    getProvisioningState

    Output only. Current provisioning state of the entitlement.

    Generated from protobuf field .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    int

    setProvisioningState

    Output only. Current provisioning state of the entitlement.

    Generated from protobuf field .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getProvisionedService

    Output only. Service provisioning details for the entitlement.

    Generated from protobuf field .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Cloud\Channel\V1\ProvisionedService |null

    hasProvisionedService

    clearProvisionedService

    setProvisionedService

    Output only. Service provisioning details for the entitlement.

    Generated from protobuf field .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Cloud\Channel\V1\ProvisionedService
    Returns
    Type
    Description
    $this

    getSuspensionReasons

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

    Generated from protobuf field repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setSuspensionReasons

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

    Generated from protobuf field repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    int[]
    Returns
    Type
    Description
    $this

    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.

    Generated from protobuf field string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    Type
    Description
    string

    setPurchaseOrderId

    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.

    Generated from protobuf field string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getTrialSettings

    Output only. Settings for trial offers.

    Generated from protobuf field .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Cloud\Channel\V1\TrialSettings |null

    hasTrialSettings

    clearTrialSettings

    setTrialSettings

    Output only. Settings for trial offers.

    Generated from protobuf field .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Cloud\Channel\V1\TrialSettings
    Returns
    Type
    Description
    $this

    getAssociationInfo

    Association information to other entitlements.

    Generated from protobuf field .google.cloud.channel.v1.AssociationInfo association_info = 23;

    Returns
    Type
    Description
    Google\Cloud\Channel\V1\AssociationInfo |null

    hasAssociationInfo

    clearAssociationInfo

    setAssociationInfo

    Association information to other entitlements.

    Generated from protobuf field .google.cloud.channel.v1.AssociationInfo association_info = 23;

    Parameter
    Name
    Description
    var
    Google\Cloud\Channel\V1\AssociationInfo
    Returns
    Type
    Description
    $this

    getParameters

    Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions .

    The response may include the following output-only Parameters:

    • assigned_units: The number of licenses assigned to users.
    • max_units: The maximum assignable units for a flexible offer.
    • num_units: The total commitment for commitment-based offers.

    Generated from protobuf field repeated .google.cloud.channel.v1.Parameter parameters = 26;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setParameters

    Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions .

    The response may include the following output-only Parameters:

    • assigned_units: The number of licenses assigned to users.
    • max_units: The maximum assignable units for a flexible offer.
    • num_units: The total commitment for commitment-based offers.

    Generated from protobuf field repeated .google.cloud.channel.v1.Parameter parameters = 26;

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Channel\V1\Parameter >
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: