images.Image

cloudflare_image

A Cloudflare Images image (the v1 API). Uploaded either as a direct file, from a source `url`, or referenced later via `id`; `metadata` is an arbitrary user-defined key-value store for linking the image back to an external system of record.

Example

import { intent, resource, stack } from "@ubx/sdk";
import { Image } from "@ubx/sdk-cloudflare/images";

export default stack("example", () => {
  intent({ summary: "example own image" });

  resource(Image, "example", {
    creator: "example",
    file: "example",
    id: "example",
    metadata: "example",
    requireSignedUrls: true,
    url: "example",
  });
});

package main

import (
	images "github.com/ubiquex/ubx-sdk-cloudflare/sdk/go/cloudflare/images"
	ubx "github.com/ubiquex/ubx-sdk-go/runtime"
)

func main() {
	ubx.Main(ubx.Stack("example", func() {
		ubx.Intent(ubx.IntentInfo{Summary: "example own image"})

		ubx.Resource(images.Image, "example", images.ImageConfig{
			Creator:           "example",
			File:              "example",
			Id:                "example",
			Metadata:          "example",
			RequireSignedUrls: true,
			Url:               "example",
		})
	}))
}

import ubx_sdk as ubx
from ubx.cloudflare.images.image import Image, ImageConfig

def describe():
    ubx.intent("example own image")

    ubx.resource(Image, "example", ImageConfig(
        creator="example",
        file="example",
        id="example",
        metadata="example",
        require_signed_urls=True,
        url="example",
    ))

if __name__ == "__main__":
    ubx.run("example", describe)

import { intent, resource, stack } from "@ubx/sdk";
import { Image } from "@ubx/sdk-cloudflare/images";

export default stack("example", () => {
  intent({ summary: "example own image" });

  resource(Image, "example", {
    creator: "example",
    file: "example",
    id: "example",
    metadata: "example",
    requireSignedUrls: true,
    url: "example",
  });
});

Input properties

creatorstring: Can set the creator field with an internal user ID.
filestring: An image binary data. Only needed when type is uploading a file.
idstring: Optional Image Custom ID. Up to 1024 chars. Can include any number of subpaths, and utf8 characters. Cannot start nor end with a / (forward slash). Cannot be a UUID.
metadatadynamic: User modifiable key-value store. Can use used for keeping references to another system of record for managing images.
require_signed_urlsbool: Indicates whether the image requires a signature token for the access.
urlstring: A URL to fetch an image from origin. Only needed when type is uploading from a URL.

Output properties

resultobject: The requested resource or collection of resources.
successbool: Whether the API call was successful.