Class ExadbVmClusterProperties (0.29.0)

public final class ExadbVmClusterProperties extends GeneratedMessageV3 implements ExadbVmClusterPropertiesOrBuilder

The properties of an ExadbVmCluster.

Protobuf type google.cloud.oracledatabase.v1.ExadbVmClusterProperties

Static Fields

ADDITIONAL_ECPU_COUNT_PER_NODE_FIELD_NUMBER

public static final int ADDITIONAL_ECPU_COUNT_PER_NODE_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER
Field Value
Type Description
int

DATA_COLLECTION_OPTIONS_FIELD_NUMBER

public static final int DATA_COLLECTION_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_ECPU_COUNT_PER_NODE_FIELD_NUMBER

public static final int ENABLED_ECPU_COUNT_PER_NODE_FIELD_NUMBER
Field Value
Type Description
int

EXASCALE_DB_STORAGE_VAULT_FIELD_NUMBER

public static final int EXASCALE_DB_STORAGE_VAULT_FIELD_NUMBER
Field Value
Type Description
int

GI_VERSION_FIELD_NUMBER

public static final int GI_VERSION_FIELD_NUMBER
Field Value
Type Description
int

GRID_IMAGE_ID_FIELD_NUMBER

public static final int GRID_IMAGE_ID_FIELD_NUMBER
Field Value
Type Description
int

HOSTNAME_FIELD_NUMBER

public static final int HOSTNAME_FIELD_NUMBER
Field Value
Type Description
int

HOSTNAME_PREFIX_FIELD_NUMBER

public static final int HOSTNAME_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

LICENSE_MODEL_FIELD_NUMBER

public static final int LICENSE_MODEL_FIELD_NUMBER
Field Value
Type Description
int

LIFECYCLE_STATE_FIELD_NUMBER

public static final int LIFECYCLE_STATE_FIELD_NUMBER
Field Value
Type Description
int

MEMORY_SIZE_GB_FIELD_NUMBER

public static final int MEMORY_SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

NODE_COUNT_FIELD_NUMBER

public static final int NODE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

OCI_URI_FIELD_NUMBER

public static final int OCI_URI_FIELD_NUMBER
Field Value
Type Description
int

SCAN_LISTENER_PORT_TCP_FIELD_NUMBER

public static final int SCAN_LISTENER_PORT_TCP_FIELD_NUMBER
Field Value
Type Description
int

SHAPE_ATTRIBUTE_FIELD_NUMBER

public static final int SHAPE_ATTRIBUTE_FIELD_NUMBER
Field Value
Type Description
int

SSH_PUBLIC_KEYS_FIELD_NUMBER

public static final int SSH_PUBLIC_KEYS_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

VM_FILE_SYSTEM_STORAGE_FIELD_NUMBER

public static final int VM_FILE_SYSTEM_STORAGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExadbVmClusterProperties getDefaultInstance()
Returns
Type Description
ExadbVmClusterProperties

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExadbVmClusterProperties.Builder newBuilder()
Returns
Type Description
ExadbVmClusterProperties.Builder

newBuilder(ExadbVmClusterProperties prototype)

public static ExadbVmClusterProperties.Builder newBuilder(ExadbVmClusterProperties prototype)
Parameter
Name Description
prototype ExadbVmClusterProperties
Returns
Type Description
ExadbVmClusterProperties.Builder

parseDelimitedFrom(InputStream input)

public static ExadbVmClusterProperties parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExadbVmClusterProperties parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExadbVmClusterProperties parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExadbVmClusterProperties parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExadbVmClusterProperties parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExadbVmClusterProperties parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExadbVmClusterProperties parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExadbVmClusterProperties parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExadbVmClusterProperties parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExadbVmClusterProperties parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExadbVmClusterProperties parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExadbVmClusterProperties parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExadbVmClusterProperties
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExadbVmClusterProperties> parser()
Returns
Type Description
Parser<ExadbVmClusterProperties>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdditionalEcpuCountPerNode()

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

