services_config

Creates, updates, deletes, gets or lists a services_config resource.

Overview

Name	services_config
Type	Resource
Id	google.servicemanagement.services_config

Fields

The following fields are returned by SELECT queries:

get_config

Successful response

Name	Datatype	Description
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.
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.
apis	array	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.
aspects	array	Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.
authentication	object	Auth configuration. (id: Authentication)
backend	object	API backend configuration. (id: Backend)
billing	object	Billing configuration. (id: Billing)
configVersion	integer (uint32)	Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.
context	object	Context configuration. (id: Context)
control	object	Configuration for the service control plane. (id: Control)
customError	object	Custom error configuration. (id: CustomError)
documentation	object	Additional API documentation. (id: Documentation)
endpoints	array	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.
enums	array	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
http	object	HTTP configuration. (id: Http)
logging	object	Logging configuration. (id: Logging)
logs	array	Defines the logs used by this service.
metrics	array	Defines the metrics used by this service.
monitoredResources	array	Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
monitoring	object	Monitoring configuration. (id: Monitoring)
producerProjectId	string	The Google project that owns this service.
publishing	object	Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers. (id: Publishing)
quota	object	Quota configuration. (id: Quota)
sourceInfo	object	Output only. The source information for this configuration if available. (id: SourceInfo)
systemParameters	object	System parameter configuration. (id: SystemParameters)
systemTypes	array	A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
title	string	The product title for this service, it is the name displayed in Google Cloud Console.
types	array	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
usage	object	Configuration controlling usage of this service. (id: Usage)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_config	select	serviceName	configId, view	Gets a service configuration (version) for a managed service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
serviceName	string
configId	string
view	string

SELECT examples

get_config

Gets a service configuration (version) for a managed service.

SELECT
id,
name,
apis,
aspects,
authentication,
backend,
billing,
configVersion,
context,
control,
customError,
documentation,
endpoints,
enums,
http,
logging,
logs,
metrics,
monitoredResources,
monitoring,
producerProjectId,
publishing,
quota,
sourceInfo,
systemParameters,
systemTypes,
title,
types,
usage
FROM google.servicemanagement.services_config
WHERE serviceName = '{{ serviceName }}' -- required
AND configId = '{{ configId }}'
AND view = '{{ view }}';