Get Stream Details

client.Pipelines.Streams.Get(ctx, streamID, query) (*StreamGetResponse, error)

GET/accounts/{account_id}/pipelines/v1/streams/{stream_id}

Get Stream Details.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Pipelines WritePipelines Read

ParametersExpand Collapse

streamID string

Specifies the public ID of the stream.

maxLength32

minLength32

query StreamGetParams

AccountID param.Field[string]

Specifies the public ID of the account.

ReturnsExpand Collapse

type StreamGetResponse struct{…}

ID string

Indicates a unique identifier for this stream.

CreatedAt Time

formatdate-time

HTTP StreamGetResponseHTTP

Authentication bool

Indicates that authentication is required for the HTTP endpoint.

Enabled bool

Indicates that the HTTP endpoint is enabled.

CORS StreamGetResponseHTTPCORSoptional

Specifies the CORS options for the HTTP endpoint.

Origins []stringoptional

ModifiedAt Time

formatdate-time

Name string

Indicates the name of the Stream.

maxLength128

minLength1

Version int64

Indicates the current version of this stream.

WorkerBinding StreamGetResponseWorkerBinding

Enabled bool

Indicates that the worker binding is enabled.

Endpoint stringoptional

Indicates the endpoint URL of this stream.

formaturi

Format StreamGetResponseFormatoptional

One of the following:

type StreamGetResponseFormatJson struct{…}

Type StreamGetResponseFormatJsonType

DecimalEncoding StreamGetResponseFormatJsonDecimalEncodingoptional

One of the following:

const StreamGetResponseFormatJsonDecimalEncodingNumber StreamGetResponseFormatJsonDecimalEncoding = "number"

const StreamGetResponseFormatJsonDecimalEncodingString StreamGetResponseFormatJsonDecimalEncoding = "string"

const StreamGetResponseFormatJsonDecimalEncodingBytes StreamGetResponseFormatJsonDecimalEncoding = "bytes"

TimestampFormat StreamGetResponseFormatJsonTimestampFormatoptional

One of the following:

const StreamGetResponseFormatJsonTimestampFormatRfc3339 StreamGetResponseFormatJsonTimestampFormat = "rfc3339"

const StreamGetResponseFormatJsonTimestampFormatUnixMillis StreamGetResponseFormatJsonTimestampFormat = "unix_millis"

Unstructured booloptional

type StreamGetResponseFormatParquet struct{…}

Type StreamGetResponseFormatParquetType

Compression StreamGetResponseFormatParquetCompressionoptional

One of the following:

const StreamGetResponseFormatParquetCompressionUncompressed StreamGetResponseFormatParquetCompression = "uncompressed"

const StreamGetResponseFormatParquetCompressionSnappy StreamGetResponseFormatParquetCompression = "snappy"

const StreamGetResponseFormatParquetCompressionGzip StreamGetResponseFormatParquetCompression = "gzip"

const StreamGetResponseFormatParquetCompressionZstd StreamGetResponseFormatParquetCompression = "zstd"

const StreamGetResponseFormatParquetCompressionLz4 StreamGetResponseFormatParquetCompression = "lz4"

RowGroupBytes int64optional

formatint64

minimum0

Schema StreamGetResponseSchemaoptional

Fields []StreamGetResponseSchemaFieldoptional

One of the following:

type StreamGetResponseSchemaFieldsInt32 struct{…}

Type StreamGetResponseSchemaFieldsInt32Type

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

type StreamGetResponseSchemaFieldsInt64 struct{…}

Type StreamGetResponseSchemaFieldsInt64Type

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

type StreamGetResponseSchemaFieldsFloat32 struct{…}

Type StreamGetResponseSchemaFieldsFloat32Type

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

type StreamGetResponseSchemaFieldsFloat64 struct{…}

Type StreamGetResponseSchemaFieldsFloat64Type

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

type StreamGetResponseSchemaFieldsBool struct{…}

Type StreamGetResponseSchemaFieldsBoolType

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

type StreamGetResponseSchemaFieldsString struct{…}

Type StreamGetResponseSchemaFieldsStringType

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

type StreamGetResponseSchemaFieldsBinary struct{…}

Type StreamGetResponseSchemaFieldsBinaryType

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

type StreamGetResponseSchemaFieldsTimestamp struct{…}

Type StreamGetResponseSchemaFieldsTimestampType

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

Unit StreamGetResponseSchemaFieldsTimestampUnitoptional

One of the following:

const StreamGetResponseSchemaFieldsTimestampUnitSecond StreamGetResponseSchemaFieldsTimestampUnit = "second"

const StreamGetResponseSchemaFieldsTimestampUnitMillisecond StreamGetResponseSchemaFieldsTimestampUnit = "millisecond"

const StreamGetResponseSchemaFieldsTimestampUnitMicrosecond StreamGetResponseSchemaFieldsTimestampUnit = "microsecond"

const StreamGetResponseSchemaFieldsTimestampUnitNanosecond StreamGetResponseSchemaFieldsTimestampUnit = "nanosecond"

type StreamGetResponseSchemaFieldsJson struct{…}

Type StreamGetResponseSchemaFieldsJsonType

MetadataKey stringoptional

Name stringoptional

Required booloptional

SqlName stringoptional

type StreamGetResponseSchemaFieldsStruct struct{…}

type StreamGetResponseSchemaFieldsList struct{…}

Format StreamGetResponseSchemaFormatoptional

One of the following:

type StreamGetResponseSchemaFormatJson struct{…}

Type StreamGetResponseSchemaFormatJsonType

DecimalEncoding StreamGetResponseSchemaFormatJsonDecimalEncodingoptional

One of the following:

const StreamGetResponseSchemaFormatJsonDecimalEncodingNumber StreamGetResponseSchemaFormatJsonDecimalEncoding = "number"

const StreamGetResponseSchemaFormatJsonDecimalEncodingString StreamGetResponseSchemaFormatJsonDecimalEncoding = "string"

const StreamGetResponseSchemaFormatJsonDecimalEncodingBytes StreamGetResponseSchemaFormatJsonDecimalEncoding = "bytes"

TimestampFormat StreamGetResponseSchemaFormatJsonTimestampFormatoptional

One of the following:

const StreamGetResponseSchemaFormatJsonTimestampFormatRfc3339 StreamGetResponseSchemaFormatJsonTimestampFormat = "rfc3339"

const StreamGetResponseSchemaFormatJsonTimestampFormatUnixMillis StreamGetResponseSchemaFormatJsonTimestampFormat = "unix_millis"

Unstructured booloptional

type StreamGetResponseSchemaFormatParquet struct{…}

Type StreamGetResponseSchemaFormatParquetType

Compression StreamGetResponseSchemaFormatParquetCompressionoptional

One of the following:

const StreamGetResponseSchemaFormatParquetCompressionUncompressed StreamGetResponseSchemaFormatParquetCompression = "uncompressed"

const StreamGetResponseSchemaFormatParquetCompressionSnappy StreamGetResponseSchemaFormatParquetCompression = "snappy"

const StreamGetResponseSchemaFormatParquetCompressionGzip StreamGetResponseSchemaFormatParquetCompression = "gzip"

const StreamGetResponseSchemaFormatParquetCompressionZstd StreamGetResponseSchemaFormatParquetCompression = "zstd"

const StreamGetResponseSchemaFormatParquetCompressionLz4 StreamGetResponseSchemaFormatParquetCompression = "lz4"

RowGroupBytes int64optional

formatint64

minimum0

Inferred booloptional

Get Stream Details

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/pipelines"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  stream, err := client.Pipelines.Streams.Get(
    context.TODO(),
    "033e105f4ecef8ad9ca31a8372d0c353",
    pipelines.StreamGetParams{
      AccountID: cloudflare.F("0123105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", stream.ID)
}

{
  "result": {
    "id": "01234567890123457689012345678901",
    "created_at": "2019-12-27T18:11:19.117Z",
    "http": {
      "authentication": false,
      "enabled": true,
      "cors": {
        "origins": [
          "string"
        ]
      }
    },
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "my_stream",
    "version": 3,
    "worker_binding": {
      "enabled": true
    },
    "endpoint": "https://01234567890123457689012345678901.ingest.cloudflare.com/v1",
    "format": {
      "type": "json",
      "decimal_encoding": "number",
      "timestamp_format": "rfc3339",
      "unstructured": true
    },
    "schema": {
      "fields": [
        {
          "type": "int32",
          "metadata_key": "metadata_key",
          "name": "name",
          "required": true,
          "sql_name": "sql_name"
        }
      ],
      "format": {
        "type": "json",
        "decimal_encoding": "number",
        "timestamp_format": "rfc3339",
        "unstructured": true
      },
      "inferred": true
    }
  },
  "success": true
}

Returns Examples

{
  "result": {
    "id": "01234567890123457689012345678901",
    "created_at": "2019-12-27T18:11:19.117Z",
    "http": {
      "authentication": false,
      "enabled": true,
      "cors": {
        "origins": [
          "string"
        ]
      }
    },
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "my_stream",
    "version": 3,
    "worker_binding": {
      "enabled": true
    },
    "endpoint": "https://01234567890123457689012345678901.ingest.cloudflare.com/v1",
    "format": {
      "type": "json",
      "decimal_encoding": "number",
      "timestamp_format": "rfc3339",
      "unstructured": true
    },
    "schema": {
      "fields": [
        {
          "type": "int32",
          "metadata_key": "metadata_key",
          "name": "name",
          "required": true,
          "sql_name": "sql_name"
        }
      ],
      "format": {
        "type": "json",
        "decimal_encoding": "number",
        "timestamp_format": "rfc3339",
        "unstructured": true
      },
      "inferred": true
    }
  },
  "success": true
}