Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Object Storage API, gRPC: BucketService.GetInventoryConfiguration

Written by
Updated at December 1, 2025

Get an inventory configuration with the corresponding ID

gRPC request

rpc GetInventoryConfiguration (GetBucketInventoryConfigurationRequest) returns (InventoryConfiguration)

GetBucketInventoryConfigurationRequest

{
  "bucket": "string",
  "id": "string"
}

Field

Description

bucket

string

Required field. Name of the bucket to get the inventory configuration for.

id

string

Required field. ID of the inventory configuration to get.

InventoryConfiguration

{
  "id": "string",
  "destination": {
    "bucket_destination": {
      "bucket": "string",
      "format": "Format",
      "prefix": "google.protobuf.StringValue"
    }
  },
  "included_object_versions": "IncludedObjectVersions",
  "is_enabled": "bool",
  "schedule": {
    "frequency": "Frequency"
  },
  "filter": {
    "prefix": "string"
  },
  "optional_fields": [
    "OptionalField"
  ]
}

Field

Description

id

string

Required field. The ID used to identify the inventory configuration.

destination

InventoryDestination

Required field. Contains information about where to publish the inventory results.

included_object_versions

enum IncludedObjectVersions

Required field. Object versions to include in the inventory list.

  • ALL: Include all versions.
  • CURRENT: Include only the current version.

is_enabled

bool

Specifies whether the inventory is enabled.

schedule

InventorySchedule

Required field. Specifies the schedule for generating inventory results.

filter

InventoryFilter

Specifies the filter for objects to include in the inventory.

optional_fields[]

enum OptionalField

Contains the optional fields that are included in the inventory results.

  • SIZE: The object size in bytes.
  • LAST_MODIFIED_DATE: The object creation date or the last modified date, whichever is the latest.
  • STORAGE_CLASS: The storage class that's used for storing the object.
  • ETAG: The entity tag (ETag) is a hash of the object.
  • IS_MULTIPART_UPLOADED: Specifies that the object was uploaded as a multipart upload.
  • ENCRYPTION_STATUS: The server-side encryption type that's used to encrypt the object.
  • OBJECT_LOCK_RETAIN_UNTIL_DATE: The date until which the object is locked.
  • OBJECT_LOCK_MODE: The level of protection applied to the object, either Governance or Compliance.
  • OBJECT_LOCK_LEGAL_HOLD_STATUS: The legal hold status of the locked object.
  • CHECKSUM_ALGORITHM: Indicates the algorithm that is used to create the checksum for the object.
  • OBJECT_ACCESS_CONTROL_LIST: An access control list (ACL) for each object.
  • OBJECT_OWNER: The owner of the object.

InventoryDestination

Field

Description

bucket_destination

InventoryBucketDestination

Required field. Destination bucket settings

InventoryBucketDestination

Field

Description

bucket

string

Required field. Bucket where inventory results will be published.

format

enum Format

Required field. Specifies the output format of the inventory results.

  • CSV: CSV format.

prefix

google.protobuf.StringValue

The prefix that is prepended to all inventory results.

InventorySchedule

Field

Description

frequency

enum Frequency

Required field. Specifies how frequently inventory results are produced.

  • DAILY: Daily generation.
  • WEEKLY: Weekly generation.

InventoryFilter

Field

Description

prefix

string

Required field. The prefix that an object must have to be included in the inventory results.
Previous
CreateInventoryConfiguration
Next
DeleteInventoryConfiguration