Struct Volume 

pub struct Volume {

    pub name: String,
    pub catalog_name: String,
    pub schema_name: String,
    pub full_name: String,
    pub storage_location: String,
    pub volume_id: String,
    pub volume_type: EnumValue<VolumeType>,
    pub owner: Option<String>,
    pub comment: Option<String>,
    pub created_at: Option<i64>,
    pub created_by: Option<String>,
    pub updated_at: Option<i64>,
    pub updated_by: Option<String>,
    pub browse_only: Option<bool>,
    pub metastore_id: Option<String>,
    /* private fields */
}

Fields

name: String

Name of volume, relative to parent schema.

Field 1: name

catalog_name: String

Name of parent catalog.

Field 2: catalog_name

schema_name: String

Name of parent schema.

Field 3: schema_name

full_name: String

The three-level (fully qualified) name of the volume

Field 4: full_name

storage_location: String

The storage location on the cloud

Field 5: storage_location

volume_id: String

The unique identifier of the volume

Field 6: volume_id

volume_type: EnumValue<VolumeType>

The type of the volume.

An external volume is located in the specified external location. A managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.

Field 7: volume_type

owner: Option<String>

Username of current owner of table.

Field 8: owner

comment: Option<String>

User-provided free-form text description.

Field 9: comment

created_at: Option<i64>

Time at which this catalog was created, in epoch milliseconds.

Field 1000: created_at

created_by: Option<String>

Username of catalog creator.

Field 1001: created_by

updated_at: Option<i64>

Time at which this catalog was last updated, in epoch milliseconds.

Field 1002: updated_at

updated_by: Option<String>

Username of user who last modified catalog.

Field 1003: updated_by

browse_only: Option<bool>

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

Field 1004: browse_only

metastore_id: Option<String>

The unique identifier of the metastore

Field 1005: metastore_id

Implementations

impl Volume

pub fn qualified_name(&self) -> String

Returns the fully-qualified dot-separated name computed from component fields.

impl Volume

pub const TYPE_URL: &'static str = "type.googleapis.com/unitycatalog.volumes.v1.Volume"

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

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

impl Volume

pub fn with_owner(self, value: impl Into<String>) -> Self

Sets Self::owner to Some(value), consuming and returning self.

pub fn with_comment(self, value: impl Into<String>) -> Self

Sets Self::comment to Some(value), consuming and returning self.

pub fn with_created_at(self, value: i64) -> Self

Sets Self::created_at to Some(value), consuming and returning self.

pub fn with_created_by(self, value: impl Into<String>) -> Self

Sets Self::created_by to Some(value), consuming and returning self.

pub fn with_updated_at(self, value: i64) -> Self

Sets Self::updated_at to Some(value), consuming and returning self.

pub fn with_updated_by(self, value: impl Into<String>) -> Self

Sets Self::updated_by to Some(value), consuming and returning self.

pub fn with_browse_only(self, value: bool) -> Self

Sets Self::browse_only to Some(value), consuming and returning self.

pub fn with_metastore_id(self, value: impl Into<String>) -> Self

Sets Self::metastore_id to Some(value), consuming and returning self.

Trait Implementations

impl Clone for Volume

fn clone(&self) -> Volume

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Volume

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

Formats the value using the given formatter.

impl Default for Volume

fn default() -> Volume

Returns the “default value” for a type.

impl DefaultInstance for Volume

fn default_instance() -> &'static Self

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

impl<'de> Deserialize<'de> for Volume

where Volume: 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 Volume

const PROTO_FQN: &'static str = "unitycatalog.volumes.v1.Volume"

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 From<Volume> for Resource

fn from(v: Volume) -> Self

Converts to this type from the input type.

impl HasMessageView for Volume

type View<'a> = VolumeView<'a>

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

type ViewHandle = VolumeOwnedView

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

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 Volume

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, depth: u32, ) -> 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, depth: u32, limit: usize, ) -> Result<(), DecodeError>

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

fn merge_group( &mut self, buf: &mut impl Buf, depth: u32, 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, depth: u32) -> 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, depth: u32, ) -> Result<(), DecodeError>

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

impl MessageName for Volume

const PACKAGE: &'static str = "unitycatalog.volumes.v1"

The protobuf package the message is declared in.

const NAME: &'static str = "Volume"

The unqualified message name, with . between nesting levels.

const FULL_NAME: &'static str = "unitycatalog.volumes.v1.Volume"

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

const TYPE_URL: &'static str = "type.googleapis.com/unitycatalog.volumes.v1.Volume"

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

impl PartialEq for Volume

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

Equality operator ==.

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

Inequality operator !=.

impl ProtoElemJson for Volume

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 ResourceExt for Volume

fn resource_name(&self) -> ResourceName

Get the name of the resource

fn resource_ref(&self) -> ResourceRef

Get the reference for the resource

fn resource_ident(&self) -> ResourceIdent

Get the ident for the resource

impl Serialize for Volume

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 Volume

impl TryFrom<Object<ObjectLabel>> for Volume

type Error = Error

The type returned in the event of a conversion error.

fn try_from(object: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Resource> for Volume

type Error = Error

The type returned in the event of a conversion error.

fn try_from(r: Resource) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Volume> for Object

type Error = Error

The type returned in the event of a conversion error.

fn try_from(obj: Volume) -> Result<Self, Self::Error>

Performs the conversion.