regional_endpoints

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

Overview

Name	regional_endpoints
Type	Resource
Id	google.networkconnectivity.regional_endpoints

Fields

Name	Datatype	Description
name	string	Output only. The name of a RegionalEndpoint. Format: projects/{project}/locations/{location}/regionalEndpoints/{regional_endpoint}.
description	string	Optional. A description of this resource.
accessType	string	Required. The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
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}
createTime	string	Output only. Time when the RegionalEndpoint was created.
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	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	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	Output only. Time when the RegionalEndpoint was updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, regionalEndpointsId	Gets details of a single RegionalEndpoint.
list	SELECT	locationsId, projectsId	Lists RegionalEndpoints in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new RegionalEndpoint in a given project and location.
delete	DELETE	locationsId, projectsId, regionalEndpointsId	Deletes a single RegionalEndpoint.

SELECT examples

Lists RegionalEndpoints in a given project and location.

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

INSERT example

Use the following StackQL query and manifest file to create a new regional_endpoints resource.

All Properties

/*+ create */
INSERT INTO google.networkconnectivity.regional_endpoints (
locationsId,
projectsId,
labels,
description,
targetGoogleApi,
network,
subnetwork,
accessType,
address
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ labels }}',
'{{ description }}',
'{{ targetGoogleApi }}',
'{{ network }}',
'{{ subnetwork }}',
'{{ accessType }}',
'{{ address }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: description
      value: string
    - name: targetGoogleApi
      value: string
    - name: network
      value: string
    - name: subnetwork
      value: string
    - name: accessType
      value: string
    - name: pscForwardingRule
      value: string
    - name: ipAddress
      value: string
    - name: address
      value: string

DELETE example

Deletes the specified regional_endpoints resource.

/*+ delete */
DELETE FROM google.networkconnectivity.regional_endpoints
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND regionalEndpointsId = '{{ regionalEndpointsId }}';