REST Resource: outboundEndpoints

Resource: OutboundEndpoint

An OutboundEndpoint is a regional resource to enable outbound forwarding from a private IP range in VPCs to on-premise or other networks.

JSON representation
{
  "name": string,
  "network": string,
  "subnetwork": string,
  "endpointIp": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "tags": {
    string: string,
    ...
  }
}
Fields
name

string

Identifier. The resource name of the OutboundEndpoint. Format: projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}

network

string

Required. Immutable. The VPC network containing the outbound endpoint, specified as full path.

subnetwork

string

Required. Immutable. The subnetwork holding the endpointIp, specified as full path.

endpointIp

string

Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.

description

string

Optional. User provided description.

createTime

string (Timestamp format)

Output only. [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. [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" }.

annotations

map (key: string, value: string)

Optional. Annotations as key value pairs

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

tags

map (key: string, value: string)

Optional. Tag bindings as key value pairs

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

Methods

create

Creates a new Outbound Endpoint.

delete

Deletes a previously created Outbound Endpoint.

get

Fetches the representation of an existing Outbound Endpoint.

list

Enumerates all Outbound Endpoints associated with a project.

patch

Updates an existing Outbound Endpoint.