Skip to main content

Credential

Struct Credential 

Source
pub struct Credential {
Show 17 fields pub name: String, pub id: Option<String>, pub purpose: EnumValue<Purpose>, pub read_only: bool, pub comment: Option<String>, pub owner: Option<String>, pub created_at: Option<i64>, pub created_by: Option<String>, pub updated_at: Option<i64>, pub updated_by: Option<String>, pub used_for_managed_storage: bool, pub full_name: String, pub azure_service_principal: MessageField<AzureServicePrincipal>, pub azure_managed_identity: MessageField<AzureManagedIdentity>, pub azure_storage_key: MessageField<AzureStorageKey>, pub aws_iam_role: MessageField<AwsIamRoleConfig>, pub databricks_gcp_service_account: MessageField<DatabricksGcpServiceAccount>, /* private fields */
}
Expand description

A credential used to access external data sources or services.

Fields§

§name: String

The credential name.

The name must be unique among storage and service credentials within the metastore.

Field 1: name

§id: Option<String>

The unique identifier of the credential.

Field 2: id

§purpose: EnumValue<Purpose>

Indicates the purpose of the credential.

Field 3: purpose

§read_only: bool

Whether the credential is usable only for read operations.

Only applicable when purpose is STORAGE.

Field 4: read_only

§comment: Option<String>

Comment associated with the credential.

Field 5: comment

§owner: Option<String>

Username of current owner of credential.

Field 6: owner

§created_at: Option<i64>

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

Field 7: created_at

§created_by: Option<String>

Username of credential creator.

Field 8: created_by

§updated_at: Option<i64>

Time at which this credential was last modified, in epoch milliseconds.

Field 9: updated_at

§updated_by: Option<String>

Username of user who last modified the credential.

Field 10: updated_by

§used_for_managed_storage: bool

Whether this credential is the current metastore’s root storage credential.

Only applicable when purpose is STORAGE.

Field 11: used_for_managed_storage

§full_name: String

The full name of the credential.

Field 12: full_name

§azure_service_principal: MessageField<AzureServicePrincipal>

The Azure service principal configuration.

Sealed into the object’s inline sensitive blob (envelope-encrypted, redacted from ordinary reads) rather than stored in the searchable properties.

Field 100: azure_service_principal

§azure_managed_identity: MessageField<AzureManagedIdentity>

The Azure managed identity configuration.

Field 101: azure_managed_identity

§azure_storage_key: MessageField<AzureStorageKey>

The Azure storage key configuration.

Field 102: azure_storage_key

§aws_iam_role: MessageField<AwsIamRoleConfig>

The AWS IAM role configuration.

Field 103: aws_iam_role

§databricks_gcp_service_account: MessageField<DatabricksGcpServiceAccount>

The Databricks managed GCP service account configuration.

Field 104: databricks_gcp_service_account

Implementations§

Source§

impl Credential

Source

pub fn qualified_name(&self) -> String

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

Source§

impl Credential

Source

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

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

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

Source§

impl Credential

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Trait Implementations§

Source§

impl Clone for Credential

Source§

fn clone(&self) -> Credential

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Credential

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Credential

Source§

fn default() -> Credential

Returns the “default value” for a type. Read more
Source§

impl DefaultInstance for Credential

Source§

fn default_instance() -> &'static Self

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

impl<'de> Deserialize<'de> for Credential

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl ExtensionSet for Credential

Source§

const PROTO_FQN: &'static str = "unitycatalog.credentials.v1.Credential"

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

fn unknown_fields(&self) -> &UnknownFields

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

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

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

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

Read an extension value. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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

Remove all records at the extension’s field number. Read more
Source§

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. Read more
Source§

impl From<Credential> for Resource

Source§

fn from(v: Credential) -> Self

Converts to this type from the input type.
Source§

impl HasMessageView for Credential

Source§

type View<'a> = CredentialView<'a>

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

type ViewHandle = CredentialOwnedView

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

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

Decode a ViewHandle from a Bytes buffer. Read more
Source§

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). Read more
Source§

impl Message for Credential

Source§

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.

Source§

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). Read more
Source§

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. Read more
Source§

fn clear(&mut self)

Clear all fields to their default values.
Source§

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

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

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.
Source§

fn encoded_len(&self) -> u32

Compute the encoded byte size of this message. Read more
Source§

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

Encode this message as a length-delimited byte sequence.
Source§

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

Encode this message to a new Vec<u8>.
Source§

fn encode_to_bytes(&self) -> Bytes

Encode this message to a new bytes::Bytes. Read more
Source§

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

Decode a message from a buffer.
Source§

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

Decode a message from a byte slice. Read more
Source§

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

Decode a length-delimited message from a buffer. Read more
Source§

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. Read more
Source§

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. Read more
Source§

fn merge(&mut self, buf: &mut impl Buf, depth: u32) -> Result<(), DecodeError>

Merge fields from a buffer into this message. Read more
Source§

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

Merge fields from a byte slice into this message. Read more
Source§

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. Read more
Source§

impl MessageName for Credential

Source§

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

The protobuf package the message is declared in. Read more
Source§

const NAME: &'static str = "Credential"

The unqualified message name, with . between nesting levels. Read more
Source§

const FULL_NAME: &'static str = "unitycatalog.credentials.v1.Credential"

The fully-qualified protobuf type name with no leading dot. Read more
Source§

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

The google.protobuf.Any.type_url form for this message. Read more
Source§

impl PartialEq for Credential

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl ProtoElemJson for Credential

Source§

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

Serialize this value with proto3 JSON semantics.
Source§

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

Deserialize a value with proto3 JSON semantics.
Source§

impl ResourceExt for Credential

Source§

fn resource_name(&self) -> ResourceName

Get the name of the resource
Source§

fn resource_ref(&self) -> ResourceRef

Get the reference for the resource Read more
Source§

fn resource_ident(&self) -> ResourceIdent

Get the ident for the resource
Source§

impl Serialize for Credential

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Credential

Source§

impl TryFrom<Credential> for Object

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<Object<ObjectLabel>> for Credential

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<Resource> for Credential

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more