gcs_list_objects: List objects in a bucket

Description Usage Arguments Details Value See Also

View source: R/objects.R

Description

List objects in a bucket

Usage

1
2
3
4
5
6
7
gcs_list_objects(
  bucket = gcs_get_global_bucket(),
  detail = c("summary", "more", "full"),
  prefix = NULL,
  delimiter = NULL,
  versions = FALSE
)

Arguments

bucket

bucket containing the objects

detail

Set level of detail

prefix

Filter results to objects whose names begin with this prefix

delimiter

Use to list objects like a directory listing.

versions

If TRUE, lists all versions of an object as distinct results in order of increasing generation number.

Details

Columns returned by detail are:

delimited returns results in a directory-like mode: items will contain only objects whose names, aside from the prefix, do not contain delimiter. In conjunction with the prefix filter, the use of the delimiter parameter allows the list method to operate like a directory listing, despite the object namespace being flat. For example, if delimiter were set to "/", then listing objects from a bucket that contains the objects "a/b", "a/c", "dddd", "eeee", "e/f" would return objects "dddd" and "eeee", and prefixes "a/" and "e/".

Value

A data.frame of the objects

See Also

Other object functions: gcs_compose_objects(), gcs_copy_object(), gcs_delete_object(), gcs_get_object(), gcs_metadata_object()


googleCloudStorageR documentation built on Dec. 16, 2021, 5:06 p.m.