REST Resource: projects.locations.firewallEndpoints

Resource: FirewallEndpoint

Message describing a firewall endpoint.

JSON representation
{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "reconciling": boolean,
  "associatedNetworks": [
    string
  ],
  "associations": [
    {
      object (AssociationReference)
    }
  ],
  "wildfireSettings": {
    object (WildfireSettings)
  },
  "billingProjectId": string,
  "endpointSettings": {
    object (EndpointSettings)
  },
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Fields
name

string

Immutable. Identifier. The name of the resource.

description

string

Optional. Description of the firewall endpoint. The maximum length is 2048 characters.

createTime

string (Timestamp format)

Output only. Create timestamp.

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. Update timestamp.

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

labels

map (key: string, value: string)

Optional. Labels as key-value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

state

enum (State)

Output only. Current state of the endpoint.

reconciling

boolean

Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.

associatedNetworks[]
(deprecated)

string

Output only. Deprecated: Use the network field in the associations message instead. List of networks that are associated with this endpoint in the local zone. This is a projection of the firewall endpoint association resources pointing at this endpoint. A network only appears in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.

associations[]

object (AssociationReference)

Output only. List of firewall endpoint association resources that are associated with this endpoint. An association only appears in this list after traffic routing is fully configured.

wildfireSettings

object (WildfireSettings)

Optional. Settings for Advanced malware sandbox (WildFire) analysis.

billingProjectId

string

Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.

endpointSettings

object (EndpointSettings)

Optional. Settings for the endpoint.

satisfiesPzs

boolean

Output only. Reserved for future use.

satisfiesPzi

boolean

Output only. Reserved for future use.

Methods

create

Creates a new firewall endpoint in a given project and location.

delete

Deletes a single project endpoint.

get

Gets details of a single project endpoint.

list

Lists firewall endpoints in a given project and location.

patch

Updates a single project endpoint.