Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.ObjectStorage.getObjects

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

variables:
  testObjects:
    fn::invoke:
      function: oci:ObjectStorage:getObjects
      arguments:
        bucket: ${objectBucket}
        namespace: ${objectNamespace}
        delimiter: ${objectDelimiter}
        end: ${objectEnd}
        fields: ${objectFields}
        prefix: ${objectPrefix}
        start: ${objectStart}
        startAfter: ${objectStartAfter}

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.

TypeScript
Python
Go
C#
Java
YAML

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)
public static Output<GetObjectsResult> getObjects(GetObjectsArgs args, InvokeOptions options)

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: Returns object names which are lexicographically 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: 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.
Filters []GetObjectsFilter
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.
filters List<GetObjectsFilter>
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.
filters GetObjectsFilter[]
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.
filters Sequence[objectstorage.GetObjectsFilter]
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.
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.