Skip to main content

ReservationEntry

This class encapsulates the current state of an artifact reservation within the catalog.

Methods


GetExpiresAt()

@classmethod
def GetExpiresAt() - > time.Time

Retrieves the expiration timestamp of the reservation. Callers use this to determine when the reservation will automatically be released.

Returns

TypeDescription
time.TimeThe time at which the reservation expires.

GetHeartbeatInterval()

@classmethod
def GetHeartbeatInterval() - > time.Duration

Fetches the required interval for sending heartbeat signals to maintain the reservation. Callers use this to schedule periodic updates to prevent reservation expiration.

Returns

TypeDescription
time.DurationThe duration representing the heartbeat interval.

GetOwnerID()

@classmethod
def GetOwnerID() - > string

Returns the identifier of the entity that currently owns the reservation. Callers use this to identify who holds the reservation.

Returns

TypeDescription
stringThe unique identifier of the reservation owner.

GetStatus()

@classmethod
def GetStatus() - > core.CatalogReservation_Status

Retrieves the current status of the reservation. Callers use this to understand the reservation's state, such as whether it is active or expired.

Returns

TypeDescription
core.CatalogReservation_StatusThe current status of the reservation.