Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.ObjectStorage.getObjectVersions

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Example Usage

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

const testObjectVersions = oci.ObjectStorage.getObjectVersions({
    bucket: objectVersionBucket,
    namespace: objectVersionNamespace,
    delimiter: objectVersionDelimiter,
    end: objectVersionEnd,
    fields: objectVersionFields,
    prefix: objectVersionPrefix,
    start: objectVersionStart,
    startAfter: objectVersionStartAfter,
});

import pulumi
import pulumi_oci as oci

test_object_versions = oci.ObjectStorage.get_object_versions(bucket=object_version_bucket,
    namespace=object_version_namespace,
    delimiter=object_version_delimiter,
    end=object_version_end,
    fields=object_version_fields,
    prefix=object_version_prefix,
    start=object_version_start,
    start_after=object_version_start_after)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ObjectStorage.GetObjectVersions(ctx, &objectstorage.GetObjectVersionsArgs{
			Bucket:     objectVersionBucket,
			Namespace:  objectVersionNamespace,
			Delimiter:  pulumi.StringRef(objectVersionDelimiter),
			End:        pulumi.StringRef(objectVersionEnd),
			Fields:     pulumi.StringRef(objectVersionFields),
			Prefix:     pulumi.StringRef(objectVersionPrefix),
			Start:      pulumi.StringRef(objectVersionStart),
			StartAfter: pulumi.StringRef(objectVersionStartAfter),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testObjectVersions = Oci.ObjectStorage.GetObjectVersions.Invoke(new()
    {
        Bucket = objectVersionBucket,
        Namespace = objectVersionNamespace,
        Delimiter = objectVersionDelimiter,
        End = objectVersionEnd,
        Fields = objectVersionFields,
        Prefix = objectVersionPrefix,
        Start = objectVersionStart,
        StartAfter = objectVersionStartAfter,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ObjectStorage.ObjectStorageFunctions;
import com.pulumi.oci.ObjectStorage.inputs.GetObjectVersionsArgs;
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) {
        final var testObjectVersions = ObjectStorageFunctions.getObjectVersions(GetObjectVersionsArgs.builder()
            .bucket(objectVersionBucket)
            .namespace(objectVersionNamespace)
            .delimiter(objectVersionDelimiter)
            .end(objectVersionEnd)
            .fields(objectVersionFields)
            .prefix(objectVersionPrefix)
            .start(objectVersionStart)
            .startAfter(objectVersionStartAfter)
            .build());

    }
}

variables:
  testObjectVersions:
    fn::invoke:
      Function: oci:ObjectStorage:getObjectVersions
      Arguments:
        bucket: ${objectVersionBucket}
        namespace: ${objectVersionNamespace}
        delimiter: ${objectVersionDelimiter}
        end: ${objectVersionEnd}
        fields: ${objectVersionFields}
        prefix: ${objectVersionPrefix}
        start: ${objectVersionStart}
        startAfter: ${objectVersionStartAfter}

Using getObjectVersions

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 getObjectVersions(args: GetObjectVersionsArgs, opts?: InvokeOptions): Promise<GetObjectVersionsResult>
function getObjectVersionsOutput(args: GetObjectVersionsOutputArgs, opts?: InvokeOptions): Output<GetObjectVersionsResult>

def get_object_versions(bucket: Optional[str] = None,
                        delimiter: Optional[str] = None,
                        end: Optional[str] = None,
                        fields: Optional[str] = None,
                        filters: Optional[Sequence[_objectstorage.GetObjectVersionsFilter]] = None,
                        namespace: Optional[str] = None,
                        prefix: Optional[str] = None,
                        start: Optional[str] = None,
                        start_after: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetObjectVersionsResult
def get_object_versions_output(bucket: Optional[pulumi.Input[str]] = None,
                        delimiter: Optional[pulumi.Input[str]] = None,
                        end: Optional[pulumi.Input[str]] = None,
                        fields: Optional[pulumi.Input[str]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[_objectstorage.GetObjectVersionsFilterArgs]]]] = 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[GetObjectVersionsResult]

func GetObjectVersions(ctx *Context, args *GetObjectVersionsArgs, opts ...InvokeOption) (*GetObjectVersionsResult, error)
func GetObjectVersionsOutput(ctx *Context, args *GetObjectVersionsOutputArgs, opts ...InvokeOption) GetObjectVersionsResultOutput

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

public static class GetObjectVersions 
{
    public static Task<GetObjectVersionsResult> InvokeAsync(GetObjectVersionsArgs args, InvokeOptions? opts = null)
    public static Output<GetObjectVersionsResult> Invoke(GetObjectVersionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetObjectVersionsResult> getObjectVersions(GetObjectVersionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:ObjectStorage/getObjectVersions:getObjectVersions
  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: Returns object names which are lexicographically strictly less than this parameter.
Fields string: Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
Filters List<GetObjectVersionsFilter>
Prefix string: The string to use for matching against the start of object names in a list query.
Start string: Returns object names which are lexicographically greater than or equal to this parameter.
StartAfter string: Returns object names which are lexicographically strictly 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: Returns object names which are lexicographically strictly less than this parameter.
Fields string: Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
Filters []GetObjectVersionsFilter
Prefix string: The string to use for matching against the start of object names in a list query.
Start string: Returns object names which are lexicographically greater than or equal to this parameter.
StartAfter string: Returns object names which are lexicographically strictly 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: Returns object names which are lexicographically strictly less than this parameter.
fields String: Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
filters List<GetObjectVersionsFilter>
prefix String: The string to use for matching against the start of object names in a list query.
start String: Returns object names which are lexicographically greater than or equal to this parameter.
startAfter String: Returns object names which are lexicographically strictly 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: Returns object names which are lexicographically strictly less than this parameter.
fields string: Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
filters GetObjectVersionsFilter[]
prefix string: The string to use for matching against the start of object names in a list query.
start string: Returns object names which are lexicographically greater than or equal to this parameter.
startAfter string: Returns object names which are lexicographically strictly 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: Returns object names which are lexicographically strictly less than this parameter.
fields str: Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
filters Sequence[objectstorage.GetObjectVersionsFilter]
prefix str: The string to use for matching against the start of object names in a list query.
start str: Returns object names which are lexicographically greater than or equal to this parameter.
start_after str: Returns object names which are lexicographically strictly 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: Returns object names which are lexicographically strictly less than this parameter.
fields String: Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
filters List<Property Map>
prefix String: The string to use for matching against the start of object names in a list query.
start String: Returns object names which are lexicographically greater than or equal to this parameter.
startAfter String: Returns object names which are lexicographically strictly greater than this parameter.

getObjectVersions Result

The following output properties are available:

Bucket string
Id string: The provider-assigned unique ID for this managed resource.
Items List<GetObjectVersionsItem>: An array of object version summaries.
Namespace string
Prefixes List<string>: Prefixes that are common to the results returned by the request if the request specified a delimiter.
Delimiter string
End string
Fields string
Filters List<GetObjectVersionsFilter>
Prefix string
Start string
StartAfter string

Bucket string
Id string: The provider-assigned unique ID for this managed resource.
Items []GetObjectVersionsItem: An array of object version summaries.
Namespace string
Prefixes []string: Prefixes that are common to the results returned by the request if the request specified a delimiter.
Delimiter string
End string
Fields string
Filters []GetObjectVersionsFilter
Prefix string
Start string
StartAfter string

bucket String
id String: The provider-assigned unique ID for this managed resource.
items List<GetObjectVersionsItem>: An array of object version summaries.
namespace String
prefixes List<String>: Prefixes that are common to the results returned by the request if the request specified a delimiter.
delimiter String
end String
fields String
filters List<GetObjectVersionsFilter>
prefix String
start String
startAfter String

bucket string
id string: The provider-assigned unique ID for this managed resource.
items GetObjectVersionsItem[]: An array of object version summaries.
namespace string
prefixes string[]: Prefixes that are common to the results returned by the request if the request specified a delimiter.
delimiter string
end string
fields string
filters GetObjectVersionsFilter[]
prefix string
start string
startAfter string

bucket str
id str: The provider-assigned unique ID for this managed resource.
items Sequence[objectstorage.GetObjectVersionsItem]: An array of object version summaries.
namespace str
prefixes Sequence[str]: Prefixes that are common to the results returned by the request if the request specified a delimiter.
delimiter str
end str
fields str
filters Sequence[objectstorage.GetObjectVersionsFilter]
prefix str
start str
start_after str

bucket String
id String: The provider-assigned unique ID for this managed resource.
items List<Property Map>: An array of object version summaries.
namespace String
prefixes List<String>: Prefixes that are common to the results returned by the request if the request specified a delimiter.
delimiter String
end String
fields String
filters List<Property Map>
prefix String
start String
startAfter String

Supporting Types

GetObjectVersionsFilter

Name string: The name of the object. Avoid entering confidential information. Example: test/object1.log
Values List<string>
Regex bool

Name string: The name of the object. Avoid entering confidential information. Example: test/object1.log
Values []string
Regex bool

name String: The name of the object. Avoid entering confidential information. Example: test/object1.log
values List<String>
regex Boolean

name string: The name of the object. Avoid entering confidential information. Example: test/object1.log
values string[]
regex boolean

name str: The name of the object. Avoid entering confidential information. Example: test/object1.log
values Sequence[str]
regex bool

name String: The name of the object. Avoid entering confidential information. Example: test/object1.log
values List<String>
regex Boolean

GetObjectVersionsItem

ArchivalState string: Archival state of an object. This field is set only for objects in Archive tier.
Etag string: The current entity tag (ETag) for the object.
IsDeleteMarker bool: This flag will indicate if the version is deleted or not.
Md5 string: Base64-encoded MD5 hash of the object data.
Name string: The name of the object. Avoid entering confidential information. Example: test/object1.log
Size string: Size of the object in bytes.
StorageTier string: The storage tier that the object is stored in.
TimeCreated string: The date and time the object was created, as described in RFC 2616.
TimeModified string: The date and time the object was modified, as described in RFC 2616.
VersionId string: VersionId of the object.

ArchivalState string: Archival state of an object. This field is set only for objects in Archive tier.
Etag string: The current entity tag (ETag) for the object.
IsDeleteMarker bool: This flag will indicate if the version is deleted or not.
Md5 string: Base64-encoded MD5 hash of the object data.
Name string: The name of the object. Avoid entering confidential information. Example: test/object1.log
Size string: Size of the object in bytes.
StorageTier string: The storage tier that the object is stored in.
TimeCreated string: The date and time the object was created, as described in RFC 2616.
TimeModified string: The date and time the object was modified, as described in RFC 2616.
VersionId string: VersionId of the object.

archivalState String: Archival state of an object. This field is set only for objects in Archive tier.
etag String: The current entity tag (ETag) for the object.
isDeleteMarker Boolean: This flag will indicate if the version is deleted or not.
md5 String: Base64-encoded MD5 hash of the object data.
name String: The name of the object. Avoid entering confidential information. Example: test/object1.log
size String: Size of the object in bytes.
storageTier String: The storage tier that the object is stored in.
timeCreated String: The date and time the object was created, as described in RFC 2616.
timeModified String: The date and time the object was modified, as described in RFC 2616.
versionId String: VersionId of the object.

archivalState string: Archival state of an object. This field is set only for objects in Archive tier.
etag string: The current entity tag (ETag) for the object.
isDeleteMarker boolean: This flag will indicate if the version is deleted or not.
md5 string: Base64-encoded MD5 hash of the object data.
name string: The name of the object. Avoid entering confidential information. Example: test/object1.log
size string: Size of the object in bytes.
storageTier string: The storage tier that the object is stored in.
timeCreated string: The date and time the object was created, as described in RFC 2616.
timeModified string: The date and time the object was modified, as described in RFC 2616.
versionId string: VersionId of the object.

archival_state str: Archival state of an object. This field is set only for objects in Archive tier.
etag str: The current entity tag (ETag) for the object.
is_delete_marker bool: This flag will indicate if the version is deleted or not.
md5 str: Base64-encoded MD5 hash of the object data.
name str: The name of the object. Avoid entering confidential information. Example: test/object1.log
size str: Size of the object in bytes.
storage_tier str: The storage tier that the object is stored in.
time_created str: The date and time the object was created, as described in RFC 2616.
time_modified str: The date and time the object was modified, as described in RFC 2616.
version_id str: VersionId of the object.

archivalState String: Archival state of an object. This field is set only for objects in Archive tier.
etag String: The current entity tag (ETag) for the object.
isDeleteMarker Boolean: This flag will indicate if the version is deleted or not.
md5 String: Base64-encoded MD5 hash of the object data.
name String: The name of the object. Avoid entering confidential information. Example: test/object1.log
size String: Size of the object in bytes.
storageTier String: The storage tier that the object is stored in.
timeCreated String: The date and time the object was created, as described in RFC 2616.
timeModified String: The date and time the object was modified, as described in RFC 2616.
versionId String: VersionId of the object.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.ObjectStorage.getObjectVersions

On this page

On this page

Example Usage

Using getObjectVersions

getObjectVersions Result

Supporting Types

GetObjectVersionsFilter

GetObjectVersionsItem

Package Details

On this page

On this page