Struct Service

#[non_exhaustive]
pub struct Service {

    pub name: String,
    pub description: String,
    pub uid: String,
    pub generation: i64,
    pub labels: HashMap<String, String>,
    pub annotations: HashMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub delete_time: Option<Timestamp>,
    pub expire_time: Option<Timestamp>,
    pub creator: String,
    pub last_modifier: String,
    pub client: String,
    pub client_version: String,
    pub ingress: IngressTraffic,
    pub launch_stage: LaunchStage,
    pub binary_authorization: Option<BinaryAuthorization>,
    pub template: Option<RevisionTemplate>,
    pub traffic: Vec<TrafficTarget>,
    pub scaling: Option<ServiceScaling>,
    pub invoker_iam_disabled: bool,
    pub default_uri_disabled: bool,
    pub urls: Vec<String>,
    pub custom_audiences: Vec<String>,
    pub observed_generation: i64,
    pub terminal_condition: Option<Condition>,
    pub conditions: Vec<Condition>,
    pub latest_ready_revision: String,
    pub latest_created_revision: String,
    pub traffic_statuses: Vec<TrafficTargetStatus>,
    pub uri: String,
    pub satisfies_pzs: bool,
    pub build_config: Option<BuildConfig>,
    pub reconciling: bool,
    pub etag: String,
    /* private fields */
}

Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.

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

The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id.

Format: projects/{project}/locations/{location}/services/{service_id}

description: String

User-provided description of the Service. This field currently has a 512-character limit.

uid: String

Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

generation: i64

Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

labels: HashMap<String, String>

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google’s billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

annotations: HashMap<String, String>

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

create_time: Option<Timestamp>

Output only. The creation time.

update_time: Option<Timestamp>

Output only. The last-modified time.

delete_time: Option<Timestamp>

Output only. The deletion time. It is only populated as a response to a Delete request.

expire_time: Option<Timestamp>

Output only. For a deleted resource, the time after which it will be permanently deleted.

creator: String

Output only. Email address of the authenticated creator.

last_modifier: String

Output only. Email address of the last authenticated modifier.

client: String

Arbitrary identifier for the API client.

client_version: String

Arbitrary version identifier for the API client.

ingress: IngressTraffic

Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.

launch_stage: LaunchStage

Optional. The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

binary_authorization: Option<BinaryAuthorization>

Optional. Settings for the Binary Authorization feature.

template: Option<RevisionTemplate>

Required. The template used to create revisions for this Service.

traffic: Vec<TrafficTarget>

Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.

scaling: Option<ServiceScaling>

Optional. Specifies service-level scaling settings

invoker_iam_disabled: bool

Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This feature is available by invitation only. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.

default_uri_disabled: bool

Optional. Disables public resolution of the default URI of this service.

urls: Vec<String>

Output only. All URLs serving traffic for this Service.

custom_audiences: Vec<String>

One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.

observed_generation: i64

Output only. The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

terminal_condition: Option<Condition>

Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

conditions: Vec<Condition>

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

latest_ready_revision: String

Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

latest_created_revision: String

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.

traffic_statuses: Vec<TrafficTargetStatus>

Output only. Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run.

uri: String

Output only. The main URI in which this Service is serving traffic.

satisfies_pzs: bool

Output only. Reserved for future use.

build_config: Option<BuildConfig>

Optional. Configuration for building a Cloud Run function.

reconciling: bool

Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state.

When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revision, traffic_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state.

If reconciliation succeeded, the following fields will match: traffic and traffic_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision.

If reconciliation failed, traffic_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminal_condition and conditions.

etag: String

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Implementations

impl Service

pub fn new() -> Self

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

Sets the value of name.

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

Sets the value of description.

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

Sets the value of uid.

pub fn set_generation<T: Into<i64>>(self, v: T) -> Self

Sets the value of generation.

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

Sets the value of create_time.

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

Sets the value of update_time.

pub fn set_delete_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of delete_time.

pub fn set_expire_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of expire_time.

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

Sets the value of creator.

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

Sets the value of last_modifier.

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

Sets the value of client.

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

Sets the value of client_version.

pub fn set_ingress<T: Into<IngressTraffic>>(self, v: T) -> Self

Sets the value of ingress.

pub fn set_launch_stage<T: Into<LaunchStage>>(self, v: T) -> Self

Sets the value of launch_stage.

pub fn set_binary_authorization<T: Into<Option<BinaryAuthorization>>>( self, v: T, ) -> Self

Sets the value of binary_authorization.

pub fn set_template<T: Into<Option<RevisionTemplate>>>(self, v: T) -> Self

Sets the value of template.

pub fn set_scaling<T: Into<Option<ServiceScaling>>>(self, v: T) -> Self

Sets the value of scaling.

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

Sets the value of invoker_iam_disabled.

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

Sets the value of default_uri_disabled.

pub fn set_observed_generation<T: Into<i64>>(self, v: T) -> Self

Sets the value of observed_generation.

pub fn set_terminal_condition<T: Into<Option<Condition>>>(self, v: T) -> Self

Sets the value of terminal_condition.

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

Sets the value of latest_ready_revision.

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

Sets the value of latest_created_revision.

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

Sets the value of uri.

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

Sets the value of satisfies_pzs.

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

Sets the value of build_config.

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

Sets the value of reconciling.

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

Sets the value of etag.

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

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

Sets the value of traffic.

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

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

Sets the value of urls.

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

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

Sets the value of custom_audiences.

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

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

Sets the value of conditions.

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

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

Sets the value of traffic_statuses.

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.

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

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

Sets the value of annotations.

Trait Implementations

impl Clone for Service

fn clone(&self) -> Service

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Service

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

Formats the value using the given formatter.

impl Default for Service

fn default() -> Service

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Service

where Service: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Service

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for Service

fn eq(&self, other: &Service) -> 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 Serialize for Service

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Service