# Interface ExadbVmClusterPropertiesOrBuilder (0.42.0)

0.42.0 (latest) 0.40.0 0.37.0 0.36.0 0.34.0 0.32.0 0.31.0 0.29.0 0.27.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.19.0 0.17.0 0.16.0 0.13.0 0.12.0 0.11.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

    public interface ExadbVmClusterPropertiesOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getAdditionalEcpuCountPerNode()

    public abstract int getAdditionalEcpuCountPerNode()

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

`
int32 additional_ecpu_count_per_node = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The additionalEcpuCountPerNode. |

### getClusterName()

    public abstract String 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.

`
string cluster_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The clusterName. |

### getClusterNameBytes()

    public abstract ByteString getClusterNameBytes()

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.

`
string cluster_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for clusterName. |

### getDataCollectionOptions()

    public abstract DataCollectionOptionsCommon getDataCollectionOptions()

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

`
.google.cloud.oracledatabase.v1.DataCollectionOptionsCommon data_collection_options = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.DataCollectionOptionsCommon` | The dataCollectionOptions. |

### getDataCollectionOptionsOrBuilder()

    public abstract DataCollectionOptionsCommonOrBuilder getDataCollectionOptionsOrBuilder()

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

`
.google.cloud.oracledatabase.v1.DataCollectionOptionsCommon data_collection_options = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.DataCollectionOptionsCommonOrBuilder` |   |

### getEnabledEcpuCountPerNode()

    public abstract int getEnabledEcpuCountPerNode()

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

`
int32 enabled_ecpu_count_per_node = 20 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enabledEcpuCountPerNode. |

### getExascaleDbStorageVault()

    public abstract String 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}

`
string exascale_db_storage_vault = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The exascaleDbStorageVault. |

### getExascaleDbStorageVaultBytes()

    public abstract ByteString getExascaleDbStorageVaultBytes()

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}

`
string exascale_db_storage_vault = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for exascaleDbStorageVault. |

### getGiVersion()

    public abstract String getGiVersion()

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

`string gi_version = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The giVersion. |

### getGiVersionBytes()

    public abstract ByteString getGiVersionBytes()

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

`string gi_version = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for giVersion. |

### getGridImageId()

    public abstract String getGridImageId()

Required. Immutable. Grid Infrastructure Version.

`
string grid_image_id = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The gridImageId. |

### getGridImageIdBytes()

    public abstract ByteString getGridImageIdBytes()

Required. Immutable. Grid Infrastructure Version.

`
string grid_image_id = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for gridImageId. |

### getHostname()

    public abstract String getHostname()

Output only. The hostname of the ExadbVmCluster.

`string hostname = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The hostname. |

### getHostnameBytes()

    public abstract ByteString getHostnameBytes()

Output only. The hostname of the ExadbVmCluster.

`string hostname = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for hostname. |

### getHostnamePrefix()

    public abstract String getHostnamePrefix()

Required. Immutable. Prefix for VM cluster host names.

`
string hostname_prefix = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The hostnamePrefix. |

### getHostnamePrefixBytes()

    public abstract ByteString getHostnamePrefixBytes()

Required. Immutable. Prefix for VM cluster host names.

`
string hostname_prefix = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for hostnamePrefix. |

### getLicenseModel()

    public abstract ExadbVmClusterProperties.LicenseModel getLicenseModel()

Optional. Immutable. The license type of the ExadbVmCluster.

`
.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.LicenseModel license_model = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.LicenseModel` | The licenseModel. |

### getLicenseModelValue()

    public abstract int getLicenseModelValue()

Optional. Immutable. The license type of the ExadbVmCluster.

`
.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.LicenseModel license_model = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for licenseModel. |

### getLifecycleState()

    public abstract ExadbVmClusterProperties.ExadbVmClusterLifecycleState getLifecycleState()

Output only. State of the cluster.

`
.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.ExadbVmClusterLifecycleState lifecycle_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.ExadbVmClusterLifecycleState` | The lifecycleState. |

### getLifecycleStateValue()

    public abstract int getLifecycleStateValue()

Output only. State of the cluster.

`
.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.ExadbVmClusterLifecycleState lifecycle_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for lifecycleState. |