The additionalEcpuCountPerNode.

getClusterName()

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

The clusterName.

getClusterNameBytes()

public 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
ByteString

The bytes for clusterName.

getDataCollectionOptions()

public 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
DataCollectionOptionsCommon

The dataCollectionOptions.

getDataCollectionOptionsOrBuilder()

public 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
DataCollectionOptionsCommonOrBuilder

getDefaultInstanceForType()

public ExadbVmClusterProperties getDefaultInstanceForType()
Returns
Type Description
ExadbVmClusterProperties

getEnabledEcpuCountPerNode()

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

The enabledEcpuCountPerNode.

getExascaleDbStorageVault()

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

The exascaleDbStorageVault.

getExascaleDbStorageVaultBytes()

public 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
ByteString

The bytes for exascaleDbStorageVault.

getGiVersion()

public String getGiVersion()

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

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

Returns
Type Description
String

The giVersion.

getGiVersionBytes()

public ByteString getGiVersionBytes()

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

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

Returns
Type Description
ByteString

The bytes for giVersion.

getGridImageId()

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

The gridImageId.

getGridImageIdBytes()

public 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
ByteString

The bytes for gridImageId.

getHostname()

public String getHostname()

Output only. The hostname of the ExadbVmCluster.

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

Returns
Type Description
String

The hostname.

getHostnameBytes()

public ByteString getHostnameBytes()

Output only. The hostname of the ExadbVmCluster.

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

Returns
Type Description
ByteString

The bytes for hostname.

getHostnamePrefix()

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

The hostnamePrefix.

getHostnamePrefixBytes()

public 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
ByteString

The bytes for hostnamePrefix.

getLicenseModel()

public 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
ExadbVmClusterProperties.LicenseModel

The licenseModel.

getLicenseModelValue()

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

The enum numeric value on the wire for licenseModel.

getLifecycleState()

public 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
ExadbVmClusterProperties.ExadbVmClusterLifecycleState

The lifecycleState.

getLifecycleStateValue()

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

The enum numeric value on the wire for lifecycleState.

getMemorySizeGb()

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

The memorySizeGb.

getNodeCount()

public int getNodeCount()

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

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

Returns
Type Description
int

The nodeCount.

getOciUri()

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

The ociUri.

getOciUriBytes()

public 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
ByteString

The bytes for ociUri.

getParserForType()

public Parser<ExadbVmClusterProperties> getParserForType()
Returns
Type Description
Parser<ExadbVmClusterProperties>
Overrides

getScanListenerPortTcp()

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

The scanListenerPortTcp.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShapeAttribute()

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

The shapeAttribute.

getShapeAttributeValue()

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

The enum numeric value on the wire for shapeAttribute.

getSshPublicKeys(int index)

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

The index of the element to return.

Returns
Type Description
String

The sshPublicKeys at the given index.

getSshPublicKeysBytes(int index)

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

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the sshPublicKeys at the given index.

getSshPublicKeysCount()

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

The count of sshPublicKeys.

getSshPublicKeysList()

public ProtocolStringList 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
ProtocolStringList

A list containing the sshPublicKeys.

getTimeZone()

public 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 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 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
ExadbVmClusterStorageDetails

The vmFileSystemStorage.

getVmFileSystemStorageOrBuilder()

public 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
ExadbVmClusterStorageDetailsOrBuilder

hasDataCollectionOptions()

public 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
boolean

Whether the dataCollectionOptions field is set.

hasTimeZone()

public 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
boolean

Whether the timeZone field is set.

hasVmFileSystemStorage()

public 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
boolean

Whether the vmFileSystemStorage field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExadbVmClusterProperties.Builder newBuilderForType()
Returns
Type Description
ExadbVmClusterProperties.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExadbVmClusterProperties.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExadbVmClusterProperties.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExadbVmClusterProperties.Builder toBuilder()
Returns
Type Description
ExadbVmClusterProperties.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException