REST Resource: organizations.locations.firewallEndpoints

Resource: FirewallEndpoint

Message describing Endpoint object.

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

string

Immutable. Identifier. Name of resource.
description

string

Optional. Description of the firewall endpoint. Max length 2048 characters.
createTime

string (Timestamp format)

Output only. Create time stamp.

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 time stamp

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. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
associations[]

object (AssociationReference)

Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
billingProjectId

string

Required. Project to bill on endpoint uptime usage.
endpointSettings

object (EndpointSettings)

Optional. Settings for the endpoint.
satisfiesPzs

boolean

Output only. [Output Only] Reserved for future use.
satisfiesPzi

boolean

Output only. [Output Only] Reserved for future use.

State

Endpoint state.

Enums
STATE_UNSPECIFIED Not set.
CREATING Being created.
ACTIVE Processing configuration updates.
DELETING Being deleted.
INACTIVE Down or in an error state.

AssociationReference

This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.

JSON representation 
{
  "name": string,
  "network": string
}
Fields
name

string

Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}
network

string

Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.

EndpointSettings

This type has no fields.

Settings for the endpoint.

Methods

create

 Creates a new FirewallEndpoint in a given project and location.

delete

 Deletes a single Endpoint.

get

 Gets details of a single Endpoint.

list

 Lists FirewallEndpoints in a given project and location.

patch

 Update a single Endpoint.