configs

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

Overview

Name	configs
Type	Resource
Id	google.apigateway.configs

Fields

The following fields are returned by SELECT queries:

get

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 (google-datetime)	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. (STATE_UNSPECIFIED, CREATING, ACTIVE, FAILED, DELETING, UPDATING, ACTIVATING)
updateTime	string (google-datetime)	Output only. Updated time.

list

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 (google-datetime)	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. (STATE_UNSPECIFIED, CREATING, ACTIVE, FAILED, DELETING, UPDATING, ACTIVATING)
updateTime	string (google-datetime)	Output only. Updated time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, apisId, configsId	view	Gets details of a single ApiConfig.
list	select	projectsId, locationsId, apisId	filter, orderBy, pageSize, pageToken	Lists ApiConfigs in a given project and location.
create	insert	projectsId, locationsId, apisId	apiConfigId	Creates a new ApiConfig in a given project and location.
patch	update	projectsId, locationsId, apisId, configsId	updateMask	Updates the parameters of a single ApiConfig.
delete	delete	projectsId, locationsId, apisId, configsId		Deletes a single ApiConfig.

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
apisId	string
configsId	string
locationsId	string
projectsId	string
apiConfigId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets details of a single ApiConfig.

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

list

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 projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new ApiConfig in a given project and location.

INSERT INTO google.apigateway.configs (
data__displayName,
data__gatewayServiceAccount,
data__grpcServices,
data__labels,
data__managedServiceConfigs,
data__openapiDocuments,
projectsId,
locationsId,
apisId,
apiConfigId
)
SELECT 
'{{ displayName }}',
'{{ gatewayServiceAccount }}',
'{{ grpcServices }}',
'{{ labels }}',
'{{ managedServiceConfigs }}',
'{{ openapiDocuments }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ apisId }}',
'{{ apiConfigId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: configs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the configs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the configs resource.
  - name: apisId
    value: "{{ apisId }}"
    description: Required parameter for the configs resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. Display name.
  - name: gatewayServiceAccount
    value: "{{ gatewayServiceAccount }}"
    description: |
      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.
  - name: grpcServices
    description: |
      Optional. gRPC service definition files. If specified, openapi_documents must not be included.
    value:
      - fileDescriptorSet:
          contents: "{{ contents }}"
          path: "{{ path }}"
        source: "{{ source }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      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
  - name: managedServiceConfigs
    description: |
      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.
    value:
      - contents: "{{ contents }}"
        path: "{{ path }}"
  - name: openapiDocuments
    description: |
      Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
    value:
      - document:
          contents: "{{ contents }}"
          path: "{{ path }}"
  - name: apiConfigId
    value: "{{ apiConfigId }}"

UPDATE examples

patch

Updates the parameters of a single ApiConfig.

UPDATE google.apigateway.configs
SET 
data__displayName = '{{ displayName }}',
data__gatewayServiceAccount = '{{ gatewayServiceAccount }}',
data__grpcServices = '{{ grpcServices }}',
data__labels = '{{ labels }}',
data__managedServiceConfigs = '{{ managedServiceConfigs }}',
data__openapiDocuments = '{{ openapiDocuments }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND configsId = '{{ configsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single ApiConfig.

DELETE FROM google.apigateway.configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND configsId = '{{ configsId }}' --required
;