Struct ApiKeyConfig 

#[non_exhaustive]
pub struct ApiKeyConfig {
    pub key_name: String,
    pub api_key: String,
    pub secret_version_for_api_key: String,
    pub request_location: RequestLocation,
    /* private fields */
}

Available on crate feature tools only.

Config for authentication with API key.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_name: String

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

api_key: String

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

secret_version_for_api_key: String

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}

request_location: RequestLocation

Required. Key location in the request.

Implementations

impl ApiKeyConfig

pub fn new() -> Self

pub fn set_key_name<T: Into<String>>(self, v: T) -> Self

Sets the value of key_name.

Example

let x = ApiKeyConfig::new().set_key_name("example");

pub fn set_api_key<T: Into<String>>(self, v: T) -> Self

Sets the value of api_key.

Example

let x = ApiKeyConfig::new().set_api_key("example");

pub fn set_secret_version_for_api_key<T: Into<String>>(self, v: T) -> Self

Sets the value of secret_version_for_api_key.

Example

let x = ApiKeyConfig::new().set_secret_version_for_api_key("example");

pub fn set_request_location<T: Into<RequestLocation>>(self, v: T) -> Self

Sets the value of request_location.

Example

use google_cloud_dialogflow_v2::model::tool::authentication::RequestLocation;
let x0 = ApiKeyConfig::new().set_request_location(RequestLocation::Header);
let x1 = ApiKeyConfig::new().set_request_location(RequestLocation::QueryString);

Trait Implementations

impl Clone for ApiKeyConfig

fn clone(&self) -> ApiKeyConfig

Returns a duplicate 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() -> ApiKeyConfig

Returns the “default value” for a type.

impl Message for ApiKeyConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ApiKeyConfig

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ApiKeyConfig