# Oracle Database@Google Cloud API . projects . locations . cloudVmClusters

## Instance Methods

Returns the dbNodes Resource.

Close httplib2 connections.

Creates a new VM Cluster in a given project and location.

Deletes a single VM Cluster.

Gets details of a single VM Cluster.

Lists the VM Clusters in a given project and location.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, cloudVmClusterId=None, requestId=None, x__xgafv=None)`

    Creates a new VM Cluster in a given project and location.

    Args:
      parent: string, Required. The name of the parent in the following format: projects/{project}/locations/{location}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/
      "backupSubnetCidr": "A String", # Required. CIDR range of the backup subnet.
      "cidr": "A String", # Required. Network settings. CIDR to use for cluster IP allocation.
      "createTime": "A String", # Output only. The date and time that the VM cluster was created.
      "displayName": "A String", # Optional. User friendly name for this resource.
      "exadataInfrastructure": "A 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}
      "gcpOracleZone": "A String", # Output only. Google Cloud Platform location where Oracle Exadata is hosted. It is same as Google Cloud Platform Oracle zone of Exadata infrastructure.
      "labels": { # Optional. Labels or tags associated with the VM Cluster.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}
      "network": "A String", # Required. The name of the VPC network. Format: projects/{project}/global/networks/{network}
      "properties": { # Various properties and settings associated with Exadata VM cluster. # Optional. Various properties of the VM Cluster.
        "clusterName": "A String", # Optional. OCI Cluster name.
        "compartmentId": "A String", # Output only. Compartment ID of cluster.
        "cpuCoreCount": 42, # Required. Number of enabled CPU cores.
        "dataStorageSizeTb": 3.14, # Optional. The data disk group size to be allocated in TBs.
        "dbNodeStorageSizeGb": 42, # Optional. Local storage per VM.
        "dbServerOcids": [ # Optional. OCID of database servers.
          "A String",
        ],
        "diagnosticsDataCollectionOptions": { # Data collection options for diagnostics. # Optional. Data collection options for diagnostics.
          "diagnosticsEventsEnabled": True or False, # Optional. Indicates whether diagnostic collection is enabled for the VM cluster
          "healthMonitoringEnabled": True or False, # Optional. Indicates whether health monitoring is enabled for the VM cluster
          "incidentLogsEnabled": True or False, # Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster
        },
        "diskRedundancy": "A String", # Optional. The type of redundancy.
        "dnsListenerIp": "A String", # Output only. DNS listener IP.
        "domain": "A String", # Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com
        "giVersion": "A String", # Optional. Grid Infrastructure Version.
        "hostname": "A String", # Output only. host name without domain. format: "-" with some suffix. ex: sp2-yi0xq where "sp2" is the hostname_prefix.
        "hostnamePrefix": "A String", # Optional. Prefix for VM cluster host names.
        "licenseType": "A String", # Required. License type of VM Cluster.
        "localBackupEnabled": True or False, # Optional. Use local backup.
        "memorySizeGb": 42, # Optional. Memory allocated in GBs.
        "nodeCount": 42, # Optional. Number of database servers.
        "ociUrl": "A String", # Output only. Deep link to the OCI console to view this resource.
        "ocid": "A String", # Output only. Oracle Cloud Infrastructure ID of VM Cluster.
        "ocpuCount": 3.14, # Optional. OCPU count per VM. Minimum is 0.1.
        "scanDns": "A String", # Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com
        "scanDnsRecordId": "A String", # Output only. OCID of scan DNS record.
        "scanIpIds": [ # Output only. OCIDs of scan IPs.
          "A String",
        ],
        "scanListenerPortTcp": 42, # Output only. SCAN listener port - TCP
        "scanListenerPortTcpSsl": 42, # Output only. SCAN listener port - TLS
        "shape": "A String", # Output only. Shape of VM Cluster.
        "sparseDiskgroupEnabled": True or False, # Optional. Use exadata sparse snapshots.
        "sshPublicKeys": [ # Optional. SSH public keys to be stored with cluster.
          "A String",
        ],
        "state": "A String", # Output only. State of the cluster.
        "storageSizeGb": 42, # Output only. The storage allocation for the disk group, in gigabytes (GB).
        "systemVersion": "A String", # Optional. Operating system version of the image.
        "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.
          "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
          "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
        },
      },
    }

      cloudVmClusterId: string, Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
      requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`delete(name, force=None, requestId=None, x__xgafv=None)`

    Deletes a single VM Cluster.

    Args:
      name: string, Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}. (required)
      force: boolean, Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted.
      requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`get(name, x__xgafv=None)`

    Gets details of a single VM Cluster.

    Args:
      name: string, Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/
      "backupSubnetCidr": "A String", # Required. CIDR range of the backup subnet.
      "cidr": "A String", # Required. Network settings. CIDR to use for cluster IP allocation.
      "createTime": "A String", # Output only. The date and time that the VM cluster was created.
      "displayName": "A String", # Optional. User friendly name for this resource.
      "exadataInfrastructure": "A 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}
      "gcpOracleZone": "A String", # Output only. Google Cloud Platform location where Oracle Exadata is hosted. It is same as Google Cloud Platform Oracle zone of Exadata infrastructure.
      "labels": { # Optional. Labels or tags associated with the VM Cluster.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}
      "network": "A String", # Required. The name of the VPC network. Format: projects/{project}/global/networks/{network}
      "properties": { # Various properties and settings associated with Exadata VM cluster. # Optional. Various properties of the VM Cluster.
        "clusterName": "A String", # Optional. OCI Cluster name.
        "compartmentId": "A String", # Output only. Compartment ID of cluster.
        "cpuCoreCount": 42, # Required. Number of enabled CPU cores.
        "dataStorageSizeTb": 3.14, # Optional. The data disk group size to be allocated in TBs.
        "dbNodeStorageSizeGb": 42, # Optional. Local storage per VM.
        "dbServerOcids": [ # Optional. OCID of database servers.
          "A String",
        ],
        "diagnosticsDataCollectionOptions": { # Data collection options for diagnostics. # Optional. Data collection options for diagnostics.
          "diagnosticsEventsEnabled": True or False, # Optional. Indicates whether diagnostic collection is enabled for the VM cluster
          "healthMonitoringEnabled": True or False, # Optional. Indicates whether health monitoring is enabled for the VM cluster
          "incidentLogsEnabled": True or False, # Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster
        },
        "diskRedundancy": "A String", # Optional. The type of redundancy.
        "dnsListenerIp": "A String", # Output only. DNS listener IP.
        "domain": "A String", # Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com
        "giVersion": "A String", # Optional. Grid Infrastructure Version.
        "hostname": "A String", # Output only. host name without domain. format: "-" with some suffix. ex: sp2-yi0xq where "sp2" is the hostname_prefix.
        "hostnamePrefix": "A String", # Optional. Prefix for VM cluster host names.
        "licenseType": "A String", # Required. License type of VM Cluster.
        "localBackupEnabled": True or False, # Optional. Use local backup.
        "memorySizeGb": 42, # Optional. Memory allocated in GBs.
        "nodeCount": 42, # Optional. Number of database servers.
        "ociUrl": "A String", # Output only. Deep link to the OCI console to view this resource.
        "ocid": "A String", # Output only. Oracle Cloud Infrastructure ID of VM Cluster.
        "ocpuCount": 3.14, # Optional. OCPU count per VM. Minimum is 0.1.
        "scanDns": "A String", # Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com
        "scanDnsRecordId": "A String", # Output only. OCID of scan DNS record.
        "scanIpIds": [ # Output only. OCIDs of scan IPs.
          "A String",
        ],
        "scanListenerPortTcp": 42, # Output only. SCAN listener port - TCP
        "scanListenerPortTcpSsl": 42, # Output only. SCAN listener port - TLS
        "shape": "A String", # Output only. Shape of VM Cluster.
        "sparseDiskgroupEnabled": True or False, # Optional. Use exadata sparse snapshots.
        "sshPublicKeys": [ # Optional. SSH public keys to be stored with cluster.
          "A String",
        ],
        "state": "A String", # Output only. State of the cluster.
        "storageSizeGb": 42, # Output only. The storage allocation for the disk group, in gigabytes (GB).
        "systemVersion": "A String", # Optional. Operating system version of the image.
        "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.
          "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
          "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
        },
      },
    }

`list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists the VM Clusters in a given project and location.

    Args:
      parent: string, Required. The name of the parent in the following format: projects/{project}/locations/{location}. (required)
      filter: string, Optional. An expression for filtering the results of the request.
      pageSize: integer, Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000.
      pageToken: string, Optional. A token identifying the page of results the server returns.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # The response for `CloudVmCluster.List`.
      "cloudVmClusters": [ # The list of VM Clusters.
        { # Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/
          "backupSubnetCidr": "A String", # Required. CIDR range of the backup subnet.
          "cidr": "A String", # Required. Network settings. CIDR to use for cluster IP allocation.
          "createTime": "A String", # Output only. The date and time that the VM cluster was created.
          "displayName": "A String", # Optional. User friendly name for this resource.
          "exadataInfrastructure": "A 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}
          "gcpOracleZone": "A String", # Output only. Google Cloud Platform location where Oracle Exadata is hosted. It is same as Google Cloud Platform Oracle zone of Exadata infrastructure.
          "labels": { # Optional. Labels or tags associated with the VM Cluster.
            "a_key": "A String",
          },
          "name": "A String", # Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}
          "network": "A String", # Required. The name of the VPC network. Format: projects/{project}/global/networks/{network}
          "properties": { # Various properties and settings associated with Exadata VM cluster. # Optional. Various properties of the VM Cluster.
            "clusterName": "A String", # Optional. OCI Cluster name.
            "compartmentId": "A String", # Output only. Compartment ID of cluster.
            "cpuCoreCount": 42, # Required. Number of enabled CPU cores.
            "dataStorageSizeTb": 3.14, # Optional. The data disk group size to be allocated in TBs.
            "dbNodeStorageSizeGb": 42, # Optional. Local storage per VM.
            "dbServerOcids": [ # Optional. OCID of database servers.
              "A String",
            ],
            "diagnosticsDataCollectionOptions": { # Data collection options for diagnostics. # Optional. Data collection options for diagnostics.
              "diagnosticsEventsEnabled": True or False, # Optional. Indicates whether diagnostic collection is enabled for the VM cluster
              "healthMonitoringEnabled": True or False, # Optional. Indicates whether health monitoring is enabled for the VM cluster
              "incidentLogsEnabled": True or False, # Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster
            },
            "diskRedundancy": "A String", # Optional. The type of redundancy.
            "dnsListenerIp": "A String", # Output only. DNS listener IP.
            "domain": "A String", # Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com
            "giVersion": "A String", # Optional. Grid Infrastructure Version.
            "hostname": "A String", # Output only. host name without domain. format: "-" with some suffix. ex: sp2-yi0xq where "sp2" is the hostname_prefix.
            "hostnamePrefix": "A String", # Optional. Prefix for VM cluster host names.
            "licenseType": "A String", # Required. License type of VM Cluster.
            "localBackupEnabled": True or False, # Optional. Use local backup.
            "memorySizeGb": 42, # Optional. Memory allocated in GBs.
            "nodeCount": 42, # Optional. Number of database servers.
            "ociUrl": "A String", # Output only. Deep link to the OCI console to view this resource.
            "ocid": "A String", # Output only. Oracle Cloud Infrastructure ID of VM Cluster.
            "ocpuCount": 3.14, # Optional. OCPU count per VM. Minimum is 0.1.
            "scanDns": "A String", # Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com
            "scanDnsRecordId": "A String", # Output only. OCID of scan DNS record.
            "scanIpIds": [ # Output only. OCIDs of scan IPs.
              "A String",
            ],
            "scanListenerPortTcp": 42, # Output only. SCAN listener port - TCP
            "scanListenerPortTcpSsl": 42, # Output only. SCAN listener port - TLS
            "shape": "A String", # Output only. Shape of VM Cluster.
            "sparseDiskgroupEnabled": True or False, # Optional. Use exadata sparse snapshots.
            "sshPublicKeys": [ # Optional. SSH public keys to be stored with cluster.
              "A String",
            ],
            "state": "A String", # Output only. State of the cluster.
            "storageSizeGb": 42, # Output only. The storage allocation for the disk group, in gigabytes (GB).
            "systemVersion": "A String", # Optional. Operating system version of the image.
            "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.
              "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
              "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
            },
          },
        },
      ],
      "nextPageToken": "A String", # A token to fetch the next page of results.
    }

`list_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.