REST Resource: projects.locations.securityGateways.applications

Resource: Application

The information about an application resource.

JSON representation 
{
  "name": string,
  "endpointMatchers": [
    {
      object (EndpointMatcher)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "upstreams": [
    {
      object (Upstream)
    }
  ],
  "schema": enum (Schema)
}
Fields
name

string

Identifier. Name of the resource.
endpointMatchers[]

object (EndpointMatcher)

Required. 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"
createTime

string (Timestamp format)

Output only. Timestamp when the resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Timestamp when the resource was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
displayName

string

Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.
upstreams[]

object (Upstream)

Optional. Which upstream resources to forward traffic to.
schema

enum (Schema)

Optional. Type of the external application.

EndpointMatcher

EndpointMatcher contains the information of the endpoint that will match the application.

JSON representation 
{
  "hostname": string,
  "ports": [
    integer
  ]
}
Fields
hostname

string

Required. Hostname of the application.
ports[]

integer

Required. The ports of the application.

Upstream

Which upstream resource to forward traffic to.

JSON representation 
{
  "proxyProtocol": {
    object (ProxyProtocolConfig)
  },
  "egressPolicy": {
    object (EgressPolicy)
  },

  // Union field target can be only one of the following:
  "network": {
    object (Network)
  },
  "external": {
    object (External)
  }
  // End of list of possible types for union field target.
}
Fields
proxyProtocol

object (ProxyProtocolConfig)

Optional. Enables proxy protocol configuration for the upstream.
egressPolicy

object (EgressPolicy)

Optional. Routing policy information.
Union field target. The target of the upstream resource. target can be only one of the following:
network

object (Network)

Network to forward traffic to.
external

object (External)

List of the external endpoints to forward traffic to.

Network

Network to forward traffic to.

JSON representation 
{
  "name": string
}
Fields
name

string

Required. Network name is of the format: `projects/{project}/global/networks/{network}

External

Endpoints to forward traffic to.

JSON representation 
{
  "endpoints": [
    {
      object (Endpoint)
    }
  ]
}
Fields
endpoints[]

object (Endpoint)

Required. List of the endpoints to forward traffic to.

Endpoint

Internet Gateway endpoint to forward traffic to.

JSON representation 
{
  "hostname": string,
  "port": integer
}
Fields
hostname

string

Required. Hostname of the endpoint.
port

integer

Required. Port of the endpoint.

EgressPolicy

Routing policy information.

JSON representation 
{
  "regions": [
    string
  ]
}
Fields
regions[]

string

Required. List of the regions where the application sends traffic.

Schema

Defines the type of external application.

Enums
SCHEMA_UNSPECIFIED Default value. This value is unused.
PROXY_GATEWAY Proxy which routes traffic to actual applications, like Netscaler Gateway.
API_GATEWAY Service Discovery API endpoint when Service Discovery is enabled in Gateway.

Methods

create

 Creates a new Application in a given project and location.

delete

 Deletes a single application.

get

 Gets details of a single Application.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists Applications in a given project and location.

patch

 Updates the parameters of a single Application.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.