private_connections

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

Overview

Name	private_connections
Type	Resource
Id	google.datastream.private_connections

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource's name.
createTime	string (google-datetime)	Output only. The create time of the resource.
displayName	string	Required. Display name.
error	object	Represent a user-facing Error. (id: Error)
labels	object	Labels.
pscInterfaceConfig	object	PSC Interface Config. (id: PscInterfaceConfig)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The state of the Private Connection.
updateTime	string (google-datetime)	Output only. The update time of the resource.
vpcPeeringConfig	object	VPC Peering Config. (id: VpcPeeringConfig)

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource's name.
createTime	string (google-datetime)	Output only. The create time of the resource.
displayName	string	Required. Display name.
error	object	Represent a user-facing Error. (id: Error)
labels	object	Labels.
pscInterfaceConfig	object	PSC Interface Config. (id: PscInterfaceConfig)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The state of the Private Connection.
updateTime	string (google-datetime)	Output only. The update time of the resource.
vpcPeeringConfig	object	VPC Peering Config. (id: VpcPeeringConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateConnectionsId		Use this method to get details about a private connectivity configuration.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Use this method to list private connectivity configurations in a project and location.
create	insert	projectsId, locationsId	privateConnectionId, requestId, force, validateOnly	Use this method to create a private connectivity configuration.
delete	delete	projectsId, locationsId, privateConnectionsId	requestId, force	Use this method to delete a private connectivity configuration.

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
privateConnectionsId	string
projectsId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
privateConnectionId	string
requestId	string
validateOnly	boolean

SELECT examples

get

Use this method to get details about a private connectivity configuration.

SELECT
name,
createTime,
displayName,
error,
labels,
pscInterfaceConfig,
satisfiesPzi,
satisfiesPzs,
state,
updateTime,
vpcPeeringConfig
FROM google.datastream.private_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateConnectionsId = '{{ privateConnectionsId }}' -- required;

list

Use this method to list private connectivity configurations in a project and location.

SELECT
name,
createTime,
displayName,
error,
labels,
pscInterfaceConfig,
satisfiesPzi,
satisfiesPzs,
state,
updateTime,
vpcPeeringConfig
FROM google.datastream.private_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Use this method to create a private connectivity configuration.

INSERT INTO google.datastream.private_connections (
data__labels,
data__displayName,
data__vpcPeeringConfig,
data__pscInterfaceConfig,
projectsId,
locationsId,
privateConnectionId,
requestId,
force,
validateOnly
)
SELECT 
'{{ labels }}',
'{{ displayName }}',
'{{ vpcPeeringConfig }}',
'{{ pscInterfaceConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateConnectionId }}',
'{{ requestId }}',
'{{ force }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: private_connections
  props:
    - name: projectsId
      value: string
      description: Required parameter for the private_connections resource.
    - name: locationsId
      value: string
      description: Required parameter for the private_connections resource.
    - name: labels
      value: object
      description: >
        Labels.
        
    - name: displayName
      value: string
      description: >
        Required. Display name.
        
    - name: vpcPeeringConfig
      value: object
      description: >
        VPC Peering Config.
        
    - name: pscInterfaceConfig
      value: object
      description: >
        PSC Interface Config.
        
    - name: privateConnectionId
      value: string
    - name: requestId
      value: string
    - name: force
      value: boolean
    - name: validateOnly
      value: boolean

DELETE examples

delete

Use this method to delete a private connectivity configuration.

DELETE FROM google.datastream.private_connections
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateConnectionsId = '{{ privateConnectionsId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}';