1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getMetadataCategory
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    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 = filescom.getMetadataCategory({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_metadata_category = filescom.get_metadata_category(id=1)
    
    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.GetMetadataCategory(ctx, &filescom.LookupMetadataCategoryArgs{
    			Id: 1,
    		}, nil)
    		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 = Filescom.GetMetadataCategory.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetMetadataCategoryArgs;
    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) {
            final var exampleMetadataCategory = FilescomFunctions.getMetadataCategory(GetMetadataCategoryArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleMetadataCategory:
        fn::invoke:
          function: filescom:getMetadataCategory
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getmetadatacategory" "exampleMetadataCategory" {
      id = 1
    }
    

    Using getMetadataCategory

    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 getMetadataCategory(args: GetMetadataCategoryArgs, opts?: InvokeOptions): Promise<GetMetadataCategoryResult>
    function getMetadataCategoryOutput(args: GetMetadataCategoryOutputArgs, opts?: InvokeOutputOptions): Output<GetMetadataCategoryResult>
    def get_metadata_category(id: Optional[int] = None,
                              opts: Optional[InvokeOptions] = None) -> GetMetadataCategoryResult
    def get_metadata_category_output(id: pulumi.Input[Optional[int]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetMetadataCategoryResult]
    func LookupMetadataCategory(ctx *Context, args *LookupMetadataCategoryArgs, opts ...InvokeOption) (*LookupMetadataCategoryResult, error)
    func LookupMetadataCategoryOutput(ctx *Context, args *LookupMetadataCategoryOutputArgs, opts ...InvokeOption) LookupMetadataCategoryResultOutput

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

    public static class GetMetadataCategory 
    {
        public static Task<GetMetadataCategoryResult> InvokeAsync(GetMetadataCategoryArgs args, InvokeOptions? opts = null)
        public static Output<GetMetadataCategoryResult> Invoke(GetMetadataCategoryInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetMetadataCategoryResult> Invoke(GetMetadataCategoryInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetMetadataCategoryResult> getMetadataCategory(GetMetadataCategoryArgs args, InvokeOptions options)
    public static Output<GetMetadataCategoryResult> getMetadataCategory(GetMetadataCategoryArgs args, InvokeOptions options)
    public static Output<GetMetadataCategoryResult> getMetadataCategory(GetMetadataCategoryArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getMetadataCategory:getMetadataCategory
      arguments:
        # arguments dictionary
    data "filescom_get_metadata_category" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    Metadata Category ID
    Id int
    Metadata Category ID
    id number
    Metadata Category ID
    id Integer
    Metadata Category ID
    id number
    Metadata Category ID
    id int
    Metadata Category ID
    id Number
    Metadata Category ID

    getMetadataCategory Result

    The following output properties are available:

    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.
    Id int
    Metadata Category ID
    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.
    Id int
    Metadata Category ID
    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.
    id number
    Metadata Category ID
    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.
    id Integer
    Metadata Category ID
    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.
    id number
    Metadata Category ID
    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.
    id int
    Metadata Category ID
    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.
    id Number
    Metadata Category ID
    name String
    Name of the metadata category.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial