compute_pools

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

Overview

Name	compute_pools
Type	Resource
Id	confluent.flink_compute_pools.compute_pools

Fields

The following fields are returned by SELECT queries:

get_fcpm_v2_compute_pool

Compute Pool.

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"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (fcpm/v2)
kind	string	Kind defines the object this REST resource represents. (ComputePool)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Compute Pool
status	object	The status of the Compute Pool

list_fcpm_v2_compute_pools

Compute Pool.

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"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (fcpm/v2)
kind	string	Kind defines the object this REST resource represents. (ComputePool)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Compute Pool
status	object	The status of the Compute Pool

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_fcpm_v2_compute_pool	select	environment, id		Make a request to read a compute pool.
list_fcpm_v2_compute_pools	select	environment	spec.region, spec.network, page_size, page_token	Retrieve a sorted, filtered, paginated list of all compute pools.
create_fcpm_v2_compute_pool	insert	spec		Make a request to create a compute pool.
update_fcpm_v2_compute_pool	update	id, spec		Make a request to update a compute pool.
delete_fcpm_v2_compute_pool	delete	environment, id		Make a request to delete a compute pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment	string	Scope the operation to the given environment. (example: env-00000)
id	string	The unique identifier for the compute pool.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
spec.network	string	Filter the results by exact match for spec.network. (example: n-00000)
spec.region	string	Filter the results by exact match for spec.region. (example: us-west-1)

SELECT examples

get_fcpm_v2_compute_pool

Make a request to read a compute pool.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.flink_compute_pools.compute_pools
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_fcpm_v2_compute_pools

Retrieve a sorted, filtered, paginated list of all compute pools.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.flink_compute_pools.compute_pools
WHERE environment = '{{ environment }}' -- required
AND spec.region = '{{ spec.region }}'
AND spec.network = '{{ spec.network }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_fcpm_v2_compute_pool

Make a request to create a compute pool.

INSERT INTO confluent.flink_compute_pools.compute_pools (
spec
)
SELECT 
'{{ spec }}' /* required */
RETURNING
id,
api_version,
kind,
metadata,
spec,
status
;

Manifest

# Description fields are for documentation purposes
- name: compute_pools
props:
  - name: spec
    description: |
      The desired state of the Compute Pool
    value:
      display_name: "{{ display_name }}"
      cloud: "{{ cloud }}"
      region: "{{ region }}"
      max_cfu: {{ max_cfu }}
      enable_ai: {{ enable_ai }}
      default_pool: {{ default_pool }}
      environment:
        id: "{{ id }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
      network:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"

UPDATE examples

update_fcpm_v2_compute_pool

Make a request to update a compute pool.

UPDATE confluent.flink_compute_pools.compute_pools
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}' --required
AND spec = '{{ spec }}' --required
RETURNING
id,
api_version,
kind,
metadata,
spec,
status;

DELETE examples

delete_fcpm_v2_compute_pool

Make a request to delete a compute pool.

DELETE FROM confluent.flink_compute_pools.compute_pools
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;