1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getFileComment
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 FileComment is a comment attached to a file by a user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleFileComment = filescom.getFileComment({
        id: 1,
        path: "path",
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_file_comment = filescom.get_file_comment(id=1,
        path="path")
    
    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.GetFileComment(ctx, &filescom.LookupFileCommentArgs{
    			Id:   1,
    			Path: "path",
    		}, 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 exampleFileComment = Filescom.GetFileComment.Invoke(new()
        {
            Id = 1,
            Path = "path",
        });
    
    });
    
    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.GetFileCommentArgs;
    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 exampleFileComment = FilescomFunctions.getFileComment(GetFileCommentArgs.builder()
                .id(1)
                .path("path")
                .build());
    
        }
    }
    
    variables:
      exampleFileComment:
        fn::invoke:
          function: filescom:getFileComment
          arguments:
            id: 1
            path: path
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getfilecomment" "exampleFileComment" {
      id   = 1
      path = "path"
    }
    

    Using getFileComment

    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 getFileComment(args: GetFileCommentArgs, opts?: InvokeOptions): Promise<GetFileCommentResult>
    function getFileCommentOutput(args: GetFileCommentOutputArgs, opts?: InvokeOutputOptions): Output<GetFileCommentResult>
    def get_file_comment(id: Optional[int] = None,
                         path: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetFileCommentResult
    def get_file_comment_output(id: pulumi.Input[Optional[int]] = None,
                         path: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetFileCommentResult]
    func LookupFileComment(ctx *Context, args *LookupFileCommentArgs, opts ...InvokeOption) (*LookupFileCommentResult, error)
    func LookupFileCommentOutput(ctx *Context, args *LookupFileCommentOutputArgs, opts ...InvokeOption) LookupFileCommentResultOutput

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

    public static class GetFileComment 
    {
        public static Task<GetFileCommentResult> InvokeAsync(GetFileCommentArgs args, InvokeOptions? opts = null)
        public static Output<GetFileCommentResult> Invoke(GetFileCommentInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetFileCommentResult> Invoke(GetFileCommentInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetFileCommentResult> getFileComment(GetFileCommentArgs args, InvokeOptions options)
    public static Output<GetFileCommentResult> getFileComment(GetFileCommentArgs args, InvokeOptions options)
    public static Output<GetFileCommentResult> getFileComment(GetFileCommentArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getFileComment:getFileComment
      arguments:
        # arguments dictionary
    data "filescom_get_file_comment" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    File Comment ID
    Path string
    File path.
    Id int
    File Comment ID
    Path string
    File path.
    id number
    File Comment ID
    path string
    File path.
    id Integer
    File Comment ID
    path String
    File path.
    id number
    File Comment ID
    path string
    File path.
    id int
    File Comment ID
    path str
    File path.
    id Number
    File Comment ID
    path String
    File path.

    getFileComment Result

    The following output properties are available:

    Body string
    Comment body.
    Id int
    File Comment ID
    Path string
    File path.
    Reactions object
    Reactions to this comment.
    Body string
    Comment body.
    Id int
    File Comment ID
    Path string
    File path.
    Reactions interface{}
    Reactions to this comment.
    body string
    Comment body.
    id number
    File Comment ID
    path string
    File path.
    reactions any
    Reactions to this comment.
    body String
    Comment body.
    id Integer
    File Comment ID
    path String
    File path.
    reactions Object
    Reactions to this comment.
    body string
    Comment body.
    id number
    File Comment ID
    path string
    File path.
    reactions any
    Reactions to this comment.
    body str
    Comment body.
    id int
    File Comment ID
    path str
    File path.
    reactions Any
    Reactions to this comment.
    body String
    Comment body.
    id Number
    File Comment ID
    path String
    File path.
    reactions Any
    Reactions to this comment.

    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