getBucketObjectContents function

Future<GetBucketObjectContentsResult> getBucketObjectContents(GetBucketObjectContentsArgs args, { InvokeOptions? options, })

Gets existing object contents inside an existing bucket in Google Cloud Storage service (GCS). See the official documentation and API.

> Warning: The object content will be saved in the state, and visible to everyone who has access to the state file.

> Warning: This data source loads all object contents into memory. Limit the results with matchGlob or prefix.

Example Usage

Extract object base64 contents from objects:

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

const example = gcp.storage.getBucketObjectContents({
    bucket: "example-bucket",
    matchGlob: "example-{foo,bar}.json",
    prefix: "example",
});
export const base64EncodedJsonContents = example.then(example => example.bucketObjects.map(__item => __item.contentBase64));

import pulumi
import pulumi_gcp as gcp

example = gcp.storage.get_bucket_object_contents(bucket="example-bucket",
    match_glob="example-{foo,bar}.json",
    prefix="example")
pulumi.export("base64EncodedJsonContents", [__item.content_base64 for __item in example.bucket_objects])

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

return await Deployment.RunAsync(() =>
{
    var example = Gcp.Storage.GetBucketObjectContents.Invoke(new()
    {
        Bucket = "example-bucket",
        MatchGlob = "example-{foo,bar}.json",
        Prefix = "example",
    });

    return new Dictionary<string, object?>
    {
        ["base64EncodedJsonContents"] = example.Apply(getBucketObjectContentsResult => getBucketObjectContentsResult.BucketObjects).Select(__item => __item.ContentBase64).ToList(),
    };
});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := storage.GetBucketObjectContents(ctx, &storage.GetBucketObjectContentsArgs{
Bucket: "example-bucket",
MatchGlob: pulumi.StringRef("example-{foo,bar}.json"),
Prefix: pulumi.StringRef("example"),
}, nil);
if err != nil {
return err
}
ctx.Export("base64EncodedJsonContents", pulumi.StringArray(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:7,11-49)))
return nil
})
}

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

data "gcp_storage_getbucketobjectcontents" "example" {
  bucket     = "example-bucket"
  match_glob = "example-{foo,bar}.json"
  prefix     = "example"
}

output "base64EncodedJsonContents" {
  value = data.gcp_storage_getbucketobjectcontents.example.bucket_objects[*].content_base64
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.StorageFunctions;
import com.pulumi.gcp.storage.inputs.GetBucketObjectContentsArgs;
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 example = StorageFunctions.getBucketObjectContents(GetBucketObjectContentsArgs.builder()
            .bucket("example-bucket")
            .matchGlob("example-{foo,bar}.json")
            .prefix("example")
            .build());

        ctx.export("base64EncodedJsonContents", example.bucketObjects().stream().map(element -> element.contentBase64()).collect(toList()));
    }
}

args Arguments passed to this invoke. Arguments for getBucketObjectContents. options Invoke options controlling this call.

Implementation

Future<GetBucketObjectContentsResult> getBucketObjectContents(
  GetBucketObjectContentsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'gcp:storage/getBucketObjectContents:getBucketObjectContents',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetBucketObjectContentsResult.fromMap(result);
}