entitlements

Creates, updates, deletes, gets or lists a entitlements resource.

Overview

Name	entitlements
Type	Resource
Id	confluent.partner.entitlements

Fields

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
name	string	The name of the entitlement
api_version	string	APIVersion defines the schema version of this representation of a resource.
external_id	string	The unique external ID of the entitlement (this should be unique to customer)
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
organization	object	The organization associated with this object.
plan_id	string	The plan ID the entitlement
product_id	string	The product ID of the entitlement
resource_id	string	The resource ID of the entitlement
usage_reporting_id	string	The usage reporting ID of the entitlement (if usage reporting uses a different ID, otherwise, same as external_id)

Methods

Name	Accessible by	Required Params	Description
get_partner_v2entitlement	SELECT	id	Make a request to read an entitlement.
list_partner_v2entitlements	SELECT		Retrieve a sorted, filtered, paginated list of all entitlements.
create_partner_v2entitlement	INSERT		Make a request to create an entitlement.

SELECT examples

Retrieve a sorted, filtered, paginated list of all entitlements.

SELECT
id,
name,
api_version,
external_id,
kind,
metadata,
organization,
plan_id,
product_id,
resource_id,
usage_reporting_id
FROM confluent.partner.entitlements
;

INSERT example

Use the following StackQL query and manifest file to create a new entitlements resource.

Required Properties

/*+ create */
INSERT INTO confluent.partner.entitlements (
data__external_id,
data__name,
data__plan_id,
data__product_id,
data__usage_reporting_id,
data__resource_id,
data__organization
)
SELECT 
'{{ external_id }}',
'{{ name }}',
'{{ plan_id }}',
'{{ product_id }}',
'{{ usage_reporting_id }}',
'{{ resource_id }}',
'{{ organization }}'
;

All Properties

/*+ create */
INSERT INTO confluent.partner.entitlements (
data__external_id,
data__name,
data__plan_id,
data__product_id
)
SELECT 
'{{ external_id }}',
'{{ name }}',
'{{ plan_id }}',
'{{ product_id }}'
;

Manifest

- name: entitlements
  props:
    - name: external_id
      value: string
    - name: name
      value: string
    - name: plan_id
      value: string
    - name: product_id
      value: string
    - name: usage_reporting_id
      value: string
    - name: resource_id
      value: string
    - name: organization
      props:
        - name: id
          value: string
        - name: environment
          value: string