app_gateways

Creates, updates, deletes, gets or lists an app_gateways resource.

Overview

Name	app_gateways
Type	Resource
Id	google.beyondcorp.app_gateways

Fields

The following fields are returned by SELECT queries:

projects_locations_app_gateways_get

Successful response

Name	Datatype	Description
name	string	Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
allocatedConnections	array	Output only. A list of connections allocated for the Gateway
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
displayName	string	Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
hostType	string	Required. The type of hosting used by the AppGateway.
labels	object	Optional. Resource labels to represent user provided metadata.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The current state of the AppGateway.
type	string	Required. The type of network connectivity used by the AppGateway.
uid	string	Output only. A unique identifier for the instance generated by the system.
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.
uri	string	Output only. Server-defined URI for this resource.

projects_locations_app_gateways_list

Successful response

Name	Datatype	Description
name	string	Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
allocatedConnections	array	Output only. A list of connections allocated for the Gateway
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
displayName	string	Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
hostType	string	Required. The type of hosting used by the AppGateway.
labels	object	Optional. Resource labels to represent user provided metadata.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The current state of the AppGateway.
type	string	Required. The type of network connectivity used by the AppGateway.
uid	string	Output only. A unique identifier for the instance generated by the system.
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.
uri	string	Output only. Server-defined URI for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_app_gateways_get	select	projectsId, locationsId, appGatewaysId		Gets details of a single AppGateway.
projects_locations_app_gateways_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists AppGateways in a given project and location.
projects_locations_app_gateways_create	insert	projectsId, locationsId	appGatewayId, requestId, validateOnly	Creates a new AppGateway in a given project and location.
projects_locations_app_gateways_delete	delete	projectsId, locationsId, appGatewaysId	requestId, validateOnly	Deletes a single AppGateway.

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
appGatewaysId	string
locationsId	string
projectsId	string
appGatewayId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
validateOnly	boolean

SELECT examples

projects_locations_app_gateways_get

Gets details of a single AppGateway.

SELECT
name,
allocatedConnections,
createTime,
displayName,
hostType,
labels,
satisfiesPzi,
satisfiesPzs,
state,
type,
uid,
updateTime,
uri
FROM google.beyondcorp.app_gateways
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND appGatewaysId = '{{ appGatewaysId }}' -- required;

projects_locations_app_gateways_list

Lists AppGateways in a given project and location.

SELECT
name,
allocatedConnections,
createTime,
displayName,
hostType,
labels,
satisfiesPzi,
satisfiesPzs,
state,
type,
uid,
updateTime,
uri
FROM google.beyondcorp.app_gateways
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_app_gateways_create

Creates a new AppGateway in a given project and location.

INSERT INTO google.beyondcorp.app_gateways (
data__name,
data__labels,
data__displayName,
data__type,
data__hostType,
projectsId,
locationsId,
appGatewayId,
requestId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ displayName }}',
'{{ type }}',
'{{ hostType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ appGatewayId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: app_gateways
  props:
    - name: projectsId
      value: string
      description: Required parameter for the app_gateways resource.
    - name: locationsId
      value: string
      description: Required parameter for the app_gateways resource.
    - name: name
      value: string
      description: >
        Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
        
    - name: labels
      value: object
      description: >
        Optional. Resource labels to represent user provided metadata.
        
    - name: displayName
      value: string
      description: >
        Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
        
    - name: type
      value: string
      description: >
        Required. The type of network connectivity used by the AppGateway.
        
      valid_values: ['TYPE_UNSPECIFIED', 'TCP_PROXY']
    - name: hostType
      value: string
      description: >
        Required. The type of hosting used by the AppGateway.
        
      valid_values: ['HOST_TYPE_UNSPECIFIED', 'GCP_REGIONAL_MIG']
    - name: appGatewayId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

DELETE examples

projects_locations_app_gateways_delete

Deletes a single AppGateway.

DELETE FROM google.beyondcorp.app_gateways
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appGatewaysId = '{{ appGatewaysId }}' --required
AND requestId = '{{ requestId }}'
AND validateOnly = '{{ validateOnly }}';