0.14.0 (latest) 0.13.0 0.12.3 0.9.0 0.8.2 0.7.1 0.6.1 0.4.1 0.3.0 0.2.1 0.1.2 Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class ExadbVmClusterProperties.

The properties of an ExadbVmCluster.

Generated from protobuf message `google.cloud.oracledatabase.v1.ExadbVmClusterProperties`

## Namespace

Google \\ Cloud \\ OracleDatabase \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ cluster_name` | `string` Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name. |
| `↳ grid_image_id` | `string` Required. Immutable. Grid Infrastructure Version. |
| `↳ node_count` | `int` Required. The number of nodes/VMs in the ExadbVmCluster. |
| `↳ enabled_ecpu_count_per_node` | `int` Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure. |
| `↳ additional_ecpu_count_per_node` | `int` Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure. |
| `↳ vm_file_system_storage` | `https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterStorageDetails` Required. Immutable. Total storage details for the ExadbVmCluster. |
| `↳ license_model` | `int` Optional. Immutable. The license type of the ExadbVmCluster. |
| `↳ exascale_db_storage_vault` | `string` Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault} |
| `↳ hostname_prefix` | `string` Required. Immutable. Prefix for VM cluster host names. |
| `↳ hostname` | `string` Output only. The hostname of the ExadbVmCluster. |
| `↳ ssh_public_keys` | `string[]` Required. Immutable. The SSH public keys for the ExadbVmCluster. |
| `↳ data_collection_options` | `https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.DataCollectionOptionsCommon` Optional. Immutable. Indicates user preference for data collection options. |
| `↳ time_zone` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.TimeZone.html` Optional. Immutable. The time zone of the ExadbVmCluster. |
| `↳ lifecycle_state` | `int` Output only. State of the cluster. |
| `↳ shape_attribute` | `int` Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later |
| `↳ memory_size_gb` | `int` Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs. |
| `↳ scan_listener_port_tcp` | `int` Optional. Immutable. SCAN listener port - TCP |
| `↳ oci_uri` | `string` Output only. Deep link to the OCI console to view this resource. |
| `↳ gi_version` | `string` Output only. The Oracle Grid Infrastructure (GI) software version. |

### getClusterName

Optional. Immutable. The cluster name for Exascale vm cluster. The cluster
name must begin with an alphabetic character and may contain hyphens(-) but
can not contain underscores(_). It should be not more than 11 characters
and is not case sensitive. OCI Cluster name.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setClusterName

Optional. Immutable. The cluster name for Exascale vm cluster. The cluster
name must begin with an alphabetic character and may contain hyphens(-) but
can not contain underscores(_). It should be not more than 11 characters
and is not case sensitive. OCI Cluster name.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getGridImageId

Required. Immutable. Grid Infrastructure Version.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setGridImageId

Required. Immutable. Grid Infrastructure Version.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNodeCount

Required. The number of nodes/VMs in the ExadbVmCluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setNodeCount

Required. The number of nodes/VMs in the ExadbVmCluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEnabledEcpuCountPerNode

Required. Immutable. The number of ECPUs enabled per node for an exadata vm
cluster on exascale infrastructure.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setEnabledEcpuCountPerNode

Required. Immutable. The number of ECPUs enabled per node for an exadata vm
cluster on exascale infrastructure.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAdditionalEcpuCountPerNode

Optional. Immutable. The number of additional ECPUs per node for an Exadata
VM cluster on exascale infrastructure.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setAdditionalEcpuCountPerNode

Optional. Immutable. The number of additional ECPUs per node for an Exadata
VM cluster on exascale infrastructure.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getVmFileSystemStorage

Required. Immutable. Total storage details for the ExadbVmCluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterStorageDetails|null` |   |

### hasVmFileSystemStorage

### clearVmFileSystemStorage

### setVmFileSystemStorage

Required. Immutable. Total storage details for the ExadbVmCluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterStorageDetails` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLicenseModel

Optional. Immutable. The license type of the ExadbVmCluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [LicenseModel](https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterProperties.LicenseModel). |

### setLicenseModel

Optional. Immutable. The license type of the ExadbVmCluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [LicenseModel](https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterProperties.LicenseModel). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getExascaleDbStorageVault

Required. Immutable. The name of ExascaleDbStorageVault associated with the
ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a
new one can be created during the ExadbVmCluster creation (requires
storage_vault_properties to be set).

Format:
projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setExascaleDbStorageVault

Required. Immutable. The name of ExascaleDbStorageVault associated with the
ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a
new one can be created during the ExadbVmCluster creation (requires
storage_vault_properties to be set).

Format:
projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getHostnamePrefix

Required. Immutable. Prefix for VM cluster host names.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setHostnamePrefix

Required. Immutable. Prefix for VM cluster host names.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getHostname

Output only. The hostname of the ExadbVmCluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setHostname

Output only. The hostname of the ExadbVmCluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSshPublicKeys

Required. Immutable. The SSH public keys for the ExadbVmCluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\RepeatedField<string>` |   |

### setSshPublicKeys

Required. Immutable. The SSH public keys for the ExadbVmCluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDataCollectionOptions

Optional. Immutable. Indicates user preference for data collection options.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.DataCollectionOptionsCommon|null` |   |

### hasDataCollectionOptions

### clearDataCollectionOptions

### setDataCollectionOptions

Optional. Immutable. Indicates user preference for data collection options.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.DataCollectionOptionsCommon` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTimeZone

Optional. Immutable. The time zone of the ExadbVmCluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.TimeZone.html|null` |   |

### hasTimeZone

### clearTimeZone

### setTimeZone

Optional. Immutable. The time zone of the ExadbVmCluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.TimeZone.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLifecycleState

Output only. State of the cluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ExadbVmClusterLifecycleState](https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterProperties.ExadbVmClusterLifecycleState). |

### setLifecycleState

Output only. State of the cluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ExadbVmClusterLifecycleState](https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterProperties.ExadbVmClusterLifecycleState). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getShapeAttribute

Required. Immutable. The shape attribute of the VM cluster. The type of
Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE
which supports Oracle Database 23ai and later

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ShapeAttribute](https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterProperties.ShapeAttribute). |

### setShapeAttribute

Required. Immutable. The shape attribute of the VM cluster. The type of
Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE
which supports Oracle Database 23ai and later

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ShapeAttribute](https://docs.cloud.google.com/php/docs/reference/cloud-oracledatabase/latest/V1.ExadbVmClusterProperties.ShapeAttribute). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getMemorySizeGb

Output only. Memory per VM (GB) (Read-only): Shows the amount of memory
allocated to each VM. Memory is calculated based on 2.75 GB per Total
ECPUs.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setMemorySizeGb

Output only. Memory per VM (GB) (Read-only): Shows the amount of memory
allocated to each VM. Memory is calculated based on 2.75 GB per Total
ECPUs.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getScanListenerPortTcp

Optional. Immutable. SCAN listener port - TCP

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setScanListenerPortTcp

Optional. Immutable. SCAN listener port - TCP

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOciUri

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setOciUri

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getGiVersion

Output only. The Oracle Grid Infrastructure (GI) software version.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setGiVersion

Output only. The Oracle Grid Infrastructure (GI) software version.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |