Struct Service

#[non_exhaustive]
pub struct Service {

    pub name: String,
    pub title: String,
    pub producer_project_id: String,
    pub id: String,
    pub apis: Vec<Api>,
    pub types: Vec<Type>,
    pub enums: Vec<Enum>,
    pub documentation: Option<Documentation>,
    pub backend: Option<Backend>,
    pub http: Option<Http>,
    pub quota: Option<Quota>,
    pub authentication: Option<Authentication>,
    pub context: Option<Context>,
    pub usage: Option<Usage>,
    pub endpoints: Vec<Endpoint>,
    pub control: Option<Control>,
    pub logs: Vec<LogDescriptor>,
    pub metrics: Vec<MetricDescriptor>,
    pub monitored_resources: Vec<MonitoredResourceDescriptor>,
    pub billing: Option<Billing>,
    pub logging: Option<Logging>,
    pub monitoring: Option<Monitoring>,
    pub system_parameters: Option<SystemParameters>,
    pub source_info: Option<SourceInfo>,
    pub publishing: Option<Publishing>,
    pub config_version: Option<UInt32Value>,
}

Service is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition.

Example:

type: google.api.Service
name: calendar.googleapis.com
title: Google Calendar API
apis:
- name: google.calendar.v3.Calendar

visibility:
  rules:
  - selector: "google.calendar.v3.*"
    restriction: PREVIEW
backend:
  rules:
  - selector: "google.calendar.v3.*"
    address: calendar.example.com

authentication:
  providers:
  - id: google_calendar_auth
    jwks_uri: https://www.googleapis.com/oauth2/v1/certs
    issuer: https://securetoken.google.com
  rules:
  - selector: "*"
    requirements:
      provider_id: google_calendar_auth

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 service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

title: String

The product title for this service, it is the name displayed in Google Cloud Console.

producer_project_id: String

The Google project that owns this service.

id: String

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, ‘.’, ‘_’ and ‘-’ are allowed. If empty, the server may choose to generate one instead.

apis: Vec<Api>

A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

types: Vec<Type>

A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example:

types:
- name: google.protobuf.Int32

enums: Vec<Enum>

A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example:

enums:
- name: google.someapi.v1.SomeEnum

documentation: Option<Documentation>

Additional API documentation.

backend: Option<Backend>

API backend configuration.

http: Option<Http>

HTTP configuration.

quota: Option<Quota>

Quota configuration.

authentication: Option<Authentication>

Auth configuration.

context: Option<Context>

Context configuration.

usage: Option<Usage>

Configuration controlling usage of this service.

endpoints: Vec<Endpoint>

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

control: Option<Control>

Configuration for the service control plane.

logs: Vec<LogDescriptor>

Defines the logs used by this service.

metrics: Vec<MetricDescriptor>

Defines the metrics used by this service.

monitored_resources: Vec<MonitoredResourceDescriptor>

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

billing: Option<Billing>

Billing configuration.

logging: Option<Logging>

Logging configuration.

monitoring: Option<Monitoring>

Monitoring configuration.

system_parameters: Option<SystemParameters>

System parameter configuration.

source_info: Option<SourceInfo>

Output only. The source information for this configuration if available.

publishing: Option<Publishing>

Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.

config_version: Option<UInt32Value>

Obsolete. Do not use.

This field has no semantic meaning. The service config compiler always sets this field to 3.

Implementations

impl Service

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

Sets the value of name.

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

Sets the value of title.

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

Sets the value of producer_project_id.

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

Sets the value of id.

pub fn set_documentation<T: Into<Option<Documentation>>>(self, v: T) -> Self

Sets the value of documentation.

pub fn set_backend<T: Into<Option<Backend>>>(self, v: T) -> Self

Sets the value of backend.

pub fn set_http<T: Into<Option<Http>>>(self, v: T) -> Self

Sets the value of http.

pub fn set_quota<T: Into<Option<Quota>>>(self, v: T) -> Self

Sets the value of quota.

pub fn set_authentication<T: Into<Option<Authentication>>>(self, v: T) -> Self

Sets the value of authentication.

pub fn set_context<T: Into<Option<Context>>>(self, v: T) -> Self

Sets the value of context.

pub fn set_usage<T: Into<Option<Usage>>>(self, v: T) -> Self

Sets the value of usage.

pub fn set_control<T: Into<Option<Control>>>(self, v: T) -> Self

Sets the value of control.

pub fn set_billing<T: Into<Option<Billing>>>(self, v: T) -> Self

Sets the value of billing.

pub fn set_logging<T: Into<Option<Logging>>>(self, v: T) -> Self

Sets the value of logging.

pub fn set_monitoring<T: Into<Option<Monitoring>>>(self, v: T) -> Self

Sets the value of monitoring.

pub fn set_system_parameters<T: Into<Option<SystemParameters>>>( self, v: T, ) -> Self

Sets the value of system_parameters.

pub fn set_source_info<T: Into<Option<SourceInfo>>>(self, v: T) -> Self

Sets the value of source_info.

pub fn set_publishing<T: Into<Option<Publishing>>>(self, v: T) -> Self

Sets the value of publishing.

pub fn set_config_version<T: Into<Option<UInt32Value>>>(self, v: T) -> Self

Sets the value of config_version.

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

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

Sets the value of apis.

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

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

Sets the value of types.

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

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

Sets the value of enums.

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

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

Sets the value of endpoints.

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

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

Sets the value of logs.

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

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

Sets the value of metrics.

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

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

Sets the value of monitored_resources.

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.

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