1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. getColumns
honeycombio 0.32.0 published on Monday, Apr 7, 2025 by honeycombio

honeycombio.getColumns

Explore with Pulumi AI

# Data Source: honeycombio.getColumns

The columns data source allows the columns of a dataset to be retrieved.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";

const config = new pulumi.Config();
const dataset = config.require("dataset");
const all = honeycombio.getColumns({
    dataset: dataset,
});
const foo = honeycombio.getColumns({
    dataset: dataset,
    startsWith: "foo_",
});
Copy
import pulumi
import pulumi_honeycombio as honeycombio

config = pulumi.Config()
dataset = config.require("dataset")
all = honeycombio.get_columns(dataset=dataset)
foo = honeycombio.get_columns(dataset=dataset,
    starts_with="foo_")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		dataset := cfg.Require("dataset")
		_, err := honeycombio.GetColumns(ctx, &honeycombio.GetColumnsArgs{
			Dataset: dataset,
		}, nil)
		if err != nil {
			return err
		}
		_, err = honeycombio.GetColumns(ctx, &honeycombio.GetColumnsArgs{
			Dataset:    dataset,
			StartsWith: pulumi.StringRef("foo_"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var dataset = config.Require("dataset");
    var all = Honeycombio.GetColumns.Invoke(new()
    {
        Dataset = dataset,
    });

    var foo = Honeycombio.GetColumns.Invoke(new()
    {
        Dataset = dataset,
        StartsWith = "foo_",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetColumnsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var dataset = config.get("dataset");
        final var all = HoneycombioFunctions.getColumns(GetColumnsArgs.builder()
            .dataset(dataset)
            .build());

        final var foo = HoneycombioFunctions.getColumns(GetColumnsArgs.builder()
            .dataset(dataset)
            .startsWith("foo_")
            .build());

    }
}
Copy
configuration:
  dataset:
    type: string
variables:
  all:
    fn::invoke:
      function: honeycombio:getColumns
      arguments:
        dataset: ${dataset}
  foo:
    fn::invoke:
      function: honeycombio:getColumns
      arguments:
        dataset: ${dataset}
        startsWith: foo_
Copy

Using getColumns

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getColumns(args: GetColumnsArgs, opts?: InvokeOptions): Promise<GetColumnsResult>
function getColumnsOutput(args: GetColumnsOutputArgs, opts?: InvokeOptions): Output<GetColumnsResult>
Copy
def get_columns(dataset: Optional[str] = None,
                id: Optional[str] = None,
                starts_with: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetColumnsResult
def get_columns_output(dataset: Optional[pulumi.Input[str]] = None,
                id: Optional[pulumi.Input[str]] = None,
                starts_with: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetColumnsResult]
Copy
func GetColumns(ctx *Context, args *GetColumnsArgs, opts ...InvokeOption) (*GetColumnsResult, error)
func GetColumnsOutput(ctx *Context, args *GetColumnsOutputArgs, opts ...InvokeOption) GetColumnsResultOutput
Copy

> Note: This function is named GetColumns in the Go SDK.

public static class GetColumns 
{
    public static Task<GetColumnsResult> InvokeAsync(GetColumnsArgs args, InvokeOptions? opts = null)
    public static Output<GetColumnsResult> Invoke(GetColumnsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetColumnsResult> getColumns(GetColumnsArgs args, InvokeOptions options)
public static Output<GetColumnsResult> getColumns(GetColumnsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: honeycombio:index/getColumns:getColumns
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Dataset This property is required. string
The dataset to retrieve the columns list from
Id string
StartsWith string
Only return columns starting with the given value.
Dataset This property is required. string
The dataset to retrieve the columns list from
Id string
StartsWith string
Only return columns starting with the given value.
dataset This property is required. String
The dataset to retrieve the columns list from
id String
startsWith String
Only return columns starting with the given value.
dataset This property is required. string
The dataset to retrieve the columns list from
id string
startsWith string
Only return columns starting with the given value.
dataset This property is required. str
The dataset to retrieve the columns list from
id str
starts_with str
Only return columns starting with the given value.
dataset This property is required. String
The dataset to retrieve the columns list from
id String
startsWith String
Only return columns starting with the given value.

getColumns Result

The following output properties are available:

Dataset string
Id string
Names List<string>
a list of all the column names found in the dataset
StartsWith string
Dataset string
Id string
Names []string
a list of all the column names found in the dataset
StartsWith string
dataset String
id String
names List<String>
a list of all the column names found in the dataset
startsWith String
dataset string
id string
names string[]
a list of all the column names found in the dataset
startsWith string
dataset str
id str
names Sequence[str]
a list of all the column names found in the dataset
starts_with str
dataset String
id String
names List<String>
a list of all the column names found in the dataset
startsWith String

Package Details

Repository
honeycombio honeycombio/terraform-provider-honeycombio
License
Notes
This Pulumi package is based on the honeycombio Terraform Provider.