configs

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

Overview

Name	configs
Type	Resource
Id	google.servicemanagement.configs

Fields

The following fields are returned by SELECT queries:

get

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)

list

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	select	serviceName, configId	view	Gets a service configuration (version) for a managed service.
list	select	serviceName	pageToken, pageSize	Lists the history of the service configuration for a managed service, from the newest to the oldest.
create	insert	serviceName		Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.
submit	exec	serviceName		Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout. Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually. Operation

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
configId	string
serviceName	string
pageSize	integer (int32)
pageToken	string
view	string

SELECT examples

get

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.configs
WHERE serviceName = '{{ serviceName }}' -- required
AND configId = '{{ configId }}' -- required
AND view = '{{ view }}';

list

Lists the history of the service configuration for a managed service, from the newest to the oldest.

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.configs
WHERE serviceName = '{{ serviceName }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

INSERT examples

create

Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.

INSERT INTO google.servicemanagement.configs (
data__name,
data__title,
data__producerProjectId,
data__id,
data__apis,
data__types,
data__enums,
data__documentation,
data__backend,
data__http,
data__quota,
data__authentication,
data__context,
data__usage,
data__customError,
data__endpoints,
data__control,
data__logs,
data__metrics,
data__monitoredResources,
data__billing,
data__logging,
data__monitoring,
data__systemParameters,
data__sourceInfo,
data__publishing,
data__systemTypes,
data__aspects,
data__configVersion,
serviceName
)
SELECT 
'{{ name }}',
'{{ title }}',
'{{ producerProjectId }}',
'{{ id }}',
'{{ apis }}',
'{{ types }}',
'{{ enums }}',
'{{ documentation }}',
'{{ backend }}',
'{{ http }}',
'{{ quota }}',
'{{ authentication }}',
'{{ context }}',
'{{ usage }}',
'{{ customError }}',
'{{ endpoints }}',
'{{ control }}',
'{{ logs }}',
'{{ metrics }}',
'{{ monitoredResources }}',
'{{ billing }}',
'{{ logging }}',
'{{ monitoring }}',
'{{ systemParameters }}',
'{{ sourceInfo }}',
'{{ publishing }}',
'{{ systemTypes }}',
'{{ aspects }}',
{{ configVersion }},
'{{ serviceName }}'
RETURNING
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
;

Manifest

# Description fields are for documentation purposes
- name: configs
  props:
    - name: serviceName
      value: string
      description: Required parameter for the configs resource.
    - name: name
      value: string
      description: >
        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.
        
    - name: title
      value: string
      description: >
        The product title for this service, it is the name displayed in Google Cloud Console.
        
    - name: producerProjectId
      value: string
      description: >
        The Google project that owns this service.
        
    - name: id
      value: string
      description: >
        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: apis
      value: array
      description: >
        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.
        
    - name: types
      value: array
      description: >
        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
        
    - name: enums
      value: array
      description: >
        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
        
    - name: documentation
      value: object
      description: >
        Additional API documentation.
        
    - name: backend
      value: object
      description: >
        API backend configuration.
        
    - name: http
      value: object
      description: >
        HTTP configuration.
        
    - name: quota
      value: object
      description: >
        Quota configuration.
        
    - name: authentication
      value: object
      description: >
        Auth configuration.
        
    - name: context
      value: object
      description: >
        Context configuration.
        
    - name: usage
      value: object
      description: >
        Configuration controlling usage of this service.
        
    - name: customError
      value: object
      description: >
        Custom error configuration.
        
    - name: endpoints
      value: array
      description: >
        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.
        
    - name: control
      value: object
      description: >
        Configuration for the service control plane.
        
    - name: logs
      value: array
      description: >
        Defines the logs used by this service.
        
    - name: metrics
      value: array
      description: >
        Defines the metrics used by this service.
        
    - name: monitoredResources
      value: array
      description: >
        Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
        
    - name: billing
      value: object
      description: >
        Billing configuration.
        
    - name: logging
      value: object
      description: >
        Logging configuration.
        
    - name: monitoring
      value: object
      description: >
        Monitoring configuration.
        
    - name: systemParameters
      value: object
      description: >
        System parameter configuration.
        
    - name: sourceInfo
      value: object
      description: >
        Output only. The source information for this configuration if available.
        
    - name: publishing
      value: object
      description: >
        Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
        
    - name: systemTypes
      value: array
      description: >
        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.
        
    - name: aspects
      value: array
      description: >
        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.
        
    - name: configVersion
      value: integer
      description: >
        Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`.
        

Lifecycle Methods

submit

Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout. Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually. Operation

EXEC google.servicemanagement.configs.submit 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"configSource": "{{ configSource }}", 
"validateOnly": {{ validateOnly }}
}';