odb_networks

Creates, updates, deletes, gets or lists an odb_networks resource.

Overview

Name	odb_networks
Type	Resource
Id	google.oracledatabase.odb_networks

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}
createTime	string (google-datetime)	Output only. The date and time that the OdbNetwork was created.
entitlementId	string	Output only. The ID of the subscription entitlement associated with the OdbNetwork.
labels	object	Optional. Labels or tags associated with the resource.
network	string	Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network}
state	string	Output only. State of the ODB Network.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}
createTime	string (google-datetime)	Output only. The date and time that the OdbNetwork was created.
entitlementId	string	Output only. The ID of the subscription entitlement associated with the OdbNetwork.
labels	object	Optional. Labels or tags associated with the resource.
network	string	Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network}
state	string	Output only. State of the ODB Network.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, odbNetworksId		Gets details of a single ODB Network.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists the ODB Networks in a given project and location.
create	insert	projectsId, locationsId	odbNetworkId, requestId	Creates a new ODB Network in a given project and location.
delete	delete	projectsId, locationsId, odbNetworksId	requestId	Deletes a single ODB Network.

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
odbNetworksId	string
projectsId	string
filter	string
odbNetworkId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single ODB Network.

SELECT
name,
createTime,
entitlementId,
labels,
network,
state
FROM google.oracledatabase.odb_networks
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND odbNetworksId = '{{ odbNetworksId }}' -- required;

list

Lists the ODB Networks in a given project and location.

SELECT
name,
createTime,
entitlementId,
labels,
network,
state
FROM google.oracledatabase.odb_networks
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 ODB Network in a given project and location.

INSERT INTO google.oracledatabase.odb_networks (
data__name,
data__network,
data__labels,
projectsId,
locationsId,
odbNetworkId,
requestId
)
SELECT 
'{{ name }}',
'{{ network }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ odbNetworkId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: odb_networks
  props:
    - name: projectsId
      value: string
      description: Required parameter for the odb_networks resource.
    - name: locationsId
      value: string
      description: Required parameter for the odb_networks resource.
    - name: name
      value: string
      description: >
        Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}
        
    - name: network
      value: string
      description: >
        Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network}
        
    - name: labels
      value: object
      description: >
        Optional. Labels or tags associated with the resource.
        
    - name: odbNetworkId
      value: string
    - name: requestId
      value: string

DELETE examples

delete

Deletes a single ODB Network.

DELETE FROM google.oracledatabase.odb_networks
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND odbNetworksId = '{{ odbNetworksId }}' --required
AND requestId = '{{ requestId }}';