`Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the 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. See each proto message definition for details.

Example:

type: google.api.Service
config_version: 3
name: calendar.googleapis.com
title: Google Calendar API
apis:
- name: google.calendar.v3.Calendar
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

Generated from protobuf message google.api.Service

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 
Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::clear()
    public Google\Protobuf\Internal\Message::discardUnknownFields()
    public getApis()
     
    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.

    Generated from protobuf field repeated .google.protobuf.Api apis = 3;

    public getAuthentication()
     
    Auth configuration.

    Generated from protobuf field .google.api.Authentication authentication = 11;

    public getBackend()
     
    API backend configuration.

    Generated from protobuf field .google.api.Backend backend = 8;

    public getBilling()
     
    Billing configuration.

    Generated from protobuf field .google.api.Billing billing = 26;

    public getConfigVersion()
     
    The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions.

    The latest config version is 3.

    Generated from protobuf field .google.protobuf.UInt32Value config_version = 20;

    public getConfigVersionUnwrapped()
     
    Returns the unboxed value from getConfigVersion()

    The semantic version of the service configuration. The config version
    affects the interpretation of the service configuration. For example,
    certain features are enabled by default for certain config versions.
    The latest config version is 3.

    Generated from protobuf field .google.protobuf.UInt32Value config_version = 20;

    • return int|null
    public getContext()
     
    Context configuration.

    Generated from protobuf field .google.api.Context context = 12;

    public getControl()
     
    Configuration for the service control plane.

    Generated from protobuf field .google.api.Control control = 21;

    public getDocumentation()
     
    Additional API documentation.

    Generated from protobuf field .google.api.Documentation documentation = 6;

    public getEndpoints()
     
    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.

    Generated from protobuf field repeated .google.api.Endpoint endpoints = 18;

    public getEnums()
     
    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. Example: enums: - name: google.someapi.v1.SomeEnum

    Generated from protobuf field repeated .google.protobuf.Enum enums = 5;

    public getHttp()
     
    HTTP configuration.

    Generated from protobuf field .google.api.Http http = 9;

    public getId()
     
    A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.

    Generated from protobuf field string id = 33;

    • return string
    public getLogging()
     
    Logging configuration.

    Generated from protobuf field .google.api.Logging logging = 27;

    public getLogs()
     
    Defines the logs used by this service.

    Generated from protobuf field repeated .google.api.LogDescriptor logs = 23;

    public getMetrics()
     
    Defines the metrics used by this service.

    Generated from protobuf field repeated .google.api.MetricDescriptor metrics = 24;

    public getMonitoredResources()
     
    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.

    Generated from protobuf field repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;

    public getMonitoring()
     
    Monitoring configuration.

    Generated from protobuf field .google.api.Monitoring monitoring = 28;

    public getName()
     
    The DNS address at which this service is available, e.g. `calendar.googleapis.com`.

    Generated from protobuf field string name = 1;

    • return string
    public getProducerProjectId()
     
    The Google project that owns this service.

    Generated from protobuf field string producer_project_id = 22;

    • return string
    public getQuota()
     
    Quota configuration.

    Generated from protobuf field .google.api.Quota quota = 10;

    public getSourceInfo()
     
    Output only. The source information for this configuration if available.

    Generated from protobuf field .google.api.SourceInfo source_info = 37;

    public getSystemParameters()
     
    System parameter configuration.

    Generated from protobuf field .google.api.SystemParameters system_parameters = 29;

    public getTitle()
     
    The product title for this service.

    Generated from protobuf field string title = 2;

    • return string
    public getTypes()
     
    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. Example:

    types:
    - name: google.protobuf.Int32
    

    Generated from protobuf field repeated .google.protobuf.Type types = 4;

    public getUsage()
     
    Configuration controlling usage of this service.

    Generated from protobuf field .google.api.Usage usage = 15;

    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     
    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     
    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setApis( $var)
     
    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.

    Generated from protobuf field repeated .google.protobuf.Api apis = 3;

    • return $this
    public setAuthentication( $var)
     
    Auth configuration.

    Generated from protobuf field .google.api.Authentication authentication = 11;

    • return $this
    public setBackend( $var)
     
    API backend configuration.

    Generated from protobuf field .google.api.Backend backend = 8;

    • return $this
    public setBilling( $var)
     
    Billing configuration.

    Generated from protobuf field .google.api.Billing billing = 26;

    • return $this
    public setConfigVersion( $var)
     
    The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions.

    The latest config version is 3.

    Generated from protobuf field .google.protobuf.UInt32Value config_version = 20;

    • return $this
    public setConfigVersionUnwrapped( $var)
     
    Sets the field by wrapping a primitive type in a Google\Protobuf\UInt32Value object.

    The semantic version of the service configuration. The config version
    affects the interpretation of the service configuration. For example,
    certain features are enabled by default for certain config versions.
    The latest config version is 3.

    Generated from protobuf field .google.protobuf.UInt32Value config_version = 20;

    • return $this
    public setContext( $var)
     
    Context configuration.

    Generated from protobuf field .google.api.Context context = 12;

    • return $this
    public setControl( $var)
     
    Configuration for the service control plane.

    Generated from protobuf field .google.api.Control control = 21;

    • return $this
    public setDocumentation( $var)
     
    Additional API documentation.

    Generated from protobuf field .google.api.Documentation documentation = 6;

    • return $this
    public setEndpoints( $var)
     
    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.

    Generated from protobuf field repeated .google.api.Endpoint endpoints = 18;

    • return $this
    public setEnums( $var)
     
    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. Example: enums: - name: google.someapi.v1.SomeEnum

    Generated from protobuf field repeated .google.protobuf.Enum enums = 5;

    • return $this
    public setHttp( $var)
     
    HTTP configuration.

    Generated from protobuf field .google.api.Http http = 9;

    • return $this
    public setId( $var)
     
    A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.

    Generated from protobuf field string id = 33;

    • return $this
    public setLogging( $var)
     
    Logging configuration.

    Generated from protobuf field .google.api.Logging logging = 27;

    • return $this
    public setLogs( $var)
     
    Defines the logs used by this service.

    Generated from protobuf field repeated .google.api.LogDescriptor logs = 23;

    • return $this
    public setMetrics( $var)
     
    Defines the metrics used by this service.

    Generated from protobuf field repeated .google.api.MetricDescriptor metrics = 24;

    • return $this
    public setMonitoredResources( $var)
     
    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.

    Generated from protobuf field repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;

    • return $this
    public setMonitoring( $var)
     
    Monitoring configuration.

    Generated from protobuf field .google.api.Monitoring monitoring = 28;

    • return $this
    public setName( $var)
     
    The DNS address at which this service is available, e.g. `calendar.googleapis.com`.

    Generated from protobuf field string name = 1;

    • return $this
    public setProducerProjectId( $var)
     
    The Google project that owns this service.

    Generated from protobuf field string producer_project_id = 22;

    • return $this
    public setQuota( $var)
     
    Quota configuration.

    Generated from protobuf field .google.api.Quota quota = 10;

    • return $this
    public setSourceInfo( $var)
     
    Output only. The source information for this configuration if available.

    Generated from protobuf field .google.api.SourceInfo source_info = 37;

    • return $this
    public setSystemParameters( $var)
     
    System parameter configuration.

    Generated from protobuf field .google.api.SystemParameters system_parameters = 29;

    • return $this
    public setTitle( $var)
     
    The product title for this service.

    Generated from protobuf field string title = 2;

    • return $this
    public setTypes( $var)
     
    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. Example:

    types:
    - name: google.protobuf.Int32
    

    Generated from protobuf field repeated .google.protobuf.Type types = 4;

    • return $this
    public setUsage( $var)
     
    Configuration controlling usage of this service.

    Generated from protobuf field .google.api.Usage usage = 15;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $apis
     
    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.

    Generated from protobuf field repeated .google.protobuf.Api apis = 3;

    private $authentication
     
    Auth configuration.

    Generated from protobuf field .google.api.Authentication authentication = 11;

    private $backend
     
    API backend configuration.

    Generated from protobuf field .google.api.Backend backend = 8;

    private $billing
     
    Billing configuration.

    Generated from protobuf field .google.api.Billing billing = 26;

    private $config_version
     
    The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions.

    The latest config version is 3.

    Generated from protobuf field .google.protobuf.UInt32Value config_version = 20;

    private $context
     
    Context configuration.

    Generated from protobuf field .google.api.Context context = 12;

    private $control
     
    Configuration for the service control plane.

    Generated from protobuf field .google.api.Control control = 21;

    private $documentation
     
    Additional API documentation.

    Generated from protobuf field .google.api.Documentation documentation = 6;

    private $endpoints
     
    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.

    Generated from protobuf field repeated .google.api.Endpoint endpoints = 18;

    private $enums
     
    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. Example: enums: - name: google.someapi.v1.SomeEnum

    Generated from protobuf field repeated .google.protobuf.Enum enums = 5;

    private $http
     
    HTTP configuration.

    Generated from protobuf field .google.api.Http http = 9;

    private $id
     
    A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.

    Generated from protobuf field string id = 33;

    private $logging
     
    Logging configuration.

    Generated from protobuf field .google.api.Logging logging = 27;

    private $logs
     
    Defines the logs used by this service.

    Generated from protobuf field repeated .google.api.LogDescriptor logs = 23;

    private $metrics
     
    Defines the metrics used by this service.

    Generated from protobuf field repeated .google.api.MetricDescriptor metrics = 24;

    private $monitored_resources
     
    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.

    Generated from protobuf field repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;

    private $monitoring
     
    Monitoring configuration.

    Generated from protobuf field .google.api.Monitoring monitoring = 28;

    private $name
     
    The DNS address at which this service is available, e.g. `calendar.googleapis.com`.

    Generated from protobuf field string name = 1;

    private $producer_project_id
     
    The Google project that owns this service.

    Generated from protobuf field string producer_project_id = 22;

    private $quota
     
    Quota configuration.

    Generated from protobuf field .google.api.Quota quota = 10;

    private $source_info
     
    Output only. The source information for this configuration if available.

    Generated from protobuf field .google.api.SourceInfo source_info = 37;

    private $system_parameters
     
    System parameter configuration.

    Generated from protobuf field .google.api.SystemParameters system_parameters = 29;

    private $title
     
    The product title for this service.

    Generated from protobuf field string title = 2;

    private $types
     
    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. Example:

    types:
    - name: google.protobuf.Int32
    

    Generated from protobuf field repeated .google.protobuf.Type types = 4;

    private $usage
     
    Configuration controlling usage of this service.

    Generated from protobuf field .google.api.Usage usage = 15;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     


    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     
    Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       
      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         


        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         


        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         


        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         
        Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           
          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             


            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only