objStoreOptions Struct Reference

#include <nats.h>

Public Attributes
bool	ShowDeleted
	ShowDeleted includes deleted object in the result.

Detailed Description

This structure is used to provide additional options to some object store APIs.

Some options will have a meaning only for some APIs. Each API that accepts this structure will describe which options can be used and their exact meaning in the context of the API.

Typically, users will declare a variable of this type on the stack and initializes it with objStoreOptions_Init, and then pass the pointer to this variable to APIs that need it.

Member Data Documentation

ShowDeleted

bool objStoreOptions::ShowDeleted

For some APIs, if this option is set to true, the returned value will include objects that have been deleted.

---

The documentation for this struct was generated from the following file:

• nats.h