### getMemorySizeGb()

    public abstract int 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.

`int32 memory_size_gb = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The memorySizeGb. |

### getNodeCount()

    public abstract int getNodeCount()

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

`int32 node_count = 3 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The nodeCount. |

### getOciUri()

    public abstract String getOciUri()

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

`string oci_uri = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The ociUri. |

### getOciUriBytes()

    public abstract ByteString getOciUriBytes()

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

`string oci_uri = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for ociUri. |

### getScanListenerPortTcp()

    public abstract int getScanListenerPortTcp()

Optional. Immutable. SCAN listener port - TCP

`
int32 scan_listener_port_tcp = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The scanListenerPortTcp. |

### getShapeAttribute()

    public abstract ExadbVmClusterProperties.ShapeAttribute 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

`
.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.ShapeAttribute shape_attribute = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.ShapeAttribute` | The shapeAttribute. |

### getShapeAttributeValue()

    public abstract int getShapeAttributeValue()

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

`
.google.cloud.oracledatabase.v1.ExadbVmClusterProperties.ShapeAttribute shape_attribute = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for shapeAttribute. |

### getSshPublicKeys(int index)

    public abstract String getSshPublicKeys(int index)

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

`
repeated string ssh_public_keys = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the element to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The sshPublicKeys at the given index. |

### getSshPublicKeysBytes(int index)

    public abstract ByteString getSshPublicKeysBytes(int index)

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

`
repeated string ssh_public_keys = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the value to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes of the sshPublicKeys at the given index. |

### getSshPublicKeysCount()

    public abstract int getSshPublicKeysCount()

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

`
repeated string ssh_public_keys = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The count of sshPublicKeys. |

### getSshPublicKeysList()

    public abstract List<String> getSshPublicKeysList()

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

`
repeated string ssh_public_keys = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` | A list containing the sshPublicKeys. |

### getTimeZone()

    public abstract TimeZone getTimeZone()

Optional. Immutable. The time zone of the ExadbVmCluster.

`
.google.type.TimeZone time_zone = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.type.TimeZone` | The timeZone. |

### getTimeZoneOrBuilder()

    public abstract TimeZoneOrBuilder getTimeZoneOrBuilder()

Optional. Immutable. The time zone of the ExadbVmCluster.

`
.google.type.TimeZone time_zone = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.type.TimeZoneOrBuilder` |   |

### getVmFileSystemStorage()

    public abstract ExadbVmClusterStorageDetails getVmFileSystemStorage()

Required. Immutable. Total storage details for the ExadbVmCluster.

`
.google.cloud.oracledatabase.v1.ExadbVmClusterStorageDetails vm_file_system_storage = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.ExadbVmClusterStorageDetails` | The vmFileSystemStorage. |

### getVmFileSystemStorageOrBuilder()

    public abstract ExadbVmClusterStorageDetailsOrBuilder getVmFileSystemStorageOrBuilder()

Required. Immutable. Total storage details for the ExadbVmCluster.

`
.google.cloud.oracledatabase.v1.ExadbVmClusterStorageDetails vm_file_system_storage = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.ExadbVmClusterStorageDetailsOrBuilder` |   |

### hasDataCollectionOptions()

    public abstract boolean hasDataCollectionOptions()

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

`
.google.cloud.oracledatabase.v1.DataCollectionOptionsCommon data_collection_options = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the dataCollectionOptions field is set. |

### hasTimeZone()

    public abstract boolean hasTimeZone()

Optional. Immutable. The time zone of the ExadbVmCluster.

`
.google.type.TimeZone time_zone = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the timeZone field is set. |

### hasVmFileSystemStorage()

    public abstract boolean hasVmFileSystemStorage()

Required. Immutable. Total storage details for the ExadbVmCluster.

`
.google.cloud.oracledatabase.v1.ExadbVmClusterStorageDetails vm_file_system_storage = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the vmFileSystemStorage field is set. |