Struct Function 

#[non_exhaustive]
pub struct Function {

    pub name: String,
    pub description: String,
    pub build_config: Option<BuildConfig>,
    pub service_config: Option<ServiceConfig>,
    pub event_trigger: Option<EventTrigger>,
    pub state: State,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub state_messages: Vec<StateMessage>,
    pub environment: Environment,
    pub url: String,
    pub kms_key_name: String,
    pub satisfies_pzs: bool,
    pub create_time: Option<Timestamp>,
    /* private fields */
}

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.

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.

name: String

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

description: String

User-provided description of a function.

build_config: Option<BuildConfig>

Describes the Build step of the function that builds a container from the given source.

service_config: Option<ServiceConfig>

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

event_trigger: Option<EventTrigger>

An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.

state: State

Output only. State of the function.

update_time: Option<Timestamp>

Output only. The last update timestamp of a Cloud Function.

labels: HashMap<String, String>

Labels associated with this Cloud Function.

state_messages: Vec<StateMessage>

Output only. State Messages for this Cloud Function.

environment: Environment

Describe whether the function is 1st Gen or 2nd Gen.

url: String

Output only. The deployed url for the function.

kms_key_name: String

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

satisfies_pzs: bool

Output only. Reserved for future use.

create_time: Option<Timestamp>

Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.

Implementations

impl Function

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Function::new().set_name(format!("projects/{project_id}/locations/{location_id}/functions/{function_id}"));

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

Sets the value of description.

Example

let x = Function::new().set_description("example");

pub fn set_build_config<T>(self, v: T) -> Self

where T: Into<BuildConfig>,

Sets the value of build_config.

Example

use google_cloud_functions_v2::model::BuildConfig;
let x = Function::new().set_build_config(BuildConfig::default()/* use setters */);

pub fn set_or_clear_build_config<T>(self, v: Option<T>) -> Self

where T: Into<BuildConfig>,

Sets or clears the value of build_config.

Example

use google_cloud_functions_v2::model::BuildConfig;
let x = Function::new().set_or_clear_build_config(Some(BuildConfig::default()/* use setters */));
let x = Function::new().set_or_clear_build_config(None::<BuildConfig>);

pub fn set_service_config<T>(self, v: T) -> Self

where T: Into<ServiceConfig>,

Sets the value of service_config.

Example

use google_cloud_functions_v2::model::ServiceConfig;
let x = Function::new().set_service_config(ServiceConfig::default()/* use setters */);

pub fn set_or_clear_service_config<T>(self, v: Option<T>) -> Self

where T: Into<ServiceConfig>,

Sets or clears the value of service_config.

Example

use google_cloud_functions_v2::model::ServiceConfig;
let x = Function::new().set_or_clear_service_config(Some(ServiceConfig::default()/* use setters */));
let x = Function::new().set_or_clear_service_config(None::<ServiceConfig>);

pub fn set_event_trigger<T>(self, v: T) -> Self

where T: Into<EventTrigger>,

Sets the value of event_trigger.

Example

use google_cloud_functions_v2::model::EventTrigger;
let x = Function::new().set_event_trigger(EventTrigger::default()/* use setters */);

pub fn set_or_clear_event_trigger<T>(self, v: Option<T>) -> Self

where T: Into<EventTrigger>,

Sets or clears the value of event_trigger.

Example

use google_cloud_functions_v2::model::EventTrigger;
let x = Function::new().set_or_clear_event_trigger(Some(EventTrigger::default()/* use setters */));
let x = Function::new().set_or_clear_event_trigger(None::<EventTrigger>);

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_functions_v2::model::function::State;
let x0 = Function::new().set_state(State::Active);
let x1 = Function::new().set_state(State::Failed);
let x2 = Function::new().set_state(State::Deploying);

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = Function::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = Function::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = Function::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = Function::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_state_messages<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<StateMessage>,

Sets the value of state_messages.

Example

use google_cloud_functions_v2::model::StateMessage;
let x = Function::new()
    .set_state_messages([
        StateMessage::default()/* use setters */,
        StateMessage::default()/* use (different) setters */,
    ]);

pub fn set_environment<T: Into<Environment>>(self, v: T) -> Self

Sets the value of environment.

Example

use google_cloud_functions_v2::model::Environment;
let x0 = Function::new().set_environment(Environment::Gen1);
let x1 = Function::new().set_environment(Environment::Gen2);

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

Sets the value of url.

Example

let x = Function::new().set_url("example");

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

Sets the value of kms_key_name.

Example

let x = Function::new().set_kms_key_name("example");

pub fn set_satisfies_pzs<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzs.

Example

let x = Function::new().set_satisfies_pzs(true);

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = Function::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = Function::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Function::new().set_or_clear_create_time(None::<Timestamp>);

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Default for Function

fn default() -> Function

Returns the “default value” for a type.

impl Message for Function

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Function

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Function