security_gateways

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

Overview

Name	security_gateways
Type	Resource
Id	google.beyondcorp.security_gateways

Fields

The following fields are returned by SELECT queries:

projects_locations_security_gateways_get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the resource.
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
delegatingServiceAccount	string	Output only. Service account used for operations that involve resources in consumer projects.
displayName	string	Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
externalIps	array	Output only. IP addresses that will be used for establishing connection to the endpoints.
hubs	object	Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.
state	string	Output only. The operational state of the SecurityGateway.
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.

projects_locations_security_gateways_list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the resource.
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
delegatingServiceAccount	string	Output only. Service account used for operations that involve resources in consumer projects.
displayName	string	Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
externalIps	array	Output only. IP addresses that will be used for establishing connection to the endpoints.
hubs	object	Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.
state	string	Output only. The operational state of the SecurityGateway.
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_security_gateways_get	select	projectsId, locationsId, securityGatewaysId		Gets details of a single SecurityGateway.
projects_locations_security_gateways_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists SecurityGateways in a given project and location.
projects_locations_security_gateways_create	insert	projectsId, locationsId	securityGatewayId, requestId	Creates a new Security Gateway in a given project and location.
projects_locations_security_gateways_patch	update	projectsId, locationsId, securityGatewaysId	updateMask, requestId	Updates the parameters of a single SecurityGateway.
projects_locations_security_gateways_delete	delete	projectsId, locationsId, securityGatewaysId	requestId, validateOnly	Deletes a single SecurityGateway.

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
locationsId	string
projectsId	string
securityGatewaysId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
securityGatewayId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_security_gateways_get

Gets details of a single SecurityGateway.

SELECT
name,
createTime,
delegatingServiceAccount,
displayName,
externalIps,
hubs,
state,
updateTime
FROM google.beyondcorp.security_gateways
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND securityGatewaysId = '{{ securityGatewaysId }}' -- required;

projects_locations_security_gateways_list

Lists SecurityGateways in a given project and location.

SELECT
name,
createTime,
delegatingServiceAccount,
displayName,
externalIps,
hubs,
state,
updateTime
FROM google.beyondcorp.security_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_security_gateways_create

Creates a new Security Gateway in a given project and location.

INSERT INTO google.beyondcorp.security_gateways (
data__name,
data__displayName,
data__hubs,
projectsId,
locationsId,
securityGatewayId,
requestId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ hubs }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ securityGatewayId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: security_gateways
  props:
    - name: projectsId
      value: string
      description: Required parameter for the security_gateways resource.
    - name: locationsId
      value: string
      description: Required parameter for the security_gateways resource.
    - name: name
      value: string
      description: >
        Identifier. Name of the resource.
        
    - name: displayName
      value: string
      description: >
        Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
        
    - name: hubs
      value: object
      description: >
        Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.
        
    - name: securityGatewayId
      value: string
    - name: requestId
      value: string

UPDATE examples

projects_locations_security_gateways_patch

Updates the parameters of a single SecurityGateway.

UPDATE google.beyondcorp.security_gateways
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__hubs = '{{ hubs }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securityGatewaysId = '{{ securityGatewaysId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_security_gateways_delete

Deletes a single SecurityGateway.

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