flink_artifacts

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

Overview

Name	flink_artifacts
Type	Resource
Id	confluent.flink_artifacts.flink_artifacts

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").
description	string	Description of the Flink Artifact.
api_version	string	APIVersion defines the schema version of this representation of a resource.
class	string	Java class or alias for the artifact as provided by developer.
cloud	string	Cloud provider where the Flink Artifact archive is uploaded.
content_format	string	Archive format of the Flink Artifact.
display_name	string	Display name of the Flink Artifact.
documentation_link	string	Document link of the Flink Artifact.
environment	string	Environment the Flink Artifact belongs to.
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.
region	string	The Cloud provider region the Flink Artifact archive is uploaded.
runtime_language	string	Runtime language of the Flink Artifact.
versions	array	Versions associated with this Flink Artifact.

Methods

Name	Accessible by	Required Params	Description
get_artifact_v1flink_artifact	SELECT	cloud, id, region	Make a request to read a flink artifact.
list_artifact_v1flink_artifacts	SELECT	cloud, region	Retrieve a sorted, filtered, paginated list of all flink artifacts. If no environment filter is specified, returns Artifacts across envs for cloud & region.
create_artifact_v1flink_artifact	INSERT	cloud, region, data__class, data__cloud, data__display_name, data__environment, data__region, data__upload_source	Make a request to create a flink artifact.
delete_artifact_v1flink_artifact	DELETE	cloud, id, region	Make a request to delete a flink artifact.
update_artifact_v1flink_artifact	UPDATE	cloud, id, region	Make a request to update a flink artifact.

SELECT examples

Retrieve a sorted, filtered, paginated list of all flink artifacts. If no environment filter is specified, returns Artifacts across envs for cloud & region.

SELECT
id,
description,
api_version,
class,
cloud,
content_format,
display_name,
documentation_link,
environment,
kind,
metadata,
region,
runtime_language,
versions
FROM confluent.flink_artifacts.flink_artifacts
WHERE cloud = '{{ cloud }}'
AND region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO confluent.flink_artifacts.flink_artifacts (
data__cloud,
data__region,
data__environment,
data__display_name,
data__class,
data__content_format,
data__description,
data__documentation_link,
data__runtime_language,
data__upload_source,
cloud,
region
)
SELECT 
'{{ cloud }}',
'{{ region }}',
'{{ environment }}',
'{{ display_name }}',
'{{ class }}',
'{{ content_format }}',
'{{ description }}',
'{{ documentation_link }}',
'{{ runtime_language }}',
'{{ upload_source }}'
;

All Properties

/*+ create */
INSERT INTO confluent.flink_artifacts.flink_artifacts (
data__cloud,
data__region,
data__environment,
data__display_name,
data__class,
data__upload_source,
cloud,
region
)
SELECT 
'{{ cloud }}',
'{{ region }}',
'{{ environment }}',
'{{ display_name }}',
'{{ class }}',
'{{ upload_source }}'
;

Manifest

- name: flink_artifacts
  props:
    - name: cloud
      value: string
    - name: region
      value: string
    - name: data__class
      value: string
    - name: data__cloud
      value: string
    - name: data__display_name
      value: string
    - name: data__environment
      value: string
    - name: data__region
      value: string
    - name: data__upload_source
      value: string
    - name: cloud
      value: string
    - name: region
      value: string
    - name: environment
      value: string
    - name: display_name
      value: string
    - name: class
      value: string
    - name: content_format
      value: string
    - name: description
      value: string
    - name: documentation_link
      value: string
    - name: runtime_language
      value: string
    - name: upload_source
      props:
        - name: location
          value: string
        - name: upload_id
          value: string

UPDATE example

Updates a flink_artifacts resource.

/*+ update */
UPDATE confluent.flink_artifacts.flink_artifacts
SET 
cloud = '{{ cloud }}',
region = '{{ region }}',
environment = '{{ environment }}',
display_name = '{{ display_name }}',
content_format = '{{ content_format }}',
description = '{{ description }}',
documentation_link = '{{ documentation_link }}',
runtime_language = '{{ runtime_language }}',
versions = '{{ versions }}'
WHERE 
cloud = '{{ cloud }}'
AND id = '{{ id }}'
AND region = '{{ region }}';

DELETE example

Deletes the specified flink_artifacts resource.

/*+ delete */
DELETE FROM confluent.flink_artifacts.flink_artifacts
WHERE cloud = '{{ cloud }}'
AND id = '{{ id }}'
AND region = '{{ region }}';