Struct google_api_proto::google::api::Service

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<u32>,
}

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

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][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][google.api.Service.monitoring] and [Service.logging][google.api.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<u32>

Obsolete. Do not use.

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

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() -> Self

Returns the “default value” for a type.

impl Message for Service

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.

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

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for Service

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

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

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

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

impl StructuralPartialEq for Service