← All packages

Oracle Cloud Infrastructure

Pulumi Official

Package maintained by Pulumi

v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

Source code

getObjects

This data source provides the list of Objects in Oracle Cloud Infrastructure Object Storage service.

Lists the objects in a bucket. By default, ListObjects returns object names only. See the fields parameter for other fields that you can optionally include in ListObjects response.

ListObjects returns at most 1000 objects. To paginate through more objects, use the returned ’nextStartWith' value with the ‘start’ parameter. To filter which objects ListObjects returns, use the ‘start’ and ’end’ parameters.

To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testObjects = Output.Create(Oci.ObjectStorage.GetObjects.InvokeAsync(new Oci.ObjectStorage.GetObjectsArgs
        {
            Bucket = @var.Object_bucket,
            Namespace = @var.Object_namespace,
            Delimiter = @var.Object_delimiter,
            End = @var.Object_end,
            Fields = @var.Object_fields,
            Prefix = @var.Object_prefix,
            Start = @var.Object_start,
            StartAfter = @var.Object_start_after,
        }));
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ObjectStorage.GetObjects(ctx, &objectstorage.GetObjectsArgs{
			Bucket:     _var.Object_bucket,
			Namespace:  _var.Object_namespace,
			Delimiter:  pulumi.StringRef(_var.Object_delimiter),
			End:        pulumi.StringRef(_var.Object_end),
			Fields:     _var.Object_fields,
			Prefix:     pulumi.StringRef(_var.Object_prefix),
			Start:      pulumi.StringRef(_var.Object_start),
			StartAfter: pulumi.StringRef(_var.Object_start_after),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_objects = oci.ObjectStorage.get_objects(bucket=var["object_bucket"],
    namespace=var["object_namespace"],
    delimiter=var["object_delimiter"],
    end=var["object_end"],
    fields=var["object_fields"],
    prefix=var["object_prefix"],
    start=var["object_start"],
    start_after=var["object_start_after"])

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

const testObjects = oci.ObjectStorage.getObjects({
    bucket: _var.object_bucket,
    namespace: _var.object_namespace,
    delimiter: _var.object_delimiter,
    end: _var.object_end,
    fields: _var.object_fields,
    prefix: _var.object_prefix,
    start: _var.object_start,
    startAfter: _var.object_start_after,
});

Coming soon!

Using getObjects

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 getObjects(args: GetObjectsArgs, opts?: InvokeOptions): Promise<GetObjectsResult>
function getObjectsOutput(args: GetObjectsOutputArgs, opts?: InvokeOptions): Output<GetObjectsResult>

def get_objects(bucket: Optional[str] = None,
                delimiter: Optional[str] = None,
                end: Optional[str] = None,
                filters: Optional[Sequence[_objectstorage.GetObjectsFilter]] = None,
                namespace: Optional[str] = None,
                prefix: Optional[str] = None,
                start: Optional[str] = None,
                start_after: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetObjectsResult
def get_objects_output(bucket: Optional[pulumi.Input[str]] = None,
                delimiter: Optional[pulumi.Input[str]] = None,
                end: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_objectstorage.GetObjectsFilterArgs]]]] = None,
                namespace: Optional[pulumi.Input[str]] = None,
                prefix: Optional[pulumi.Input[str]] = None,
                start: Optional[pulumi.Input[str]] = None,
                start_after: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetObjectsResult]

func GetObjects(ctx *Context, args *GetObjectsArgs, opts ...InvokeOption) (*GetObjectsResult, error)
func GetObjectsOutput(ctx *Context, args *GetObjectsOutputArgs, opts ...InvokeOption) GetObjectsResultOutput

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

public static class GetObjects 
{
    public static Task<GetObjectsResult> InvokeAsync(GetObjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetObjectsResult> Invoke(GetObjectsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetObjectsResult> getObjects(GetObjectsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:ObjectStorage/getObjects:getObjects
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Bucket string: The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
Namespace string: The Object Storage namespace used for the request.
Delimiter string: When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
End string: Object names returned by a list query must be strictly less than this parameter.
Filters List<GetObjectsFilter>
Prefix string: The string to use for matching against the start of object names in a list query.
Start string: Object names returned by a list query must be greater or equal to this parameter.
StartAfter string: Object names returned by a list query must be greater than this parameter.

Bucket string: The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
Namespace string: The Object Storage namespace used for the request.
Delimiter string: When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
End string: Object names returned by a list query must be strictly less than this parameter.
Filters []GetObjectsFilter
Prefix string: The string to use for matching against the start of object names in a list query.
Start string: Object names returned by a list query must be greater or equal to this parameter.
StartAfter string: Object names returned by a list query must be greater than this parameter.

bucket String: The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
namespace String: The Object Storage namespace used for the request.
delimiter String: When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
end String: Object names returned by a list query must be strictly less than this parameter.
filters List<GetObjectsFilter>
prefix String: The string to use for matching against the start of object names in a list query.
start String: Object names returned by a list query must be greater or equal to this parameter.
startAfter String: Object names returned by a list query must be greater than this parameter.

bucket string: The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
namespace string: The Object Storage namespace used for the request.
delimiter string: When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
end string: Object names returned by a list query must be strictly less than this parameter.
filters GetObjectsFilter[]
prefix string: The string to use for matching against the start of object names in a list query.
start string: Object names returned by a list query must be greater or equal to this parameter.
startAfter string: Object names returned by a list query must be greater than this parameter.

bucket str: The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
namespace str: The Object Storage namespace used for the request.
delimiter str: When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
end str: Object names returned by a list query must be strictly less than this parameter.
filters GetObjectsFilter]
prefix str: The string to use for matching against the start of object names in a list query.
start str: Object names returned by a list query must be greater or equal to this parameter.
start_after str: Object names returned by a list query must be greater than this parameter.

bucket String: The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
namespace String: The Object Storage namespace used for the request.
delimiter String: When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
end String: Object names returned by a list query must be strictly less than this parameter.
filters List<Property Map>
prefix String: The string to use for matching against the start of object names in a list query.
start String: Object names returned by a list query must be greater or equal to this parameter.
startAfter String: Object names returned by a list query must be greater than this parameter.