Struct gapi_grpc::google::cloud::functions::v1::CloudFunction

pub struct CloudFunction {
    pub name: String,
    pub description: String,
    pub status: i32,
    pub entry_point: String,
    pub runtime: String,
    pub timeout: Option<Duration>,
    pub available_memory_mb: i32,
    pub service_account_email: String,
    pub update_time: Option<Timestamp>,
    pub version_id: i64,
    pub labels: HashMap<String, String>,
    pub environment_variables: HashMap<String, String>,
    pub network: String,
    pub max_instances: i32,
    pub vpc_connector: String,
    pub vpc_connector_egress_settings: i32,
    pub ingress_settings: i32,
    pub build_id: String,
    pub source_code: Option<SourceCode>,
    pub trigger: Option<Trigger>,
}

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

Fields

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.

status: i32

Output only. Status of the function deployment.

entry_point: String

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named “function”. For Node.js this is name of a function exported by the module specified in source_location.

runtime: String

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

timeout: Option<Duration>

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

available_memory_mb: i32

The amount of memory in MB available for a function. Defaults to 256MB.

service_account_email: String

The email of the function’s service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

update_time: Option<Timestamp>

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

version_id: i64

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

labels: HashMap<String, String>

Labels associated with this Cloud Function.

environment_variables: HashMap<String, String>

Environment variables that shall be available during function execution.

network: String

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network.

This field is mutually exclusive with vpc_connector and will be replaced by it.

See the VPC documentation for more information on connecting Cloud projects.

max_instances: i32

The limit on the maximum number of function instances that may coexist at a given time.

vpc_connector: String

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/*

This field is mutually exclusive with network field and will eventually replace it.

See the VPC documentation for more information on connecting Cloud projects.

vpc_connector_egress_settings: i32

The egress settings for the connector, controlling what traffic is diverted through it.

ingress_settings: i32

The ingress settings for the function, controlling what traffic can reach it.

build_id: String

Output only. The Cloud Build ID of the latest successful deployment of the function.

source_code: Option<SourceCode>

The location of the function source code.

trigger: Option<Trigger>

An event that triggers the function.

Implementations

impl CloudFunction

pub fn status(&self) -> CloudFunctionStatus

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

pub fn set_status(&mut self, value: CloudFunctionStatus)

Sets status to the provided enum value.

pub fn vpc_connector_egress_settings(&self) -> VpcConnectorEgressSettings

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

pub fn set_vpc_connector_egress_settings(
    &mut self,
    value: VpcConnectorEgressSettings
)

Sets vpc_connector_egress_settings to the provided enum value.

pub fn ingress_settings(&self) -> IngressSettings

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

pub fn set_ingress_settings(&mut self, value: IngressSettings)

Sets ingress_settings to the provided enum value.

Trait Implementations

impl Clone for CloudFunction

fn clone(&self) -> CloudFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CloudFunction

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

Formats the value using the given formatter.

impl Default for CloudFunction

fn default() -> CloudFunction

Returns the “default value” for a type.

impl Message for CloudFunction

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<CloudFunction> for CloudFunction

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

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

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

This method tests for !=.

impl StructuralPartialEq for CloudFunction