Sign in
Flink Artifacts (artifact/v1)

Read a Flink Artifact

General Availability

Make a request to read a flink artifact.

get/artifact/v1/flink-artifacts/{id}

Path parameters

idstring required

The unique identifier for the flink artifact.

Query parameters

cloudstring required

Filter a collection by a string search

Scope the operation to the given cloud.

regionstring required

Filter a collection by a string search

Scope the operation to the given region.

environmentstring required

Filter a collection by a string search

Scope the operation to the given environment.

Response

Flink Artifact.

api_version'artifact/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'FlinkArtifact' required

Kind defines the object this REST resource represents.

idstring required

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").

cloudstring required

Cloud provider where the Flink Artifact archive is uploaded.

regionstring required

The Cloud provider region the Flink Artifact archive is uploaded.

environmentstring required

Environment the Flink Artifact belongs to.

display_namestring required

Unique name of the Flink Artifact per cloud, region, environment scope.

classstring

Java class or alias for the artifact as provided by developer. Deprecated

content_formatstring

Archive format of the Flink Artifact.

descriptionstring

Description of the Flink Artifact.

documentation_linkstring

Documentation link of the Flink Artifact.

runtime_languagestring

Runtime language of the Flink Artifact.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/artifact/v1/flink-artifacts/fa-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/flink-artifact=fa-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "cloud": "AWS",
  "region": "us-east-1",
  "environment": "env-00000",
  "class": "io.confluent.example.SumScalarFunction",
  "content_format": "JAR",
  "runtime_language": "JAVA",
  "versions": [
    {
      "version": "cfa-ver-001",
      "artifact_id": {
        "id": "dlz-f3a90de",
        "metadata": {
          "self": "https://api.confluent.cloud/artifact/v1/flink-artifacts/fa-12345",
          "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/flink-artifact=fa-12345",
          "created_at": "2006-01-02T15:04:05-07:00",
          "updated_at": "2006-01-02T15:04:05-07:00",
          "deleted_at": "2006-01-02T15:04:05-07:00"
        },
        "cloud": "AWS",
        "region": "us-east-1",
        "environment": "env-00000",
        "class": "io.confluent.example.SumScalarFunction",
        "content_format": "JAR",
        "runtime_language": "JAVA"
      },
      "upload_source": {
        "id": "dlz-f3a90de",
        "metadata": {
          "self": "https://api.confluent.cloud/artifact.v1/UploadSource/presigned-urls/pu-12345",
          "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/presigned-url=pu-12345",
          "created_at": "2006-01-02T15:04:05-07:00",
          "updated_at": "2006-01-02T15:04:05-07:00",
          "deleted_at": "2006-01-02T15:04:05-07:00"
        },
        "location": "PRESIGNED_URL_LOCATION",
        "upload_id": "e53bb2e8-8de3-49fa-9fb1-4e3fd9a16b66"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.