Google Cloud Oracle Database V1 Client - Class DbSystem (0.8.0)

Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class DbSystem.

Details of the DbSystem (BaseDB) resource.

https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/

Generated from protobuf message google.cloud.oracledatabase.v1.DbSystem

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}
↳ properties DbSystemProperties

Optional. The properties of the DbSystem.
↳ gcp_oracle_zone string

Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. The labels or tags associated with the DbSystem.
↳ odb_network string

Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
↳ odb_subnet string

Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
↳ entitlement_id string

Output only. The ID of the subscription entitlement associated with the DbSystem
↳ display_name string

Required. The display name for the System db. The name does not have to be unique within your project.
↳ create_time Google\Protobuf\Timestamp

Output only. The date and time that the DbSystem was created.
↳ oci_url string

Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.

getName

Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}

Returns
Type Description
string

setName

Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}

Parameter
Name Description
var string
Returns
Type Description
$this

getProperties

Optional. The properties of the DbSystem.

Returns
Type Description
DbSystemProperties|null

hasProperties

clearProperties

setProperties

Optional. The properties of the DbSystem.

Parameter
Name Description
var DbSystemProperties
Returns
Type Description
$this

getGcpOracleZone

Optional. The GCP Oracle zone where Oracle DbSystem is hosted.

Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.

Returns
Type Description
string

setGcpOracleZone

Optional. The GCP Oracle zone where Oracle DbSystem is hosted.

Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. The labels or tags associated with the DbSystem.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels or tags associated with the DbSystem.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getOdbNetwork

Optional. The name of the OdbNetwork associated with the DbSystem.

Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.

Returns
Type Description
string

setOdbNetwork

Optional. The name of the OdbNetwork associated with the DbSystem.

Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.

Parameter
Name Description
var string
Returns
Type Description
$this

getOdbSubnet

Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}

Returns
Type Description
string

setOdbSubnet

Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}

Parameter
Name Description
var string
Returns
Type Description
$this

getEntitlementId

Output only. The ID of the subscription entitlement associated with the DbSystem

Returns
Type Description
string

setEntitlementId

Output only. The ID of the subscription entitlement associated with the DbSystem

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The display name for the System db. The name does not have to be unique within your project.

Returns
Type Description
string

setDisplayName

Required. The display name for the System db. The name does not have to be unique within your project.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The date and time that the DbSystem was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The date and time that the DbSystem was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getOciUrl

Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.

Returns
Type Description
string

setOciUrl

Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.

Parameter
Name Description
var string
Returns
Type Description
$this