Reference documentation and code samples for the Google API Common Protos Client class Service.
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
Generated from protobuf message google.api.Service
Namespace
Google \ ApiMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
array< Google\Protobuf\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
array< Google\Protobuf\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
array< Google\Protobuf\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
↳ backend
↳ http
↳ quota
↳ authentication
↳ context
↳ usage
↳ endpoints
array< 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
↳ logs
↳ metrics
↳ monitored_resources
array< MonitoredResourceDescriptor
>
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
↳ billing
↳ logging
↳ monitoring
↳ system_parameters
↳ source_info
↳ publishing
Publishing
Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
↳ config_version
Google\Protobuf\UInt32Value
Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3
.
getName
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.
string
setName
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.
var
string
$this
getTitle
The product title for this service, it is the name displayed in Google Cloud Console.
string
setTitle
The product title for this service, it is the name displayed in Google Cloud Console.
var
string
$this
getProducerProjectId
The Google project that owns this service.
string
setProducerProjectId
The Google project that owns this service.
var
string
$this
getId
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.
string
setId
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.
var
string
$this
getApis
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.
setApis
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.
$this
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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
setTypes
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
$this
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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
setEnums
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
$this
getDocumentation
Additional API documentation.
hasDocumentation
clearDocumentation
setDocumentation
Additional API documentation.
$this
getBackend
API backend configuration.
hasBackend
clearBackend
setBackend
API backend configuration.
$this
getHttp
HTTP configuration.
hasHttp
clearHttp
setHttp
HTTP configuration.
$this
getQuota
Quota configuration.
hasQuota
clearQuota
setQuota
Quota configuration.
$this
getAuthentication
Auth configuration.
hasAuthentication
clearAuthentication
setAuthentication
Auth configuration.
$this
getContext
Context configuration.
hasContext
clearContext
setContext
Context configuration.
$this
getUsage
Configuration controlling usage of this service.
hasUsage
clearUsage
setUsage
Configuration controlling usage of this service.
$this
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.
setEndpoints
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.
$this
getControl
Configuration for the service control plane.
hasControl
clearControl
setControl
Configuration for the service control plane.
$this
getLogs
Defines the logs used by this service.
setLogs
Defines the logs used by this service.
$this
getMetrics
Defines the metrics used by this service.
setMetrics
Defines the metrics used by this service.
$this
getMonitoredResources
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
setMonitoredResources
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
$this
getBilling
Billing configuration.
hasBilling
clearBilling
setBilling
Billing configuration.
$this
getLogging
Logging configuration.
hasLogging
clearLogging
setLogging
Logging configuration.
$this
getMonitoring
Monitoring configuration.
hasMonitoring
clearMonitoring
setMonitoring
Monitoring configuration.
$this
getSystemParameters
System parameter configuration.
hasSystemParameters
clearSystemParameters
setSystemParameters
System parameter configuration.
$this
getSourceInfo
Output only. The source information for this configuration if available.
hasSourceInfo
clearSourceInfo
setSourceInfo
Output only. The source information for this configuration if available.
$this
getPublishing
Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
hasPublishing
clearPublishing
setPublishing
Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
$this
getConfigVersion
Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always
sets this field to 3
.
hasConfigVersion
clearConfigVersion
getConfigVersionUnwrapped
Returns the unboxed value from getConfigVersion()
Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always
sets this field to 3
.
int|null
setConfigVersion
Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always
sets this field to 3
.
$this
setConfigVersionUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\UInt32Value object.
Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always
sets this field to 3
.
var
int|null
$this
