gateways

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

Overview

Name	gateways
Type	Resource
Id	google.apigateway.gateways

Fields

Name	Datatype	Description
name	string	Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
apiConfig	string	Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
createTime	string	Output only. Created time.
defaultHostname	string	Output only. The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
displayName	string	Optional. Display name.
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
state	string	Output only. The current state of the Gateway.
updateTime	string	Output only. Updated time.

Methods

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

SELECT examples

Lists Gateways in a given project and location.

SELECT
name,
apiConfig,
createTime,
defaultHostname,
displayName,
labels,
state,
updateTime
FROM google.apigateway.gateways
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.apigateway.gateways (
locationsId,
projectsId,
labels,
displayName,
apiConfig
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ labels }}',
'{{ displayName }}',
'{{ apiConfig }}'
;

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: apiConfig
      value: string
    - name: state
      value: string
    - name: defaultHostname
      value: string

UPDATE example

Updates a gateways resource.

/*+ update */
UPDATE google.apigateway.gateways
SET 
labels = '{{ labels }}',
displayName = '{{ displayName }}',
apiConfig = '{{ apiConfig }}'
WHERE 
gatewaysId = '{{ gatewaysId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified gateways resource.

/*+ delete */
DELETE FROM google.apigateway.gateways
WHERE gatewaysId = '{{ gatewaysId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';