NATS C Client with JetStream and Streaming support  3.11.0
The nats.io C Client, Supported by Synadia Communications Inc.
Loading...
Searching...
No Matches
objStoreStatus Struct Reference

#include <nats.h>

Public Attributes

const char * Bucket
 Bucket is the name of the object store.
 
const char * Description
 Description is the description supplied when creating the bucket.
 
int64_t TTL
 TTL indicates how long (in milliseconds) objects are kept in the bucket.
 
jsStorageType Storage
 Storage indicates the underlying JetStream storage technology used tostore data.
 
int Replicas
 Replicas indicates how many storage replicas are kept for the data in the bucket.
 
bool Sealed
 Sealed indicates the stream is sealed and cannot be modified in any way.
 
uint64_t Size
 Size is the combined size of all data in the bucket including metadata, in bytes.
 
const char * BackingStore
 BackingStore indicates what technology is used for storage of the bucket.
 
natsMetadata Metadata
 Metadata is the user supplied metadata for the bucket.
 
jsStreamInfoStreamInfo
 StreamInfo is the stream info retrieved to create the status.
 
bool IsCompressed
 IsCompressed indicates if the data is compressed on disk.
 

Detailed Description

The Object Store status object.

This is run-time status about a bucket.

Note
User needs to call objStoreStatus_Destroy when object is no longer needed to free memory, except if the user got the status from the list objStoreStatusesList, in which case the statuses will be destroyed when calling objStoreStatusesList_Destroy.
See also
objStoreStatus_Destroy
objStoreStatusesList_Destroy

Member Data Documentation

◆ Bucket

const char* objStoreStatus::Bucket

◆ Description

const char* objStoreStatus::Description

◆ TTL

int64_t objStoreStatus::TTL

◆ Storage

jsStorageType objStoreStatus::Storage

◆ Replicas

int objStoreStatus::Replicas

◆ Sealed

bool objStoreStatus::Sealed

◆ Size

uint64_t objStoreStatus::Size

◆ BackingStore

const char* objStoreStatus::BackingStore

Currently only JetStream is supported.

◆ Metadata

natsMetadata objStoreStatus::Metadata

◆ StreamInfo

jsStreamInfo* objStoreStatus::StreamInfo

◆ IsCompressed

bool objStoreStatus::IsCompressed

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