REST Resource: projects.locations.regionalEndpoints

Resource: RegionalEndpoint

The RegionalEndpoint resource.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "targetGoogleApi": string,
  "network": string,
  "subnetwork": string,
  "accessType": enum (AccessType),
  "pscForwardingRule": string,
  "ipAddress": string,
  "address": string
}
Fields
name

string

Output only. The name of a RegionalEndpoint. Format: projects/{project}/locations/{location}/regionalEndpoints/{regionalEndpoint}.
createTime

string (Timestamp format)

Output only. Time when the RegionalEndpoint was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Time when the RegionalEndpoint was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

User-defined labels.

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

string

Optional. A description of this resource.
targetGoogleApi

string

Required. The service endpoint this private regional endpoint connects to. Format: {apiname}.{region}.p.rep.googleapis.com Example: "cloudkms.us-central1.p.rep.googleapis.com".
network

string

The name of the VPC network for this private regional endpoint. Format: projects/{project}/global/networks/{network}
subnetwork

string

The name of the subnetwork from which the IP address will be allocated. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}
accessType

enum (AccessType)

Required. The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
pscForwardingRule

string

Output only. The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format: //compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
ipAddress
(deprecated)

string

Output only. The literal IP address of the PSC Forwarding Rule created on behalf of the customer. This field is deprecated. Use address instead.
address

string

Optional. The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in 10.0.0.1 * Address resource URI as in projects/{project}/regions/{region}/addresses/{address_name}

AccessType

The access type of this regional endpoint.

Enums
ACCESS_TYPE_UNSPECIFIED An invalid type as the default case.
GLOBAL This regional endpoint is accessible from all regions.
REGIONAL This regional endpoint is only accessible from the same region where it resides.

Methods

create

 Creates a new RegionalEndpoint in a given project and location.

delete

 Deletes a single RegionalEndpoint.

get

 Gets details of a single RegionalEndpoint.

list

 Lists RegionalEndpoints in a given project and location.