Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

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

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

Details of the Cloud VM Cluster resource.

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

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

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 VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}
`↳ exadata_infrastructure`	`string` Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}
`↳ display_name`	`string` Optional. User friendly name for this resource.
`↳ properties`	`CloudVmClusterProperties` Optional. Various properties of the VM Cluster.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. Labels or tags associated with the VM Cluster.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The date and time that the VM cluster was created.
`↳ cidr`	`string` Optional. Network settings. CIDR to use for cluster IP allocation.
`↳ backup_subnet_cidr`	`string` Optional. CIDR range of the backup subnet.
`↳ network`	`string` Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}
`↳ gcp_oracle_zone`	`string` Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.
`↳ odb_network`	`string` Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.
`↳ odb_subnet`	`string` Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
`↳ backup_odb_subnet`	`string` Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
`↳ identity_connector`	`IdentityConnector` Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.

getName

Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}

Returns
Type	Description
`string`

setName

Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExadataInfrastructure

Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}

Returns
Type	Description
`string`

setExadataInfrastructure

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Optional. User friendly name for this resource.

Returns
Type	Description
`string`

setDisplayName

Optional. User friendly name for this resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProperties

Optional. Various properties of the VM Cluster.

Returns
Type	Description
`CloudVmClusterProperties\|null`

hasProperties

clearProperties

setProperties

Optional. Various properties of the VM Cluster.

Parameter
Name	Description
`var`	`CloudVmClusterProperties`

Returns
Type	Description
`$this`

getLabels

Optional. Labels or tags associated with the VM Cluster.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. Labels or tags associated with the VM Cluster.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCreateTime

Output only. The date and time that the VM cluster was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The date and time that the VM cluster was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getCidr

Optional. Network settings. CIDR to use for cluster IP allocation.

Returns
Type	Description
`string`

setCidr

Optional. Network settings. CIDR to use for cluster IP allocation.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBackupSubnetCidr

Optional. CIDR range of the backup subnet.

Returns
Type	Description
`string`

setBackupSubnetCidr

Optional. CIDR range of the backup subnet.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getNetwork

Optional. The name of the VPC network.

Format: projects/{project}/global/networks/{network}

Returns
Type	Description
`string`

setNetwork

Optional. The name of the VPC network.

Format: projects/{project}/global/networks/{network}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGcpOracleZone

Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted.

This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.

Returns
Type	Description
`string`

setGcpOracleZone

Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted.

This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOdbNetwork

Optional. The name of the OdbNetwork associated with the VM Cluster.

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

Returns
Type	Description
`string`

setOdbNetwork

Optional. The name of the OdbNetwork associated with the VM Cluster.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOdbSubnet

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

Returns
Type	Description
`string`

setOdbSubnet

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBackupOdbSubnet

Optional. The name of the backup OdbSubnet associated with the VM Cluster.

Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}

Returns
Type	Description
`string`

setBackupOdbSubnet

Optional. The name of the backup OdbSubnet associated with the VM Cluster.

Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIdentityConnector

Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.

Returns
Type	Description
`IdentityConnector\|null`

hasIdentityConnector

clearIdentityConnector

setIdentityConnector

Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.

Parameter
Name	Description
`var`	`IdentityConnector`

Returns
Type	Description
`$this`