Google Cloud Oracle Database V1 Client - Class CloudVmClusterProperties (0.1.1)

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

Various properties and settings associated with Exadata VM cluster.

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

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ ocid string

Output only. Oracle Cloud Infrastructure ID of VM Cluster.

↳ license_type int

Required. License type of VM Cluster.

↳ gi_version string

Optional. Grid Infrastructure Version.

↳ time_zone Google\Type\TimeZone

Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.

↳ ssh_public_keys array

Optional. SSH public keys to be stored with cluster.

↳ node_count int

Optional. Number of database servers.

↳ shape string

Output only. Shape of VM Cluster.

↳ ocpu_count float

Optional. OCPU count per VM. Minimum is 0.1.

↳ memory_size_gb int

Optional. Memory allocated in GBs.

↳ db_node_storage_size_gb int

Optional. Local storage per VM.

↳ storage_size_gb int

Output only. The storage allocation for the disk group, in gigabytes (GB).

↳ data_storage_size_tb float

Optional. The data disk group size to be allocated in TBs.

↳ disk_redundancy int

Optional. The type of redundancy.

↳ sparse_diskgroup_enabled bool

Optional. Use exadata sparse snapshots.

↳ local_backup_enabled bool

Optional. Use local backup.

↳ hostname_prefix string

Optional. Prefix for VM cluster host names.

↳ diagnostics_data_collection_options DataCollectionOptions

Optional. Data collection options for diagnostics.

↳ state int

Output only. State of the cluster.

↳ scan_listener_port_tcp int

Output only. SCAN listener port - TCP

↳ scan_listener_port_tcp_ssl int

Output only. SCAN listener port - TLS

↳ domain string

Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com

↳ scan_dns string

Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com

↳ hostname string

Output only. host name without domain. format: "<hostname_prefix>-" with some suffix. ex: sp2-yi0xq where "sp2" is the hostname_prefix.

↳ cpu_core_count int

Required. Number of enabled CPU cores.

↳ system_version string

Output only. Operating system version of the image.

↳ scan_ip_ids array

Output only. OCIDs of scan IPs.

↳ scan_dns_record_id string

Output only. OCID of scan DNS record.

↳ oci_url string

Output only. Deep link to the OCI console to view this resource.

↳ db_server_ocids array

Optional. OCID of database servers.

↳ compartment_id string

Output only. Compartment ID of cluster.

↳ dns_listener_ip string

Output only. DNS listener IP.

↳ cluster_name string

Optional. OCI Cluster name.

getOcid

Output only. Oracle Cloud Infrastructure ID of VM Cluster.

Returns
Type Description
string

setOcid

Output only. Oracle Cloud Infrastructure ID of VM Cluster.

Parameter
Name Description
var string
Returns
Type Description
$this

getLicenseType

Required. License type of VM Cluster.

Returns
Type Description
int

setLicenseType

Required. License type of VM Cluster.

Parameter
Name Description
var int
Returns
Type Description
$this

getGiVersion

Optional. Grid Infrastructure Version.

Returns
Type Description
string

setGiVersion

Optional. Grid Infrastructure Version.

Parameter
Name Description
var string
Returns
Type Description
$this

getTimeZone

Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.

Returns
Type Description
Google\Type\TimeZone|null

hasTimeZone

clearTimeZone

setTimeZone

Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.

Parameter
Name Description
var Google\Type\TimeZone
Returns
Type Description
$this

getSshPublicKeys

Optional. SSH public keys to be stored with cluster.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSshPublicKeys

Optional. SSH public keys to be stored with cluster.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getNodeCount

Optional. Number of database servers.

Returns
Type Description
int

setNodeCount

Optional. Number of database servers.

Parameter
Name Description
var int
Returns
Type Description
$this

getShape

Output only. Shape of VM Cluster.

Returns
Type Description
string

setShape

Output only. Shape of VM Cluster.

Parameter
Name Description
var string
Returns
Type Description
$this

getOcpuCount

Optional. OCPU count per VM. Minimum is 0.1.

Returns
Type Description
float

setOcpuCount

Optional. OCPU count per VM. Minimum is 0.1.

Parameter
Name Description
var float
Returns
Type Description
$this

getMemorySizeGb

Optional. Memory allocated in GBs.

Returns
Type Description
int

setMemorySizeGb

Optional. Memory allocated in GBs.

Parameter
Name Description
var int
Returns
Type Description
$this

getDbNodeStorageSizeGb

Optional. Local storage per VM.

Returns
Type Description
int

setDbNodeStorageSizeGb

Optional. Local storage per VM.

Parameter
Name Description
var int
Returns
Type Description
$this

getStorageSizeGb

Output only. The storage allocation for the disk group, in gigabytes (GB).

