Struct google_api_proto::google::cloud::aiplatform::v1beta1::auth_config::ApiKeyConfig

pub struct ApiKeyConfig {
    pub name: String,
    pub api_key_secret: String,
    pub http_element_location: i32,
}

Config for authentication with API key.

Fields

name: String

Required. The parameter name of the API key. E.g. If the API request is “<https://example.com/act?api_key= KEY>”, “api_key” would be the parameter name.

api_key_secret: String

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}

• If specified, the secretmanager.versions.access permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.

http_element_location: i32

Required. The location of the API key.

Implementations

impl ApiKeyConfig

pub fn http_element_location(&self) -> HttpElementLocation

Returns the enum value of http_element_location, or the default if the field is set to an invalid enum value.

pub fn set_http_element_location(&mut self, value: HttpElementLocation)

Sets http_element_location to the provided enum value.

Trait Implementations

impl Clone for ApiKeyConfig

fn clone(&self) -> ApiKeyConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyConfig

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

Formats the value using the given formatter.

impl Default for ApiKeyConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for ApiKeyConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

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

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

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

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

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

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ApiKeyConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ApiKeyConfig