Service
class Service extends Message
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
Protobuf type Google\Api\Service
Methods
No description
The version of the service configuration. The config version may
influence interpretation of the configuration, for example, to
determine defaults. This is documented together with applicable
options. The current default for the config version itself is 3.
The version of the service configuration. The config version may
influence interpretation of the configuration, for example, to
determine defaults. This is documented together with applicable
options. The current default for the config version itself is 3.
The DNS address at which this service is available,
e.g. calendar.googleapis.com.
The DNS address at which this service is available,
e.g. calendar.googleapis.com.
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.
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.
The product title associated with this service.
The product title associated with this service.
The id of the Google developer project that owns the service.
The id of the Google developer project that owns the service.
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.
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.
A list of all proto message types included in this API service.
A list of all proto message types included in this API service.
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
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
Additional API documentation.
API backend configuration.
Auth configuration.
Context configuration.
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.
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.
Configuration for the service control plane.
Defines the logs used by this service.
Defines the logs used by this service.
Defines the metrics used by this service.
Defines the metrics used by this service.
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.
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.
Logging configuration.
Monitoring configuration.
System parameter configuration.
Output only. The source information for this configuration if available.
Output only. The source information for this configuration if available.
Experimental configuration.
Details
at line 215
__construct()
at line 229
UInt32Value
getConfigVersion()
The version of the service configuration. The config version may
influence interpretation of the configuration, for example, to
determine defaults. This is documented together with applicable
options. The current default for the config version itself is 3.
Generated from protobuf field .google.protobuf.UInt32Value config_version = 20;
at line 243
setConfigVersion(UInt32Value $var)
The version of the service configuration. The config version may
influence interpretation of the configuration, for example, to
determine defaults. This is documented together with applicable
options. The current default for the config version itself is 3.
Generated from protobuf field .google.protobuf.UInt32Value config_version = 20;
at line 256
string
getName()
The DNS address at which this service is available,
e.g. calendar.googleapis.com.
Generated from protobuf field string name = 1;
at line 268
setName(string $var)
The DNS address at which this service is available,
e.g. calendar.googleapis.com.
Generated from protobuf field string name = 1;
at line 282
string
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;
at line 295
setId(string $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;
at line 307
string
getTitle()
The product title associated with this service.
Generated from protobuf field string title = 2;
at line 318
setTitle(string $var)
The product title associated with this service.
Generated from protobuf field string title = 2;
at line 332
string
getProducerProjectId()
The id of the Google developer project that owns the service.
Members of this project can manage the service configuration, manage consumption of the service, etc.
Generated from protobuf field string producer_project_id = 22;
at line 345
setProducerProjectId(string $var)
The id of the Google developer project that owns the service.
Members of this project can manage the service configuration, manage consumption of the service, etc.
Generated from protobuf field string producer_project_id = 22;
at line 361
RepeatedField
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;
at line 376
setApis(array|RepeatedField $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;
at line 394
RepeatedField
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;
at line 411
setTypes(array|RepeatedField $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;
at line 428
RepeatedField
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;
at line 444
setEnums(array|RepeatedField $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;
at line 456
Documentation
getDocumentation()
Additional API documentation.
Generated from protobuf field .google.api.Documentation documentation = 6;
at line 467
setDocumentation(Documentation $var)
Additional API documentation.
Generated from protobuf field .google.api.Documentation documentation = 6;
at line 479
Backend
getBackend()
API backend configuration.
Generated from protobuf field .google.api.Backend backend = 8;
at line 490
setBackend(Backend $var)
API backend configuration.
Generated from protobuf field .google.api.Backend backend = 8;
at line 502
Http
getHttp()
HTTP configuration.
Generated from protobuf field .google.api.Http http = 9;
at line 513
setHttp(Http $var)
HTTP configuration.
Generated from protobuf field .google.api.Http http = 9;
at line 525
Quota
getQuota()
Quota configuration.
Generated from protobuf field .google.api.Quota quota = 10;
at line 536
setQuota(Quota $var)
Quota configuration.
Generated from protobuf field .google.api.Quota quota = 10;
at line 548
Authentication
getAuthentication()
Auth configuration.
Generated from protobuf field .google.api.Authentication authentication = 11;
at line 559
setAuthentication(Authentication $var)
Auth configuration.
Generated from protobuf field .google.api.Authentication authentication = 11;
at line 571
Context
getContext()
Context configuration.
Generated from protobuf field .google.api.Context context = 12;
at line 582
setContext(Context $var)
Context configuration.
Generated from protobuf field .google.api.Context context = 12;
at line 594
Usage
getUsage()
Configuration controlling usage of this service.
Generated from protobuf field .google.api.Usage usage = 15;
at line 605
setUsage(Usage $var)
Configuration controlling usage of this service.
Generated from protobuf field .google.api.Usage usage = 15;
at line 619
RepeatedField
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;
at line 632
setEndpoints(array|RepeatedField $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;
at line 644
Control
getControl()
Configuration for the service control plane.
Generated from protobuf field .google.api.Control control = 21;
at line 655
setControl(Control $var)
Configuration for the service control plane.
Generated from protobuf field .google.api.Control control = 21;
at line 667
RepeatedField
getLogs()
Defines the logs used by this service.
Generated from protobuf field repeated .google.api.LogDescriptor logs = 23;
at line 678
setLogs(array|RepeatedField $var)
Defines the logs used by this service.
Generated from protobuf field repeated .google.api.LogDescriptor logs = 23;
at line 690
RepeatedField
getMetrics()
Defines the metrics used by this service.
Generated from protobuf field repeated .google.api.MetricDescriptor metrics = 24;
at line 701
setMetrics(array|RepeatedField $var)
Defines the metrics used by this service.
Generated from protobuf field repeated .google.api.MetricDescriptor metrics = 24;
at line 714
RepeatedField
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;
at line 726
setMonitoredResources(array|RepeatedField $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;
at line 738
Logging
getLogging()
Logging configuration.
Generated from protobuf field .google.api.Logging logging = 27;
at line 749
setLogging(Logging $var)
Logging configuration.
Generated from protobuf field .google.api.Logging logging = 27;
at line 761
Monitoring
getMonitoring()
Monitoring configuration.
Generated from protobuf field .google.api.Monitoring monitoring = 28;
at line 772
setMonitoring(Monitoring $var)
Monitoring configuration.
Generated from protobuf field .google.api.Monitoring monitoring = 28;
at line 784
SystemParameters
getSystemParameters()
System parameter configuration.
Generated from protobuf field .google.api.SystemParameters system_parameters = 29;
at line 795
setSystemParameters(SystemParameters $var)
System parameter configuration.
Generated from protobuf field .google.api.SystemParameters system_parameters = 29;
at line 807
SourceInfo
getSourceInfo()
Output only. The source information for this configuration if available.
Generated from protobuf field .google.api.SourceInfo source_info = 37;
at line 818
setSourceInfo(SourceInfo $var)
Output only. The source information for this configuration if available.
Generated from protobuf field .google.api.SourceInfo source_info = 37;
at line 830
Experimental
getExperimental()
Experimental configuration.
Generated from protobuf field .google.api.Experimental experimental = 101;
at line 841
setExperimental(Experimental $var)
Experimental configuration.
Generated from protobuf field .google.api.Experimental experimental = 101;