blockchain_nodes

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

Overview

Name	blockchain_nodes
Type	Resource
Id	google.blockchainnodeengine.blockchain_nodes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The fully qualified name of the blockchain node. e.g. projects/my-project/locations/us-central1/blockchainNodes/my-node.
blockchainType	string	Immutable. The blockchain type of the node.
connectionInfo	object	Output only. The connection information used to interact with a blockchain node. (id: ConnectionInfo)
createTime	string (google-datetime)	Output only. The timestamp at which the blockchain node was first created.
ethereumDetails	object	Ethereum-specific blockchain node details. (id: EthereumDetails)
labels	object	User-provided key-value pairs.
privateServiceConnectEnabled	boolean	Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: These nodes are deprecated, please use public endpoints instead.
state	string	Output only. A status representing the state of the node.
updateTime	string (google-datetime)	Output only. The timestamp at which the blockchain node was last updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. The fully qualified name of the blockchain node. e.g. projects/my-project/locations/us-central1/blockchainNodes/my-node.
blockchainType	string	Immutable. The blockchain type of the node.
connectionInfo	object	Output only. The connection information used to interact with a blockchain node. (id: ConnectionInfo)
createTime	string (google-datetime)	Output only. The timestamp at which the blockchain node was first created.
ethereumDetails	object	Ethereum-specific blockchain node details. (id: EthereumDetails)
labels	object	User-provided key-value pairs.
privateServiceConnectEnabled	boolean	Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: These nodes are deprecated, please use public endpoints instead.
state	string	Output only. A status representing the state of the node.
updateTime	string (google-datetime)	Output only. The timestamp at which the blockchain node was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, blockchainNodesId		Gets details of a single blockchain node.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists blockchain nodes in a given project and location.
create	insert	projectsId, locationsId	blockchainNodeId, requestId	Creates a new blockchain node in a given project and location.
patch	update	projectsId, locationsId, blockchainNodesId	updateMask, requestId	Updates the parameters of a single blockchain node.
delete	delete	projectsId, locationsId, blockchainNodesId	requestId	Deletes a single blockchain node.

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
blockchainNodesId	string
locationsId	string
projectsId	string
blockchainNodeId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single blockchain node.

SELECT
name,
blockchainType,
connectionInfo,
createTime,
ethereumDetails,
labels,
privateServiceConnectEnabled,
state,
updateTime
FROM google.blockchainnodeengine.blockchain_nodes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND blockchainNodesId = '{{ blockchainNodesId }}' -- required;

list

Lists blockchain nodes in a given project and location.

SELECT
name,
blockchainType,
connectionInfo,
createTime,
ethereumDetails,
labels,
privateServiceConnectEnabled,
state,
updateTime
FROM google.blockchainnodeengine.blockchain_nodes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new blockchain node in a given project and location.

INSERT INTO google.blockchainnodeengine.blockchain_nodes (
data__ethereumDetails,
data__labels,
data__blockchainType,
data__privateServiceConnectEnabled,
projectsId,
locationsId,
blockchainNodeId,
requestId
)
SELECT 
'{{ ethereumDetails }}',
'{{ labels }}',
'{{ blockchainType }}',
{{ privateServiceConnectEnabled }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ blockchainNodeId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: blockchain_nodes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the blockchain_nodes resource.
    - name: locationsId
      value: string
      description: Required parameter for the blockchain_nodes resource.
    - name: ethereumDetails
      value: object
      description: >
        Ethereum-specific blockchain node details.
        
    - name: labels
      value: object
      description: >
        User-provided key-value pairs.
        
    - name: blockchainType
      value: string
      description: >
        Immutable. The blockchain type of the node.
        
      valid_values: ['BLOCKCHAIN_TYPE_UNSPECIFIED', 'ETHEREUM']
    - name: privateServiceConnectEnabled
      value: boolean
      description: >
        Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: These nodes are deprecated, please use public endpoints instead.
        
    - name: blockchainNodeId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single blockchain node.

UPDATE google.blockchainnodeengine.blockchain_nodes
SET 
data__ethereumDetails = '{{ ethereumDetails }}',
data__labels = '{{ labels }}',
data__blockchainType = '{{ blockchainType }}',
data__privateServiceConnectEnabled = {{ privateServiceConnectEnabled }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND blockchainNodesId = '{{ blockchainNodesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single blockchain node.

DELETE FROM google.blockchainnodeengine.blockchain_nodes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND blockchainNodesId = '{{ blockchainNodesId }}' --required
AND requestId = '{{ requestId }}';