tech.figure.block.api.proto.MarkerStateKt.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-proto Show documentation
Show all versions of api-proto Show documentation
gRPC client code to interact with Figures off chain Provenance data
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: marker.proto
// Generated files should ignore deprecation warnings
@file:Suppress("DEPRECATION")
package tech.figure.block.api.proto;
@kotlin.jvm.JvmName("-initializemarkerState")
public inline fun markerState(block: tech.figure.block.api.proto.MarkerStateKt.Dsl.() -> kotlin.Unit): tech.figure.block.api.proto.Marker.MarkerState =
tech.figure.block.api.proto.MarkerStateKt.Dsl._create(tech.figure.block.api.proto.Marker.MarkerState.newBuilder()).apply { block() }._build()
/**
* ```
* Represents the current status of a Provenance Blockchain Marker at a specific block height
* ```
*
* Protobuf type `api.MarkerState`
*/
public object MarkerStateKt {
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
@com.google.protobuf.kotlin.ProtoDslMarker
public class Dsl private constructor(
private val _builder: tech.figure.block.api.proto.Marker.MarkerState.Builder
) {
public companion object {
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _create(builder: tech.figure.block.api.proto.Marker.MarkerState.Builder): Dsl = Dsl(builder)
}
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _build(): tech.figure.block.api.proto.Marker.MarkerState = _builder.build()
/**
* ```
* The block height for which this marker's state was recorded
* ```
*
* `int64 height = 1;`
*/
public var height: kotlin.Long
@JvmName("getHeight")
get() = _builder.getHeight()
@JvmName("setHeight")
set(value) {
_builder.setHeight(value)
}
/**
* ```
* The block height for which this marker's state was recorded
* ```
*
* `int64 height = 1;`
*/
public fun clearHeight() {
_builder.clearHeight()
}
/**
* ```
* The unique denom identifier for the marker
* ```
*
* `string denom = 2;`
*/
public var denom: kotlin.String
@JvmName("getDenom")
get() = _builder.getDenom()
@JvmName("setDenom")
set(value) {
_builder.setDenom(value)
}
/**
* ```
* The unique denom identifier for the marker
* ```
*
* `string denom = 2;`
*/
public fun clearDenom() {
_builder.clearDenom()
}
/**
* ```
* The Provenance Blockchain bech32 address for the marker
* ```
*
* `string address = 3;`
*/
public var address: kotlin.String
@JvmName("getAddress")
get() = _builder.getAddress()
@JvmName("setAddress")
set(value) {
_builder.setAddress(value)
}
/**
* ```
* The Provenance Blockchain bech32 address for the marker
* ```
*
* `string address = 3;`
*/
public fun clearAddress() {
_builder.clearAddress()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class AccessListProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
* ```
* A collection of all accounts that have access to this marker and their specific permissions on it
* ```
*
* `repeated .api.AccessList access_list = 4;`
*/
public val accessList: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getAccessListList()
)
/**
* ```
* A collection of all accounts that have access to this marker and their specific permissions on it
* ```
*
* `repeated .api.AccessList access_list = 4;`
* @param value The accessList to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAccessList")
public fun com.google.protobuf.kotlin.DslList.add(value: tech.figure.block.api.proto.Marker.AccessList) {
_builder.addAccessList(value)
}
/**
* ```
* A collection of all accounts that have access to this marker and their specific permissions on it
* ```
*
* `repeated .api.AccessList access_list = 4;`
* @param value The accessList to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAccessList")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: tech.figure.block.api.proto.Marker.AccessList) {
add(value)
}
/**
* ```
* A collection of all accounts that have access to this marker and their specific permissions on it
* ```
*
* `repeated .api.AccessList access_list = 4;`
* @param values The accessList to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllAccessList")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllAccessList(values)
}
/**
* ```
* A collection of all accounts that have access to this marker and their specific permissions on it
* ```
*
* `repeated .api.AccessList access_list = 4;`
* @param values The accessList to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllAccessList")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
* ```
* A collection of all accounts that have access to this marker and their specific permissions on it
* ```
*
* `repeated .api.AccessList access_list = 4;`
* @param index The index to set the value at.
* @param value The accessList to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setAccessList")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: tech.figure.block.api.proto.Marker.AccessList) {
_builder.setAccessList(index, value)
}
/**
* ```
* A collection of all accounts that have access to this marker and their specific permissions on it
* ```
*
* `repeated .api.AccessList access_list = 4;`
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearAccessList")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearAccessList()
}
/**
* ```
* Defines if this marker can be modified with governance proposals
* ```
*
* `bool allow_governance_control = 5;`
*/
public var allowGovernanceControl: kotlin.Boolean
@JvmName("getAllowGovernanceControl")
get() = _builder.getAllowGovernanceControl()
@JvmName("setAllowGovernanceControl")
set(value) {
_builder.setAllowGovernanceControl(value)
}
/**
* ```
* Defines if this marker can be modified with governance proposals
* ```
*
* `bool allow_governance_control = 5;`
*/
public fun clearAllowGovernanceControl() {
_builder.clearAllowGovernanceControl()
}
/**
* ```
* The Provenance Blockchain account associated with this marker
* ```
*
* `.api.BaseAccount base_account = 6;`
*/
public var baseAccount: tech.figure.block.api.proto.Marker.BaseAccount
@JvmName("getBaseAccount")
get() = _builder.getBaseAccount()
@JvmName("setBaseAccount")
set(value) {
_builder.setBaseAccount(value)
}
/**
* ```
* The Provenance Blockchain account associated with this marker
* ```
*
* `.api.BaseAccount base_account = 6;`
*/
public fun clearBaseAccount() {
_builder.clearBaseAccount()
}
/**
* ```
* The Provenance Blockchain account associated with this marker
* ```
*
* `.api.BaseAccount base_account = 6;`
* @return Whether the baseAccount field is set.
*/
public fun hasBaseAccount(): kotlin.Boolean {
return _builder.hasBaseAccount()
}
/**
* ```
* The Provenance Blockchain bech32 address of the managing account on this marker. Only populated when the marker has not yet been activated
* ```
*
* `string manager = 7;`
*/
public var manager: kotlin.String
@JvmName("getManager")
get() = _builder.getManager()
@JvmName("setManager")
set(value) {
_builder.setManager(value)
}
/**
* ```
* The Provenance Blockchain bech32 address of the managing account on this marker. Only populated when the marker has not yet been activated
* ```
*
* `string manager = 7;`
*/
public fun clearManager() {
_builder.clearManager()
}
/**
* ```
* The type of the marker, defining its restricted status
* ```
*
* `string marker_type = 8;`
*/
public var markerType: kotlin.String
@JvmName("getMarkerType")
get() = _builder.getMarkerType()
@JvmName("setMarkerType")
set(value) {
_builder.setMarkerType(value)
}
/**
* ```
* The type of the marker, defining its restricted status
* ```
*
* `string marker_type = 8;`
*/
public fun clearMarkerType() {
_builder.clearMarkerType()
}
/**
* ```
* Indicates the current status of this marker record in regard to its activation
* ```
*
* `string status = 9;`
*/
public var status: kotlin.String
@JvmName("getStatus")
get() = _builder.getStatus()
@JvmName("setStatus")
set(value) {
_builder.setStatus(value)
}
/**
* ```
* Indicates the current status of this marker record in regard to its activation
* ```
*
* `string status = 9;`
*/
public fun clearStatus() {
_builder.clearStatus()
}
/**
* ```
* The amount of denom currently held by the marker
* ```
*
* `string supply = 10;`
*/
public var supply: kotlin.String
@JvmName("getSupply")
get() = _builder.getSupply()
@JvmName("setSupply")
set(value) {
_builder.setSupply(value)
}
/**
* ```
* The amount of denom currently held by the marker
* ```
*
* `string supply = 10;`
*/
public fun clearSupply() {
_builder.clearSupply()
}
/**
* ```
* A fixed supply will mint additional coin automatically if the total supply decreases below a set value
* ```
*
* `bool supply_fixed = 11;`
*/
public var supplyFixed: kotlin.Boolean
@JvmName("getSupplyFixed")
get() = _builder.getSupplyFixed()
@JvmName("setSupplyFixed")
set(value) {
_builder.setSupplyFixed(value)
}
/**
* ```
* A fixed supply will mint additional coin automatically if the total supply decreases below a set value
* ```
*
* `bool supply_fixed = 11;`
*/
public fun clearSupplyFixed() {
_builder.clearSupplyFixed()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class MessageTriggersProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
* ```
* Details on each Provenance Blockchain msg that caused the MarkerState to be produced
* ```
*
* `repeated .api.MarkerTrigger message_triggers = 12;`
*/
public val messageTriggers: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getMessageTriggersList()
)
/**
* ```
* Details on each Provenance Blockchain msg that caused the MarkerState to be produced
* ```
*
* `repeated .api.MarkerTrigger message_triggers = 12;`
* @param value The messageTriggers to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addMessageTriggers")
public fun com.google.protobuf.kotlin.DslList.add(value: tech.figure.block.api.proto.Marker.MarkerTrigger) {
_builder.addMessageTriggers(value)
}
/**
* ```
* Details on each Provenance Blockchain msg that caused the MarkerState to be produced
* ```
*
* `repeated .api.MarkerTrigger message_triggers = 12;`
* @param value The messageTriggers to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignMessageTriggers")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: tech.figure.block.api.proto.Marker.MarkerTrigger) {
add(value)
}
/**
* ```
* Details on each Provenance Blockchain msg that caused the MarkerState to be produced
* ```
*
* `repeated .api.MarkerTrigger message_triggers = 12;`
* @param values The messageTriggers to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllMessageTriggers")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllMessageTriggers(values)
}
/**
* ```
* Details on each Provenance Blockchain msg that caused the MarkerState to be produced
* ```
*
* `repeated .api.MarkerTrigger message_triggers = 12;`
* @param values The messageTriggers to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllMessageTriggers")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
* ```
* Details on each Provenance Blockchain msg that caused the MarkerState to be produced
* ```
*
* `repeated .api.MarkerTrigger message_triggers = 12;`
* @param index The index to set the value at.
* @param value The messageTriggers to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setMessageTriggers")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: tech.figure.block.api.proto.Marker.MarkerTrigger) {
_builder.setMessageTriggers(index, value)
}
/**
* ```
* Details on each Provenance Blockchain msg that caused the MarkerState to be produced
* ```
*
* `repeated .api.MarkerTrigger message_triggers = 12;`
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearMessageTriggers")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearMessageTriggers()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class EventTriggersProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
* ```
* Details on each Provenance Blockchain event that caused the Marker state to be produced
* ```
*
* `repeated .api.MarkerTrigger event_triggers = 13;`
*/
public val eventTriggers: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getEventTriggersList()
)
/**
* ```
* Details on each Provenance Blockchain event that caused the Marker state to be produced
* ```
*
* `repeated .api.MarkerTrigger event_triggers = 13;`
* @param value The eventTriggers to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addEventTriggers")
public fun com.google.protobuf.kotlin.DslList.add(value: tech.figure.block.api.proto.Marker.MarkerTrigger) {
_builder.addEventTriggers(value)
}
/**
* ```
* Details on each Provenance Blockchain event that caused the Marker state to be produced
* ```
*
* `repeated .api.MarkerTrigger event_triggers = 13;`
* @param value The eventTriggers to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignEventTriggers")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: tech.figure.block.api.proto.Marker.MarkerTrigger) {
add(value)
}
/**
* ```
* Details on each Provenance Blockchain event that caused the Marker state to be produced
* ```
*
* `repeated .api.MarkerTrigger event_triggers = 13;`
* @param values The eventTriggers to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllEventTriggers")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllEventTriggers(values)
}
/**
* ```
* Details on each Provenance Blockchain event that caused the Marker state to be produced
* ```
*
* `repeated .api.MarkerTrigger event_triggers = 13;`
* @param values The eventTriggers to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllEventTriggers")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
* ```
* Details on each Provenance Blockchain event that caused the Marker state to be produced
* ```
*
* `repeated .api.MarkerTrigger event_triggers = 13;`
* @param index The index to set the value at.
* @param value The eventTriggers to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setEventTriggers")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: tech.figure.block.api.proto.Marker.MarkerTrigger) {
_builder.setEventTriggers(index, value)
}
/**
* ```
* Details on each Provenance Blockchain event that caused the Marker state to be produced
* ```
*
* `repeated .api.MarkerTrigger event_triggers = 13;`
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearEventTriggers")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearEventTriggers()
}
/**
* ```
* A value indicating the amount of coin of its own denom that the marker held at this block height. This is cloned from the Coin.amount property
* ```
*
* `string escrow_amount = 14;`
*/
public var escrowAmount: kotlin.String
@JvmName("getEscrowAmount")
get() = _builder.getEscrowAmount()
@JvmName("setEscrowAmount")
set(value) {
_builder.setEscrowAmount(value)
}
/**
* ```
* A value indicating the amount of coin of its own denom that the marker held at this block height. This is cloned from the Coin.amount property
* ```
*
* `string escrow_amount = 14;`
*/
public fun clearEscrowAmount() {
_builder.clearEscrowAmount()
}
}
}
@kotlin.jvm.JvmSynthetic
public inline fun tech.figure.block.api.proto.Marker.MarkerState.copy(block: tech.figure.block.api.proto.MarkerStateKt.Dsl.() -> kotlin.Unit): tech.figure.block.api.proto.Marker.MarkerState =
tech.figure.block.api.proto.MarkerStateKt.Dsl._create(this.toBuilder()).apply { block() }._build()
public val tech.figure.block.api.proto.Marker.MarkerStateOrBuilder.baseAccountOrNull: tech.figure.block.api.proto.Marker.BaseAccount?
get() = if (hasBaseAccount()) getBaseAccount() else null