regional_endpoints

Creates, updates, deletes, gets or lists a regional_endpoints resource.

Overview

Name	`regional_endpoints`
Type	Resource
Id	`google.networkconnectivity.regional_endpoints`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	Output only. The name of a RegionalEndpoint. Pattern: `projects/{project}/locations/{location}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$`.
`accessType`	`string`	Required. The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access. (ACCESS_TYPE_UNSPECIFIED, GLOBAL, REGIONAL)
`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}` for an IPv4 or IPv6 address.
`createTime`	`string (google-datetime)`	Output only. Time when the RegionalEndpoint was created.
`description`	`string`	Optional. A description of this resource.
`ipAddress`	`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.
`labels`	`object`	User-defined labels.
`network`	`string`	Optional. The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}`
`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}`
`subnetwork`	`string`	Optional. The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`
`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".
`updateTime`	`string (google-datetime)`	Output only. Time when the RegionalEndpoint was updated.

Name	Datatype	Description
`name`	`string`	Output only. The name of a RegionalEndpoint. Pattern: `projects/{project}/locations/{location}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$`.
`accessType`	`string`	Required. The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access. (ACCESS_TYPE_UNSPECIFIED, GLOBAL, REGIONAL)
`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}` for an IPv4 or IPv6 address.
`createTime`	`string (google-datetime)`	Output only. Time when the RegionalEndpoint was created.
`description`	`string`	Optional. A description of this resource.
`ipAddress`	`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.
`labels`	`object`	User-defined labels.
`network`	`string`	Optional. The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}`
`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}`
`subnetwork`	`string`	Optional. The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`
`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".
`updateTime`	`string (google-datetime)`	Output only. Time when the RegionalEndpoint was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `regionalEndpointsId`		Gets details of a single RegionalEndpoint.
`list`	`select`	`projectsId`, `locationsId`	`filter`, `orderBy`, `pageSize`, `pageToken`	Lists RegionalEndpoints in a given project and location.
`create`	`insert`	`projectsId`, `locationsId`	`regionalEndpointId`, `requestId`	Creates a new RegionalEndpoint in a given project and location.
`delete`	`delete`	`projectsId`, `locationsId`, `regionalEndpointsId`	`requestId`	Deletes a single RegionalEndpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`locationsId`	`string`
`projectsId`	`string`
`regionalEndpointsId`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`regionalEndpointId`	`string`
`requestId`	`string`

`SELECT` examples

get
list

Gets details of a single RegionalEndpoint.

SELECT
name,
accessType,
address,
createTime,
description,
ipAddress,
labels,
network,
pscForwardingRule,
subnetwork,
targetGoogleApi,
updateTime
FROM google.networkconnectivity.regional_endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND regionalEndpointsId = '{{ regionalEndpointsId }}' -- required
;

Lists RegionalEndpoints in a given project and location.

SELECT
name,
accessType,
address,
createTime,
description,
ipAddress,
labels,
network,
pscForwardingRule,
subnetwork,
targetGoogleApi,
updateTime
FROM google.networkconnectivity.regional_endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

`INSERT` examples

create
Manifest

Creates a new RegionalEndpoint in a given project and location.

INSERT INTO google.networkconnectivity.regional_endpoints (
data__accessType,
data__address,
data__description,
data__labels,
data__network,
data__subnetwork,
data__targetGoogleApi,
projectsId,
locationsId,
regionalEndpointId,
requestId
)
SELECT 
'{{ accessType }}',
'{{ address }}',
'{{ description }}',
'{{ labels }}',
'{{ network }}',
'{{ subnetwork }}',
'{{ targetGoogleApi }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ regionalEndpointId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: regional_endpoints
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the regional_endpoints resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the regional_endpoints resource.
  - name: accessType
    value: "{{ accessType }}"
    description: |
      Required. The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
    valid_values: ['ACCESS_TYPE_UNSPECIFIED', 'GLOBAL', 'REGIONAL']
  - name: address
    value: "{{ address }}"
    description: |
      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}` for an IPv4 or IPv6 address.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. A description of this resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      User-defined labels.
  - name: network
    value: "{{ network }}"
    description: |
      Optional. The name of the VPC network for this private regional endpoint. Format: `projects/{project}/global/networks/{network}`
  - name: subnetwork
    value: "{{ subnetwork }}"
    description: |
      Optional. The name of the subnetwork from which the IP address will be allocated. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`
  - name: targetGoogleApi
    value: "{{ targetGoogleApi }}"
    description: |
      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".
  - name: regionalEndpointId
    value: "{{ regionalEndpointId }}"
  - name: requestId
    value: "{{ requestId }}"

`DELETE` examples

delete

Deletes a single RegionalEndpoint.

DELETE FROM google.networkconnectivity.regional_endpoints
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND regionalEndpointsId = '{{ regionalEndpointsId }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​