Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. MetadataCategory
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.MetadataCategory

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A MetadataCategory defines a reusable set of Custom Metadata rules that can be assigned to folders

    via a folder behavior. Each category specifies named metadata keys with optional allowed-value

    constraints, and a set of default columns to display in the UI.

    If a key’s allowedValues array is empty, it is treated as a free-form text field.

    If the array is non-empty, the key is constrained to those values in the Web UI.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleMetadataCategory = new filescom.MetadataCategory("example_metadata_category", {
    name: "Approval Workflow",
    defaultColumns: ["Approval Status"],
});

    import pulumi
import pulumi_filescom as filescom

example_metadata_category = filescom.MetadataCategory("example_metadata_category",
    name="Approval Workflow",
    default_columns=["Approval Status"])

    package main

import (
	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filescom.NewMetadataCategory(ctx, "example_metadata_category", &filescom.MetadataCategoryArgs{
			Name: pulumi.String("Approval Workflow"),
			DefaultColumns: pulumi.StringArray{
				pulumi.String("Approval Status"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;

return await Deployment.RunAsync(() => 
{
    var exampleMetadataCategory = new Filescom.MetadataCategory("example_metadata_category", new()
    {
        Name = "Approval Workflow",
        DefaultColumns = new[]
        {
            "Approval Status",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.MetadataCategory;
import com.pulumi.filescom.MetadataCategoryArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var exampleMetadataCategory = new MetadataCategory("exampleMetadataCategory", MetadataCategoryArgs.builder()
            .name("Approval Workflow")
            .defaultColumns("Approval Status")
            .build());

    }
}

    resources:
  exampleMetadataCategory:
    type: filescom:MetadataCategory
    name: example_metadata_category
    properties:
      name: Approval Workflow
      defaultColumns:
        - Approval Status

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

resource "filescom_metadatacategory" "example_metadata_category" {
  name            = "Approval Workflow"
  default_columns = ["Approval Status"]
}

    Create MetadataCategory Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MetadataCategory(name: string, args?: MetadataCategoryArgs, opts?: CustomResourceOptions);
    @overload
def MetadataCategory(resource_name: str,
                     args: Optional[MetadataCategoryArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def MetadataCategory(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     default_columns: Optional[Sequence[str]] = None,
                     name: Optional[str] = None)
    func NewMetadataCategory(ctx *Context, name string, args *MetadataCategoryArgs, opts ...ResourceOption) (*MetadataCategory, error)
    public MetadataCategory(string name, MetadataCategoryArgs? args = null, CustomResourceOptions? opts = null)
    public MetadataCategory(String name, MetadataCategoryArgs args)
public MetadataCategory(String name, MetadataCategoryArgs args, CustomResourceOptions options)

    type: filescom:MetadataCategory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "filescom_metadata_category" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args MetadataCategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MetadataCategoryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MetadataCategoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetadataCategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetadataCategoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var metadataCategoryResource = new Filescom.MetadataCategory("metadataCategoryResource", new()
{
    DefaultColumns = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := filescom.NewMetadataCategory(ctx, "metadataCategoryResource", &filescom.MetadataCategoryArgs{
	DefaultColumns: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    resource "filescom_metadata_category" "metadataCategoryResource" {
  lifecycle {
    create_before_destroy = true
  }
  default_columns = ["string"]
  name            = "string"
}

    var metadataCategoryResource = new MetadataCategory("metadataCategoryResource", MetadataCategoryArgs.builder()
    .defaultColumns("string")
    .name("string")
    .build());

    metadata_category_resource = filescom.MetadataCategory("metadataCategoryResource",
    default_columns=["string"],
    name="string")

    const metadataCategoryResource = new filescom.MetadataCategory("metadataCategoryResource", {
    defaultColumns: ["string"],
    name: "string",
});

    type: filescom:MetadataCategory
properties:
    defaultColumns:
        - string
    name: string

    MetadataCategory Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The MetadataCategory resource accepts the following input properties:

    DefaultColumns List<string>
    Metadata keys that should appear as columns in the UI by default.
    Name string
    Name of the metadata category.
    DefaultColumns []string
    Metadata keys that should appear as columns in the UI by default.
    Name string
    Name of the metadata category.
    default_columns list(string)
    Metadata keys that should appear as columns in the UI by default.
    name string
    Name of the metadata category.
    defaultColumns List<String>
    Metadata keys that should appear as columns in the UI by default.
    name String
    Name of the metadata category.
    defaultColumns string[]
    Metadata keys that should appear as columns in the UI by default.
    name string
    Name of the metadata category.
    default_columns Sequence[str]
    Metadata keys that should appear as columns in the UI by default.
    name str
    Name of the metadata category.
    defaultColumns List<String>
    Metadata keys that should appear as columns in the UI by default.
    name String
    Name of the metadata category.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MetadataCategory resource produces the following output properties:

    Definitions Dictionary<string, ImmutableArray<string>>
    Map of key names to arrays of allowed values. An empty array means free-form text.
    Id string
    The provider-assigned unique ID for this managed resource.
    Definitions map[string][]string
    Map of key names to arrays of allowed values. An empty array means free-form text.
    Id string
    The provider-assigned unique ID for this managed resource.
    definitions map(list(string))
    Map of key names to arrays of allowed values. An empty array means free-form text.
    id string
    The provider-assigned unique ID for this managed resource.
    definitions Map<String,List<String>>
    Map of key names to arrays of allowed values. An empty array means free-form text.
    id String
    The provider-assigned unique ID for this managed resource.
    definitions {[key: string]: string[]}
    Map of key names to arrays of allowed values. An empty array means free-form text.
    id string
    The provider-assigned unique ID for this managed resource.
    definitions Mapping[str, Sequence[str]]
    Map of key names to arrays of allowed values. An empty array means free-form text.
    id str
    The provider-assigned unique ID for this managed resource.
    definitions Map<List<String>>
    Map of key names to arrays of allowed values. An empty array means free-form text.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing MetadataCategory Resource

    Get an existing MetadataCategory resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MetadataCategoryState, opts?: CustomResourceOptions): MetadataCategory
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_columns: Optional[Sequence[str]] = None,
        definitions: Optional[Mapping[str, Sequence[str]]] = None,
        name: Optional[str] = None) -> MetadataCategory
    func GetMetadataCategory(ctx *Context, name string, id IDInput, state *MetadataCategoryState, opts ...ResourceOption) (*MetadataCategory, error)
    public static MetadataCategory Get(string name, Input<string> id, MetadataCategoryState? state, CustomResourceOptions? opts = null)
    public static MetadataCategory get(String name, Output<String> id, MetadataCategoryState state, CustomResourceOptions options)
    resources:  _:    type: filescom:MetadataCategory    get:      id: ${id}
    import {
  to = filescom_metadata_category.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DefaultColumns List<string>
    Metadata keys that should appear as columns in the UI by default.
    Definitions Dictionary<string, ImmutableArray<string>>
    Map of key names to arrays of allowed values. An empty array means free-form text.
    Name string
    Name of the metadata category.
    DefaultColumns []string
    Metadata keys that should appear as columns in the UI by default.
    Definitions map[string][]string
    Map of key names to arrays of allowed values. An empty array means free-form text.
    Name string
    Name of the metadata category.
    default_columns list(string)
    Metadata keys that should appear as columns in the UI by default.
    definitions map(list(string))
    Map of key names to arrays of allowed values. An empty array means free-form text.
    name string
    Name of the metadata category.
    defaultColumns List<String>
    Metadata keys that should appear as columns in the UI by default.
    definitions Map<String,List<String>>
    Map of key names to arrays of allowed values. An empty array means free-form text.
    name String
    Name of the metadata category.
    defaultColumns string[]
    Metadata keys that should appear as columns in the UI by default.
    definitions {[key: string]: string[]}
    Map of key names to arrays of allowed values. An empty array means free-form text.
    name string
    Name of the metadata category.
    default_columns Sequence[str]
    Metadata keys that should appear as columns in the UI by default.
    definitions Mapping[str, Sequence[str]]
    Map of key names to arrays of allowed values. An empty array means free-form text.
    name str
    Name of the metadata category.
    defaultColumns List<String>
    Metadata keys that should appear as columns in the UI by default.
    definitions Map<List<String>>
    Map of key names to arrays of allowed values. An empty array means free-form text.
    name String
    Name of the metadata category.

    Import

    The pulumi import command can be used, for example:

    Metadata Categories can be imported by specifying the id.

    $ pulumi import filescom:index/metadataCategory:MetadataCategory example_metadata_category 1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial