configs

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

Overview

Name	configs
Type	Resource
Id	google.apigateway.configs

Fields

Name	Datatype	Description
name	string	Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
createTime	string	Output only. Created time.
displayName	string	Optional. Display name.
gatewayServiceAccount	string	Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.
grpcServices	array	Optional. gRPC service definition files. If specified, openapi_documents must not be included.
labels	object	Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
managedServiceConfigs	array	Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.
openapiDocuments	array	Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
serviceConfigId	string	Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).
state	string	Output only. State of the API Config.
updateTime	string	Output only. Updated time.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apisId, configsId, locationsId, projectsId	Gets details of a single ApiConfig.
list	SELECT	apisId, locationsId, projectsId	Lists ApiConfigs in a given project and location.
create	INSERT	apisId, locationsId, projectsId	Creates a new ApiConfig in a given project and location.
delete	DELETE	apisId, configsId, locationsId, projectsId	Deletes a single ApiConfig.
patch	UPDATE	apisId, configsId, locationsId, projectsId	Updates the parameters of a single ApiConfig.

SELECT examples

Lists ApiConfigs in a given project and location.

SELECT
name,
createTime,
displayName,
gatewayServiceAccount,
grpcServices,
labels,
managedServiceConfigs,
openapiDocuments,
serviceConfigId,
state,
updateTime
FROM google.apigateway.configs
WHERE apisId = '{{ apisId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new configs resource.

All Properties

/*+ create */
INSERT INTO google.apigateway.configs (
apisId,
locationsId,
projectsId,
labels,
displayName,
gatewayServiceAccount,
openapiDocuments,
grpcServices,
managedServiceConfigs
)
SELECT 
'{{ apisId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ labels }}',
'{{ displayName }}',
'{{ gatewayServiceAccount }}',
'{{ openapiDocuments }}',
'{{ grpcServices }}',
'{{ managedServiceConfigs }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: displayName
      value: string
    - name: gatewayServiceAccount
      value: string
    - name: serviceConfigId
      value: string
    - name: state
      value: string
    - name: openapiDocuments
      value:
        - - name: document
            value:
              - name: path
                value: string
              - name: contents
                value: string
    - name: grpcServices
      value:
        - - name: source
            value:
              - - name: path
                  value: string
                - name: contents
                  value: string
    - name: managedServiceConfigs
      value:
        - - name: path
            value: string
          - name: contents
            value: string

UPDATE example

Updates a configs resource.

/*+ update */
UPDATE google.apigateway.configs
SET 
labels = '{{ labels }}',
displayName = '{{ displayName }}',
gatewayServiceAccount = '{{ gatewayServiceAccount }}',
openapiDocuments = '{{ openapiDocuments }}',
grpcServices = '{{ grpcServices }}',
managedServiceConfigs = '{{ managedServiceConfigs }}'
WHERE 
apisId = '{{ apisId }}'
AND configsId = '{{ configsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified configs resource.

/*+ delete */
DELETE FROM google.apigateway.configs
WHERE apisId = '{{ apisId }}'
AND configsId = '{{ configsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';