Struct ApiPolicySpec 

pub struct ApiPolicySpec {
    pub name: String,
    pub description: String,
    pub spot_markets: Vec<SpotMarketRule>,
    pub perp_markets: Vec<PerpMarketRule>,
    pub spot_market_scope: EnumValue<Value>,
    pub perp_market_scope: EnumValue<Value>,
    pub actions: Vec<EnumValue<PolicyAction>>,
    pub max_order_notional: u64,
    pub daily_internal_transfer_out_limit: u64,
    pub daily_withdraw_limit: u64,
    pub is_template: bool,
    /* private fields */
}

ApiPolicySpec contains the mutable configuration of an API key policy.

Fields

name: String

Human-readable policy name. Create requires a non-empty value; update validates it after merging fields selected by update_mask.

Field 1: name

description: String

Optional policy description for dashboards and audits. Maximum 256 characters.

Field 2: description

spot_markets: Vec<SpotMarketRule>

Allowed spot markets for this API key policy.

Field 3: spot_markets

perp_markets: Vec<PerpMarketRule>

Allowed perp markets and optional per-contract leverage caps.

Field 4: perp_markets

spot_market_scope: EnumValue<Value>

Market-level scope for spot markets. When unspecified, defaults to ALL.

Field 5: spot_market_scope

perp_market_scope: EnumValue<Value>

Market-level scope for perp contracts. When unspecified, defaults to ALL.

Field 6: perp_market_scope

actions: Vec<EnumValue<PolicyAction>>

High-level actions enabled for the API key policy. Up to 64 unique explicit actions are allowed.

Field 7: actions

max_order_notional: u64

Maximum notional size for any single order submitted with this API key, expressed in the canonical quote unit (for example, micro-USDT). A value of 0 means no additional cap beyond the sub-account policy.

Field 13: max_order_notional

daily_internal_transfer_out_limit: u64

Maximum total notional this API key can transfer out internally per rolling day, expressed in the canonical quote unit (for example, micro-USDT). A value of 0 means no additional cap beyond the sub-account policy.

Field 17: daily_internal_transfer_out_limit

daily_withdraw_limit: u64

Maximum total notional this API key can withdraw per rolling day, expressed in the canonical quote unit (for example, micro-USDT). A value of 0 means no additional cap beyond the sub-account policy.

Field 18: daily_withdraw_limit

is_template: bool

Whether this policy should be treated as a reusable template.

Field 19: is_template

Implementations

impl ApiPolicySpec

pub const TYPE_URL: &'static str = "type.googleapis.com/auth.v1.ApiPolicySpec"

Protobuf type URL for this message, for use with Any::pack and Any::unpack_if.

Format: type.googleapis.com/<fully.qualified.TypeName>

Trait Implementations

impl Clone for ApiPolicySpec

fn clone(&self) -> ApiPolicySpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiPolicySpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApiPolicySpec

fn default() -> ApiPolicySpec

Returns the “default value” for a type.

impl DefaultInstance for ApiPolicySpec

fn default_instance() -> &'static Self

Return a reference to the single default instance of this type.

impl<'de> Deserialize<'de> for ApiPolicySpec

where ApiPolicySpec: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExtensionSet for ApiPolicySpec

const PROTO_FQN: &'static str = "auth.v1.ApiPolicySpec"

Fully-qualified proto type name of this message (no leading dot), e.g. "google.protobuf.FieldOptions".

fn unknown_fields(&self) -> &UnknownFields

Immutable access to the extendee’s unknown-field storage.

fn unknown_fields_mut(&mut self) -> &mut UnknownFields

Mutable access to the extendee’s unknown-field storage.

fn extension<C>(&self, ext: &Extension<C>) -> <C as ExtensionCodec>::Output

where C: ExtensionCodec,

Read an extension value.

fn set_extension<C>( &mut self, ext: &Extension<C>, value: <C as ExtensionCodec>::Value, )

where C: ExtensionCodec,

Write an extension value, replacing any prior occurrences.

fn has_extension<C>(&self, ext: &Extension<C>) -> bool

where C: ExtensionCodec,

Returns true if any record at the extension’s field number is present.

fn clear_extension<C>(&mut self, ext: &Extension<C>)

where C: ExtensionCodec,

Remove all records at the extension’s field number.

fn extension_or_default<C>( &self, ext: &Extension<C>, ) -> <C as ExtensionCodec>::Value

where C: ExtensionCodec<Output = Option<<C as ExtensionCodec>::Value>>, <C as ExtensionCodec>::Value: Default,

Read a singular extension value, returning the proto2 [default = ...] value if absent, or the type’s Default if no proto default was declared.

impl HasMessageView for ApiPolicySpec

type View<'a> = ApiPolicySpecView<'a>

The zero-copy view of Self, borrowing from a buffer with lifetime 'a.

type ViewHandle = ApiPolicySpecOwnedView

The generated 'static owned-view handle for Self (FooOwnedView).

fn decode_view(buf: &[u8]) -> Result<Self::View<'_>, DecodeError>

Decode a borrowed View from a byte slice.

fn decode_view_with_options<'a>( buf: &'a [u8], opts: &DecodeOptions, ) -> Result<Self::View<'a>, DecodeError>

Decode a borrowed View under custom DecodeOptions (recursion limit, max message size, unknown-field limit).

fn decode_view_handle(bytes: Bytes) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle from a Bytes buffer.

fn decode_view_handle_with_options( bytes: Bytes, opts: &DecodeOptions, ) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle with custom DecodeOptions (recursion limit, max message size).

impl Message for ApiPolicySpec

fn compute_size(&self, __cache: &mut SizeCache) -> u32

Returns the total encoded size in bytes.

The result is a u32; the protobuf specification requires all messages to fit within 2 GiB (2,147,483,647 bytes), so a compliant message will never overflow this type.

fn write_to(&self, __cache: &mut SizeCache, buf: &mut impl BufMut)

Write this message’s encoded bytes to a buffer, consuming nested-message sizes from cache (populated by a prior compute_size call on the same cache).

fn merge_field( &mut self, tag: Tag, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Processes a single already-decoded tag and its associated field data from buf.

fn clear(&mut self)

Clear all fields to their default values.

fn encode(&self, buf: &mut impl BufMut)

Compute size, then write. This is the primary encoding API.

fn encode_with_cache(&self, cache: &mut SizeCache, buf: &mut impl BufMut)

Encode using a caller-supplied SizeCache, for reuse across many encodes in a hot loop. Clears the cache first.

fn encoded_len(&self) -> u32

Compute the encoded byte size of this message.

fn encode_length_delimited(&self, buf: &mut impl BufMut)

Encode this message as a length-delimited byte sequence.

fn encode_to_vec(&self) -> Vec<u8>

Encode this message to a new Vec<u8>.

fn encode_to_bytes(&self) -> Bytes

Encode this message to a new bytes::Bytes.

fn decode(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a buffer.

fn decode_from_slice(data: &[u8]) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a byte slice.

fn decode_length_delimited(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a length-delimited message from a buffer.

fn merge_to_limit( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, limit: usize, ) -> Result<(), DecodeError>

Merge fields from a buffer until buf.remaining() reaches limit.

fn merge_group( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, field_number: u32, ) -> Result<(), DecodeError>

Merges a group-encoded message from buf, reading fields until an EndGroup tag with the given field_number is encountered.

fn merge( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Merge fields from a buffer into this message.

fn merge_from_slice(&mut self, data: &[u8]) -> Result<(), DecodeError>

Merge fields from a byte slice into this message.

fn merge_length_delimited( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Merge fields from a length-delimited sub-message payload into this message.

impl MessageName for ApiPolicySpec

const PACKAGE: &'static str = "auth.v1"

The protobuf package the message is declared in.

const NAME: &'static str = "ApiPolicySpec"

The unqualified message name, with . between nesting levels.

const FULL_NAME: &'static str = "auth.v1.ApiPolicySpec"

The fully-qualified protobuf type name with no leading dot.

const TYPE_URL: &'static str = "type.googleapis.com/auth.v1.ApiPolicySpec"

The google.protobuf.Any.type_url form for this message.

impl PartialEq for ApiPolicySpec

fn eq(&self, other: &ApiPolicySpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl ProtoElemJson for ApiPolicySpec

fn serialize_proto_json<S: Serializer>( v: &Self, s: S, ) -> Result<S::Ok, S::Error>

Serialize this value with proto3 JSON semantics.

fn deserialize_proto_json<'de, D: Deserializer<'de>>( d: D, ) -> Result<Self, D::Error>

Deserialize a value with proto3 JSON semantics.

impl Serialize for ApiPolicySpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ApiPolicySpec