## List Sinks `client.Pipelines.Sinks.List(ctx, params) (*V4PagePaginationArray[SinkListResponse], error)` **get** `/accounts/{account_id}/pipelines/v1/sinks` List/Filter Sinks in Account. ### Parameters - `params SinkListParams` - `AccountID param.Field[string]` Path param: Specifies the public ID of the account. - `Page param.Field[float64]` Query param - `PerPage param.Field[float64]` Query param - `PipelineID param.Field[string]` Query param ### Returns - `type SinkListResponse struct{…}` - `ID string` Indicates a unique identifier for this sink. - `CreatedAt Time` - `ModifiedAt Time` - `Name string` Defines the name of the Sink. - `Type SinkListResponseType` Specifies the type of sink. - `const SinkListResponseTypeR2 SinkListResponseType = "r2"` - `const SinkListResponseTypeR2DataCatalog SinkListResponseType = "r2_data_catalog"` - `Config SinkListResponseConfig` Defines the configuration of the R2 Sink. - `type SinkListResponseConfigCloudflarePipelinesR2TablePublic struct{…}` R2 Sink public configuration. - `AccountID string` Cloudflare Account ID for the bucket - `Bucket string` R2 Bucket to write to - `FileNaming SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNaming` Controls filename prefix/suffix and strategy. - `Prefix string` The prefix to use in file name. i.e prefix-.parquet - `Strategy SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy` Filename generation strategy. - `const SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategySerial SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "serial"` - `const SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUUID SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "uuid"` - `const SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUUIDV7 SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "uuid_v7"` - `const SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUlid SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "ulid"` - `Suffix string` This will overwrite the default file suffix. i.e .parquet, use with caution - `Jurisdiction string` Jurisdiction this bucket is hosted in - `Partitioning SinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioning` Data-layout partitioning for sinks. - `TimePattern string` The pattern of the date string - `Path string` Subpath within the bucket to write to - `RollingPolicy SinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy` Rolling policy for file sinks (when & why to close a file and open a new one). - `FileSizeBytes int64` Files will be rolled after reaching this number of bytes - `InactivitySeconds int64` Number of seconds of inactivity to wait before rolling over to a new file - `IntervalSeconds int64` Number of seconds to wait before rolling over to a new file - `type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublic struct{…}` R2 Data Catalog Sink public configuration. - `AccountID string` Cloudflare Account ID - `Bucket string` The R2 Bucket that hosts this catalog - `TableName string` Table name - `Namespace string` Table namespace - `RollingPolicy SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy` Rolling policy for file sinks (when & why to close a file and open a new one). - `FileSizeBytes int64` Files will be rolled after reaching this number of bytes - `InactivitySeconds int64` Number of seconds of inactivity to wait before rolling over to a new file - `IntervalSeconds int64` Number of seconds to wait before rolling over to a new file - `Format SinkListResponseFormat` - `type SinkListResponseFormatJson struct{…}` - `Type SinkListResponseFormatJsonType` - `const SinkListResponseFormatJsonTypeJson SinkListResponseFormatJsonType = "json"` - `DecimalEncoding SinkListResponseFormatJsonDecimalEncoding` - `const SinkListResponseFormatJsonDecimalEncodingNumber SinkListResponseFormatJsonDecimalEncoding = "number"` - `const SinkListResponseFormatJsonDecimalEncodingString SinkListResponseFormatJsonDecimalEncoding = "string"` - `const SinkListResponseFormatJsonDecimalEncodingBytes SinkListResponseFormatJsonDecimalEncoding = "bytes"` - `TimestampFormat SinkListResponseFormatJsonTimestampFormat` - `const SinkListResponseFormatJsonTimestampFormatRfc3339 SinkListResponseFormatJsonTimestampFormat = "rfc3339"` - `const SinkListResponseFormatJsonTimestampFormatUnixMillis SinkListResponseFormatJsonTimestampFormat = "unix_millis"` - `Unstructured bool` - `type SinkListResponseFormatParquet struct{…}` - `Type SinkListResponseFormatParquetType` - `const SinkListResponseFormatParquetTypeParquet SinkListResponseFormatParquetType = "parquet"` - `Compression SinkListResponseFormatParquetCompression` - `const SinkListResponseFormatParquetCompressionUncompressed SinkListResponseFormatParquetCompression = "uncompressed"` - `const SinkListResponseFormatParquetCompressionSnappy SinkListResponseFormatParquetCompression = "snappy"` - `const SinkListResponseFormatParquetCompressionGzip SinkListResponseFormatParquetCompression = "gzip"` - `const SinkListResponseFormatParquetCompressionZstd SinkListResponseFormatParquetCompression = "zstd"` - `const SinkListResponseFormatParquetCompressionLz4 SinkListResponseFormatParquetCompression = "lz4"` - `RowGroupBytes int64` - `Schema SinkListResponseSchema` - `Fields []SinkListResponseSchemaField` - `type SinkListResponseSchemaFieldsInt32 struct{…}` - `Type SinkListResponseSchemaFieldsInt32Type` - `const SinkListResponseSchemaFieldsInt32TypeInt32 SinkListResponseSchemaFieldsInt32Type = "int32"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `type SinkListResponseSchemaFieldsInt64 struct{…}` - `Type SinkListResponseSchemaFieldsInt64Type` - `const SinkListResponseSchemaFieldsInt64TypeInt64 SinkListResponseSchemaFieldsInt64Type = "int64"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `type SinkListResponseSchemaFieldsFloat32 struct{…}` - `Type SinkListResponseSchemaFieldsFloat32Type` - `const SinkListResponseSchemaFieldsFloat32TypeFloat32 SinkListResponseSchemaFieldsFloat32Type = "float32"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `type SinkListResponseSchemaFieldsFloat64 struct{…}` - `Type SinkListResponseSchemaFieldsFloat64Type` - `const SinkListResponseSchemaFieldsFloat64TypeFloat64 SinkListResponseSchemaFieldsFloat64Type = "float64"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `type SinkListResponseSchemaFieldsBool struct{…}` - `Type SinkListResponseSchemaFieldsBoolType` - `const SinkListResponseSchemaFieldsBoolTypeBool SinkListResponseSchemaFieldsBoolType = "bool"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `type SinkListResponseSchemaFieldsString struct{…}` - `Type SinkListResponseSchemaFieldsStringType` - `const SinkListResponseSchemaFieldsStringTypeString SinkListResponseSchemaFieldsStringType = "string"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `type SinkListResponseSchemaFieldsBinary struct{…}` - `Type SinkListResponseSchemaFieldsBinaryType` - `const SinkListResponseSchemaFieldsBinaryTypeBinary SinkListResponseSchemaFieldsBinaryType = "binary"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `type SinkListResponseSchemaFieldsTimestamp struct{…}` - `Type SinkListResponseSchemaFieldsTimestampType` - `const SinkListResponseSchemaFieldsTimestampTypeTimestamp SinkListResponseSchemaFieldsTimestampType = "timestamp"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `Unit SinkListResponseSchemaFieldsTimestampUnit` - `const SinkListResponseSchemaFieldsTimestampUnitSecond SinkListResponseSchemaFieldsTimestampUnit = "second"` - `const SinkListResponseSchemaFieldsTimestampUnitMillisecond SinkListResponseSchemaFieldsTimestampUnit = "millisecond"` - `const SinkListResponseSchemaFieldsTimestampUnitMicrosecond SinkListResponseSchemaFieldsTimestampUnit = "microsecond"` - `const SinkListResponseSchemaFieldsTimestampUnitNanosecond SinkListResponseSchemaFieldsTimestampUnit = "nanosecond"` - `type SinkListResponseSchemaFieldsJson struct{…}` - `Type SinkListResponseSchemaFieldsJsonType` - `const SinkListResponseSchemaFieldsJsonTypeJson SinkListResponseSchemaFieldsJsonType = "json"` - `MetadataKey string` - `Name string` - `Required bool` - `SqlName string` - `type SinkListResponseSchemaFieldsStruct struct{…}` - `type SinkListResponseSchemaFieldsList struct{…}` - `Format SinkListResponseSchemaFormat` - `type SinkListResponseSchemaFormatJson struct{…}` - `Type SinkListResponseSchemaFormatJsonType` - `const SinkListResponseSchemaFormatJsonTypeJson SinkListResponseSchemaFormatJsonType = "json"` - `DecimalEncoding SinkListResponseSchemaFormatJsonDecimalEncoding` - `const SinkListResponseSchemaFormatJsonDecimalEncodingNumber SinkListResponseSchemaFormatJsonDecimalEncoding = "number"` - `const SinkListResponseSchemaFormatJsonDecimalEncodingString SinkListResponseSchemaFormatJsonDecimalEncoding = "string"` - `const SinkListResponseSchemaFormatJsonDecimalEncodingBytes SinkListResponseSchemaFormatJsonDecimalEncoding = "bytes"` - `TimestampFormat SinkListResponseSchemaFormatJsonTimestampFormat` - `const SinkListResponseSchemaFormatJsonTimestampFormatRfc3339 SinkListResponseSchemaFormatJsonTimestampFormat = "rfc3339"` - `const SinkListResponseSchemaFormatJsonTimestampFormatUnixMillis SinkListResponseSchemaFormatJsonTimestampFormat = "unix_millis"` - `Unstructured bool` - `type SinkListResponseSchemaFormatParquet struct{…}` - `Type SinkListResponseSchemaFormatParquetType` - `const SinkListResponseSchemaFormatParquetTypeParquet SinkListResponseSchemaFormatParquetType = "parquet"` - `Compression SinkListResponseSchemaFormatParquetCompression` - `const SinkListResponseSchemaFormatParquetCompressionUncompressed SinkListResponseSchemaFormatParquetCompression = "uncompressed"` - `const SinkListResponseSchemaFormatParquetCompressionSnappy SinkListResponseSchemaFormatParquetCompression = "snappy"` - `const SinkListResponseSchemaFormatParquetCompressionGzip SinkListResponseSchemaFormatParquetCompression = "gzip"` - `const SinkListResponseSchemaFormatParquetCompressionZstd SinkListResponseSchemaFormatParquetCompression = "zstd"` - `const SinkListResponseSchemaFormatParquetCompressionLz4 SinkListResponseSchemaFormatParquetCompression = "lz4"` - `RowGroupBytes int64` - `Inferred bool` ### Example ```go 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"), ) page, err := client.Pipelines.Sinks.List(context.TODO(), pipelines.SinkListParams{ AccountID: cloudflare.F("0123105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "result": [ { "id": "01234567890123457689012345678901", "created_at": "2019-12-27T18:11:19.117Z", "modified_at": "2019-12-27T18:11:19.117Z", "name": "my_sink", "type": "r2", "config": { "account_id": "account_id", "bucket": "bucket", "file_naming": { "prefix": "prefix", "strategy": "serial", "suffix": "suffix" }, "jurisdiction": "jurisdiction", "partitioning": { "time_pattern": "year=%Y/month=%m/day=%d/hour=%H" }, "path": "path", "rolling_policy": { "file_size_bytes": 0, "inactivity_seconds": 1, "interval_seconds": 1 } }, "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 } } ], "result_info": { "count": 1, "page": 0, "per_page": 10, "total_count": 1 }, "success": true } ```