Returns
Type Description
int

setStorageSizeGb

Output only. The storage allocation for the disk group, in gigabytes (GB).

Parameter
Name Description
var int
Returns
Type Description
$this

getDataStorageSizeTb

Optional. The data disk group size to be allocated in TBs.

Returns
Type Description
float

setDataStorageSizeTb

Optional. The data disk group size to be allocated in TBs.

Parameter
Name Description
var float
Returns
Type Description
$this

getDiskRedundancy

Optional. The type of redundancy.

Returns
Type Description
int

setDiskRedundancy

Optional. The type of redundancy.

Parameter
Name Description
var int
Returns
Type Description
$this

getSparseDiskgroupEnabled

Optional. Use exadata sparse snapshots.

Returns
Type Description
bool

setSparseDiskgroupEnabled

Optional. Use exadata sparse snapshots.

Parameter
Name Description
var bool
Returns
Type Description
$this

getLocalBackupEnabled

Optional. Use local backup.

Returns
Type Description
bool

setLocalBackupEnabled

Optional. Use local backup.

Parameter
Name Description
var bool
Returns
Type Description
$this

getHostnamePrefix

Optional. Prefix for VM cluster host names.

Returns
Type Description
string

setHostnamePrefix

Optional. Prefix for VM cluster host names.

Parameter
Name Description
var string
Returns
Type Description
$this

getDiagnosticsDataCollectionOptions

Optional. Data collection options for diagnostics.

Returns
Type Description
DataCollectionOptions|null

hasDiagnosticsDataCollectionOptions

clearDiagnosticsDataCollectionOptions

setDiagnosticsDataCollectionOptions

Optional. Data collection options for diagnostics.

Parameter
Name Description
var DataCollectionOptions
Returns
Type Description
$this

getState

Output only. State of the cluster.

Returns
Type Description
int

setState

Output only. State of the cluster.

Parameter
Name Description
var int
Returns
Type Description
$this

getScanListenerPortTcp

Output only. SCAN listener port - TCP

Returns
Type Description
int

setScanListenerPortTcp

Output only. SCAN listener port - TCP

Parameter
Name Description
var int
Returns
Type Description
$this

getScanListenerPortTcpSsl

Output only. SCAN listener port - TLS

Returns
Type Description
int

setScanListenerPortTcpSsl

Output only. SCAN listener port - TLS

Parameter
Name Description
var int
Returns
Type Description
$this

getDomain

Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com

Returns
Type Description
string

setDomain

Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com

Parameter
Name Description
var string
Returns
Type Description
$this

getScanDns

Output only. SCAN DNS name.

ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com

Returns
Type Description
string

setScanDns

Output only. SCAN DNS name.

ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com

Parameter
Name Description
var string
Returns
Type Description
$this

getHostname

Output only. host name without domain.

format: "<hostname_prefix>-" with some suffix. ex: sp2-yi0xq where "sp2" is the hostname_prefix.

Returns
Type Description
string

setHostname

Output only. host name without domain.

format: "<hostname_prefix>-" with some suffix. ex: sp2-yi0xq where "sp2" is the hostname_prefix.

Parameter
Name Description
var string
Returns
Type Description
$this

getCpuCoreCount

Required. Number of enabled CPU cores.

Returns
Type Description
int

setCpuCoreCount

Required. Number of enabled CPU cores.

Parameter
Name Description
var int
Returns
Type Description
$this

getSystemVersion

Output only. Operating system version of the image.

Returns
Type Description
string

setSystemVersion

Output only. Operating system version of the image.

Parameter
Name Description
var string
Returns
Type Description
$this

getScanIpIds

Output only. OCIDs of scan IPs.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setScanIpIds

Output only. OCIDs of scan IPs.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getScanDnsRecordId

Output only. OCID of scan DNS record.

Returns
Type Description
string

setScanDnsRecordId

Output only. OCID of scan DNS record.

Parameter
Name Description
var string
Returns
Type Description
$this

getOciUrl

Output only. Deep link to the OCI console to view this resource.

Returns
Type Description
string

setOciUrl

Output only. Deep link to the OCI console to view this resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getDbServerOcids

Optional. OCID of database servers.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDbServerOcids

Optional. OCID of database servers.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getCompartmentId

Output only. Compartment ID of cluster.

Returns
Type Description
string

setCompartmentId

Output only. Compartment ID of cluster.

Parameter
Name Description
var string
Returns
Type Description
$this

getDnsListenerIp

Output only. DNS listener IP.

Returns
Type Description
string

setDnsListenerIp

Output only. DNS listener IP.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterName

Optional. OCI Cluster name.

Returns
Type Description
string

setClusterName

Optional. OCI Cluster name.

Parameter
Name Description
var string
Returns
Type Description
$this