getHipObjectList

Strata Cloud Manager v0.4.3 (0.x), Mar 9 26

Viewing docs for Strata Cloud Manager v0.4.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-scm

Viewing docs for Strata Cloud Manager v0.4.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

// Fetch a list of all HIP Object objects in the Shared folder.
const allShared = scm.getHipObjectList({
    folder: "All",
});
export const hipObjectsListAllShared = allShared.then(allShared => allShared.datas);
// Example of using pagination to get the first 10 HIP objects.
const paginated = scm.getHipObjectList({
    folder: "All",
    limit: 10,
    offset: 0,
});
export const hipObjectsListPaginated = paginated.then(paginated => paginated.datas);

import pulumi
import pulumi_scm as scm

# Fetch a list of all HIP Object objects in the Shared folder.
all_shared = scm.get_hip_object_list(folder="All")
pulumi.export("hipObjectsListAllShared", all_shared.datas)
# Example of using pagination to get the first 10 HIP objects.
paginated = scm.get_hip_object_list(folder="All",
    limit=10,
    offset=0)
pulumi.export("hipObjectsListPaginated", paginated.datas)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Fetch a list of all HIP Object objects in the Shared folder.
		allShared, err := scm.GetHipObjectList(ctx, &scm.GetHipObjectListArgs{
			Folder: pulumi.StringRef("All"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("hipObjectsListAllShared", allShared.Datas)
		// Example of using pagination to get the first 10 HIP objects.
		paginated, err := scm.GetHipObjectList(ctx, &scm.GetHipObjectListArgs{
			Folder: pulumi.StringRef("All"),
			Limit:  pulumi.IntRef(10),
			Offset: pulumi.IntRef(0),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("hipObjectsListPaginated", paginated.Datas)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    // Fetch a list of all HIP Object objects in the Shared folder.
    var allShared = Scm.GetHipObjectList.Invoke(new()
    {
        Folder = "All",
    });

    // Example of using pagination to get the first 10 HIP objects.
    var paginated = Scm.GetHipObjectList.Invoke(new()
    {
        Folder = "All",
        Limit = 10,
        Offset = 0,
    });

    return new Dictionary<string, object?>
    {
        ["hipObjectsListAllShared"] = allShared.Apply(getHipObjectListResult => getHipObjectListResult.Datas),
        ["hipObjectsListPaginated"] = paginated.Apply(getHipObjectListResult => getHipObjectListResult.Datas),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetHipObjectListArgs;
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) {
        // Fetch a list of all HIP Object objects in the Shared folder.
        final var allShared = ScmFunctions.getHipObjectList(GetHipObjectListArgs.builder()
            .folder("All")
            .build());

        ctx.export("hipObjectsListAllShared", allShared.datas());
        // Example of using pagination to get the first 10 HIP objects.
        final var paginated = ScmFunctions.getHipObjectList(GetHipObjectListArgs.builder()
            .folder("All")
            .limit(10)
            .offset(0)
            .build());

        ctx.export("hipObjectsListPaginated", paginated.datas());
    }
}

variables:
  # Fetch a list of all HIP Object objects in the Shared folder.
  allShared:
    fn::invoke:
      function: scm:getHipObjectList
      arguments:
        folder: All
  # Example of using pagination to get the first 10 HIP objects.
  paginated:
    fn::invoke:
      function: scm:getHipObjectList
      arguments:
        folder: All
        limit: 10
        offset: 0
outputs:
  # Output the raw list of all HIP Object objects.
  hipObjectsListAllShared: ${allShared.datas}
  hipObjectsListPaginated: ${paginated.datas}

Using getHipObjectList

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 getHipObjectList(args: GetHipObjectListArgs, opts?: InvokeOptions): Promise<GetHipObjectListResult>
function getHipObjectListOutput(args: GetHipObjectListOutputArgs, opts?: InvokeOptions): Output<GetHipObjectListResult>

def get_hip_object_list(device: Optional[str] = None,
                        folder: Optional[str] = None,
                        limit: Optional[int] = None,
                        name: Optional[str] = None,
                        offset: Optional[int] = None,
                        snippet: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetHipObjectListResult
def get_hip_object_list_output(device: Optional[pulumi.Input[str]] = None,
                        folder: Optional[pulumi.Input[str]] = None,
                        limit: Optional[pulumi.Input[int]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        offset: Optional[pulumi.Input[int]] = None,
                        snippet: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetHipObjectListResult]

func GetHipObjectList(ctx *Context, args *GetHipObjectListArgs, opts ...InvokeOption) (*GetHipObjectListResult, error)
func GetHipObjectListOutput(ctx *Context, args *GetHipObjectListOutputArgs, opts ...InvokeOption) GetHipObjectListResultOutput

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

public static class GetHipObjectList 
{
    public static Task<GetHipObjectListResult> InvokeAsync(GetHipObjectListArgs args, InvokeOptions? opts = null)
    public static Output<GetHipObjectListResult> Invoke(GetHipObjectListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHipObjectListResult> getHipObjectList(GetHipObjectListArgs args, InvokeOptions options)
public static Output<GetHipObjectListResult> getHipObjectList(GetHipObjectListArgs args, InvokeOptions options)

fn::invoke:
  function: scm:index/getHipObjectList:getHipObjectList
  arguments:
    # arguments dictionary

The following arguments are supported:

Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Integer: The max number of items to return. Default: 200.
name String: The name of the item.
offset Integer: The offset of the first item to return.
snippet String: The snippet of the item.

device string: The device of the item.
folder string: The folder of the item. Default: Shared.
limit number: The max number of items to return. Default: 200.
name string: The name of the item.
offset number: The offset of the first item to return.
snippet string: The snippet of the item.

device str: The device of the item.
folder str: The folder of the item. Default: Shared.
limit int: The max number of items to return. Default: 200.
name str: The name of the item.
offset int: The offset of the first item to return.
snippet str: The snippet of the item.

device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Number: The max number of items to return. Default: 200.
name String: The name of the item.
offset Number: The offset of the first item to return.
snippet String: The snippet of the item.