Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class PrivateCloud.
Represents a private cloud resource. Private clouds are zonal resources.
Generated from protobuf message google.cloud.vmwareengine.v1.PrivateCloud
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Creation time of this resource. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Last update time of this resource. |
↳ delete_time |
Google\Protobuf\Timestamp
Output only. Time when the resource was scheduled for deletion. |
↳ expire_time |
Google\Protobuf\Timestamp
Output only. Time when the resource will be irreversibly deleted. |
↳ state |
int
Output only. State of the resource. New values may be added to this enum when appropriate. |
↳ network_config |
Google\Cloud\VmwareEngine\V1\NetworkConfig
Required. Network configuration of the private cloud. |
↳ management_cluster |
Google\Cloud\VmwareEngine\V1\PrivateCloud\ManagementCluster
Required. Input only. The management cluster for this private cloud. This field is required during creation of the private cloud to provide details for the default cluster. The following fields can't be changed after private cloud creation: |
↳ description |
string
User-provided description for this private cloud. |
↳ hcx |
Google\Cloud\VmwareEngine\V1\Hcx
Output only. HCX appliance. |
↳ nsx |
Google\Cloud\VmwareEngine\V1\Nsx
Output only. NSX appliance. |
↳ vcenter |
Google\Cloud\VmwareEngine\V1\Vcenter
Output only. Vcenter appliance. |
↳ uid |
string
Output only. System-generated unique identifier for the resource. |
getName
Output only. The resource name of this private cloud.
Resource names are schemeless URIs that follow the conventions in
https://cloud.google.com/apis/design/resource_names.
For example:
projects/my-project/locations/us-central1-a/privateClouds/my-cloud
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name of this private cloud.
Resource names are schemeless URIs that follow the conventions in
https://cloud.google.com/apis/design/resource_names.
For example:
projects/my-project/locations/us-central1-a/privateClouds/my-cloud
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Creation time of this resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Last update time of this resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update time of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeleteTime
Output only. Time when the resource was scheduled for deletion.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. Time when the resource was scheduled for deletion.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpireTime
Output only. Time when the resource will be irreversibly deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasExpireTime
clearExpireTime
setExpireTime
Output only. Time when the resource will be irreversibly deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. State of the resource. New values may be added to this enum when appropriate.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. State of the resource. New values may be added to this enum when appropriate.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetworkConfig
Required. Network configuration of the private cloud.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VmwareEngine\V1\NetworkConfig|null | |
hasNetworkConfig
clearNetworkConfig
setNetworkConfig
Required. Network configuration of the private cloud.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VmwareEngine\V1\NetworkConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getManagementCluster
Required. Input only. The management cluster for this private cloud.
This field is required during creation of the private cloud to provide
details for the default cluster.
The following fields can't be changed after private cloud creation:
ManagementCluster.clusterId, ManagementCluster.nodeTypeId.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VmwareEngine\V1\PrivateCloud\ManagementCluster|null | |
hasManagementCluster
clearManagementCluster
setManagementCluster
Required. Input only. The management cluster for this private cloud.
This field is required during creation of the private cloud to provide
details for the default cluster.
The following fields can't be changed after private cloud creation:
ManagementCluster.clusterId, ManagementCluster.nodeTypeId.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VmwareEngine\V1\PrivateCloud\ManagementCluster
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
User-provided description for this private cloud.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
User-provided description for this private cloud.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHcx
Output only. HCX appliance.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VmwareEngine\V1\Hcx|null | |
hasHcx
clearHcx
setHcx
Output only. HCX appliance.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VmwareEngine\V1\Hcx
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNsx
Output only. NSX appliance.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VmwareEngine\V1\Nsx|null | |
hasNsx
clearNsx
setNsx
Output only. NSX appliance.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VmwareEngine\V1\Nsx
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVcenter
Output only. Vcenter appliance.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VmwareEngine\V1\Vcenter|null | |
hasVcenter
clearVcenter
setVcenter
Output only. Vcenter appliance.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VmwareEngine\V1\Vcenter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. System-generated unique identifier for the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. System-generated unique identifier for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |