applications

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

Overview

Name	applications
Type	Resource
Id	google.beyondcorp.applications

Fields

The following fields are returned by SELECT queries:

projects_locations_security_gateways_applications_get

Name	Datatype	Description
name	string	Identifier. Name of the resource.
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
displayName	string	Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.
endpointMatchers	array	Optional. An array of conditions to match the application's network endpoint. Each element in the array is an EndpointMatcher object, which defines a specific combination of a hostname pattern and one or more ports. The application is considered matched if at least one of the EndpointMatcher conditions in this array is met (the conditions are combined using OR logic). Each EndpointMatcher must contain a hostname pattern, such as "example.com", and one or more port numbers specified as a string, such as "443". Hostname and port number examples: "*.example.com", "443" "example.com" and "22" "example.com" and "22,33"
schema	string	Optional. Type of the external application. (SCHEMA_UNSPECIFIED, PROXY_GATEWAY, API_GATEWAY)
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.
upstreams	array	Optional. Which upstream resources to forward traffic to.

projects_locations_security_gateways_applications_list

Name	Datatype	Description
name	string	Identifier. Name of the resource.
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
displayName	string	Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.
endpointMatchers	array	Optional. An array of conditions to match the application's network endpoint. Each element in the array is an EndpointMatcher object, which defines a specific combination of a hostname pattern and one or more ports. The application is considered matched if at least one of the EndpointMatcher conditions in this array is met (the conditions are combined using OR logic). Each EndpointMatcher must contain a hostname pattern, such as "example.com", and one or more port numbers specified as a string, such as "443". Hostname and port number examples: "*.example.com", "443" "example.com" and "22" "example.com" and "22,33"
schema	string	Optional. Type of the external application. (SCHEMA_UNSPECIFIED, PROXY_GATEWAY, API_GATEWAY)
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.
upstreams	array	Optional. Which upstream resources to forward traffic to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_security_gateways_applications_get	select	projectsId, locationsId, securityGatewaysId, applicationsId		Gets details of a single Application.
projects_locations_security_gateways_applications_list	select	projectsId, locationsId, securityGatewaysId	pageToken, orderBy, pageSize, filter	Lists Applications in a given project and location.
projects_locations_security_gateways_applications_create	insert	projectsId, locationsId, securityGatewaysId	applicationId, requestId	Creates a new Application in a given project and location.
projects_locations_security_gateways_applications_patch	update	projectsId, locationsId, securityGatewaysId, applicationsId	updateMask, requestId	Updates the parameters of a single Application.
projects_locations_security_gateways_applications_delete	delete	projectsId, locationsId, securityGatewaysId, applicationsId	requestId, validateOnly	Deletes a single application.

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

SELECT examples

projects_locations_security_gateways_applications_get

Gets details of a single Application.

SELECT
name,
createTime,
displayName,
endpointMatchers,
schema,
updateTime,
upstreams
FROM google.beyondcorp.applications
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND securityGatewaysId = '{{ securityGatewaysId }}' -- required
AND applicationsId = '{{ applicationsId }}' -- required
;

projects_locations_security_gateways_applications_list

Lists Applications in a given project and location.

SELECT
name,
createTime,
displayName,
endpointMatchers,
schema,
updateTime,
upstreams
FROM google.beyondcorp.applications
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND securityGatewaysId = '{{ securityGatewaysId }}' -- required
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
;

INSERT examples

projects_locations_security_gateways_applications_create

Creates a new Application in a given project and location.

INSERT INTO google.beyondcorp.applications (
data__upstreams,
data__schema,
data__name,
data__endpointMatchers,
data__displayName,
projectsId,
locationsId,
securityGatewaysId,
applicationId,
requestId
)
SELECT 
'{{ upstreams }}',
'{{ schema }}',
'{{ name }}',
'{{ endpointMatchers }}',
'{{ displayName }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ securityGatewaysId }}',
'{{ applicationId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the applications resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the applications resource.
  - name: securityGatewaysId
    value: "{{ securityGatewaysId }}"
    description: Required parameter for the applications resource.
  - name: upstreams
    description: |
      Optional. Which upstream resources to forward traffic to.
    value:
      - network:
          name: "{{ name }}"
        external:
          endpoints:
            - port: {{ port }}
              hostname: "{{ hostname }}"
        proxyProtocol:
          gatewayIdentity: "{{ gatewayIdentity }}"
          contextualHeaders:
            userInfo:
              outputType: "{{ outputType }}"
            deviceInfo:
              outputType: "{{ outputType }}"
            outputType: "{{ outputType }}"
            groupInfo:
              outputType: "{{ outputType }}"
          clientIp: {{ clientIp }}
          allowedClientHeaders:
            - "{{ allowedClientHeaders }}"
          metadataHeaders: "{{ metadataHeaders }}"
        egressPolicy:
          regions:
            - "{{ regions }}"
  - name: schema
    value: "{{ schema }}"
    description: |
      Optional. Type of the external application.
    valid_values: ['SCHEMA_UNSPECIFIED', 'PROXY_GATEWAY', 'API_GATEWAY']
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the resource.
  - name: endpointMatchers
    description: |
      Optional. An array of conditions to match the application's network endpoint. Each element in the array is an EndpointMatcher object, which defines a specific combination of a hostname pattern and one or more ports. The application is considered matched if at least one of the EndpointMatcher conditions in this array is met (the conditions are combined using OR logic). Each EndpointMatcher must contain a hostname pattern, such as "example.com", and one or more port numbers specified as a string, such as "443". Hostname and port number examples: "*.example.com", "443" "example.com" and "22" "example.com" and "22,33"
    value:
      - hostname: "{{ hostname }}"
        ports: "{{ ports }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.
  - name: applicationId
    value: "{{ applicationId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

projects_locations_security_gateways_applications_patch

Updates the parameters of a single Application.

UPDATE google.beyondcorp.applications
SET 
data__upstreams = '{{ upstreams }}',
data__schema = '{{ schema }}',
data__name = '{{ name }}',
data__endpointMatchers = '{{ endpointMatchers }}',
data__displayName = '{{ displayName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securityGatewaysId = '{{ securityGatewaysId }}' --required
AND applicationsId = '{{ applicationsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_security_gateways_applications_delete

Deletes a single application.

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