googleapis_tonic_google_iam_v3beta::google::api

Struct Service

Source
pub struct Service {
Show 26 fields 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>,
}
Expand description

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§

Source§

impl Clone for Service

Source§

fn clone(&self) -> Service

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Service

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Service

Source§

fn default() -> Service

Returns the “default value” for a type. Read more
Source§

impl Message for Service

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

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

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

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

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

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

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

Decodes an instance of the message from a buffer. Read more
Source§

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

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

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. Read more
Source§

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.
Source§

impl PartialEq for Service

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Service

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more