REST Resource: projects.locations.securityGateways

Resource: SecurityGateway

The information about a security gateway resource.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "externalIps": [
    string
  ],
  "state": enum (State),
  "hubs": {
    string: {
      object (Hub)
    },
    ...
  },
  "delegatingServiceAccount": string
}
Fields
name

string

Identifier. Name of the resource.

createTime

string (Timestamp format)

Output only. Timestamp when the resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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 uses 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 SecurityGateway. Cannot exceed 64 characters.

externalIps[]

string

Output only. IP addresses that will be used for establishing connection to the endpoints.

state

enum (State)

Output only. The operational state of the SecurityGateway.

hubs

map (key: string, value: object (Hub))

Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.

delegatingServiceAccount

string

Output only. Service account used for operations that involve resources in consumer projects.

State

Represents the different states of a SecurityGateway.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
CREATING SecurityGateway is being created.
UPDATING SecurityGateway is being updated.
DELETING SecurityGateway is being deleted.
RUNNING SecurityGateway is running.
DOWN SecurityGateway is down and may be restored in the future.
ERROR SecurityGateway encountered an error and is in an indeterministic state.

Hub

The Hub message contains information pertaining to the regional data path deployments.

JSON representation
{
  "internetGateway": {
    object (InternetGateway)
  }
}
Fields
internetGateway

object (InternetGateway)

Optional. Internet Gateway configuration.

InternetGateway

Represents the Internet Gateway configuration.

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

string

Output only. List of IP addresses assigned to the Cloud NAT.

Methods

create

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

delete

Deletes a single SecurityGateway.

get

Gets details of a single SecurityGateway.

getIamPolicy

Gets the access control policy for a resource.

list

Lists SecurityGateways in a given project and location.

patch

Updates the parameters of a single SecurityGateway.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.