Generated from protobuf message google.cloud.vmwareengine.v1.DeletePrivateCloudRequest
Namespace
Google \ Cloud \ VmwareEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The resource name of the private cloud to delete. 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
↳ request_id
string
Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ force
bool
Optional. If set to true, cascade delete is enabled and all children of this private cloud resource are also deleted. When this flag is set to false, the private cloud will not be deleted if there are any children other than the management cluster. The management cluster is always deleted.
↳ delay_hours
int
Optional. Time delay of the deletion specified in hours. The default value is 3. Specifying a non-zero value for this field changes the value of PrivateCloud.state to DELETED and sets expire_time to the planned deletion time. Deletion can be cancelled before expire_time elapses using VmwareEngine.UndeletePrivateCloud. Specifying a value of 0 for this field instead begins the deletion process and ceases billing immediately. During the final deletion process, the value of PrivateCloud.state becomes PURGING.
getName
Required. The resource name of the private cloud to delete.
Optional. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns
Type
Description
string
setRequestId
Optional. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getForce
Optional. If set to true, cascade delete is enabled and all children of
this private cloud resource are also deleted. When this flag is set to
false, the private cloud will not be deleted if there are any children
other than the management cluster. The management cluster is always
deleted.
Returns
Type
Description
bool
setForce
Optional. If set to true, cascade delete is enabled and all children of
this private cloud resource are also deleted. When this flag is set to
false, the private cloud will not be deleted if there are any children
other than the management cluster. The management cluster is always
deleted.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getDelayHours
Optional. Time delay of the deletion specified in hours. The default value
is 3. Specifying a non-zero value for this field changes the value of
PrivateCloud.state to DELETED and sets expire_time to the planned
deletion time. Deletion can be cancelled before expire_time elapses using
VmwareEngine.UndeletePrivateCloud.
Specifying a value of 0 for this field instead begins the deletion
process and ceases billing immediately. During the final deletion process,
the value of PrivateCloud.state becomes PURGING.
Returns
Type
Description
int
hasDelayHours
clearDelayHours
setDelayHours
Optional. Time delay of the deletion specified in hours. The default value
is 3. Specifying a non-zero value for this field changes the value of
PrivateCloud.state to DELETED and sets expire_time to the planned
deletion time. Deletion can be cancelled before expire_time elapses using
VmwareEngine.UndeletePrivateCloud.
Specifying a value of 0 for this field instead begins the deletion
process and ceases billing immediately. During the final deletion process,
the value of PrivateCloud.state becomes PURGING.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The resource name of the private cloud to delete.
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
Please see VmwareEngineClient::privateCloudName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Vmware Engine V1 Client - Class DeletePrivateCloudRequest (1.1.4)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.4 (latest)](/php/docs/reference/cloud-vmware-engine/latest/V1.DeletePrivateCloudRequest)\n- [1.1.3](/php/docs/reference/cloud-vmware-engine/1.1.3/V1.DeletePrivateCloudRequest)\n- [1.0.0](/php/docs/reference/cloud-vmware-engine/1.0.0/V1.DeletePrivateCloudRequest)\n- [0.5.6](/php/docs/reference/cloud-vmware-engine/0.5.6/V1.DeletePrivateCloudRequest)\n- [0.4.0](/php/docs/reference/cloud-vmware-engine/0.4.0/V1.DeletePrivateCloudRequest)\n- [0.3.3](/php/docs/reference/cloud-vmware-engine/0.3.3/V1.DeletePrivateCloudRequest)\n- [0.2.1](/php/docs/reference/cloud-vmware-engine/0.2.1/V1.DeletePrivateCloudRequest)\n- [0.1.4](/php/docs/reference/cloud-vmware-engine/0.1.4/V1.DeletePrivateCloudRequest) \nReference documentation and code samples for the Google Cloud Vmware Engine V1 Client class DeletePrivateCloudRequest.\n\nRequest message for\n[VmwareEngine.DeletePrivateCloud](/php/docs/reference/cloud-vmware-engine/latest/V1.Client.VmwareEngineClient#_Google_Cloud_VmwareEngine_V1_Client_VmwareEngineClient__deletePrivateCloud__)\n\nGenerated from protobuf message `google.cloud.vmwareengine.v1.DeletePrivateCloudRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ VmwareEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The resource name of the private cloud to delete.\n\nResource names are schemeless URIs that follow the conventions in\n\u003chttps://cloud.google.com/apis/design/resource_names\u003e.\nFor example:\n`projects/my-project/locations/us-central1-a/privateClouds/my-cloud`\n\n### setName\n\nRequired. The resource name of the private cloud to delete.\n\nResource names are schemeless URIs that follow the conventions in\n\u003chttps://cloud.google.com/apis/design/resource_names\u003e.\nFor example:\n`projects/my-project/locations/us-central1-a/privateClouds/my-cloud`\n\n### getRequestId\n\nOptional. The request ID must be a valid UUID with the exception that zero\nUUID is not supported (00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. The request ID must be a valid UUID with the exception that zero\nUUID is not supported (00000000-0000-0000-0000-000000000000).\n\n### getForce\n\nOptional. If set to true, cascade delete is enabled and all children of\nthis private cloud resource are also deleted. When this flag is set to\nfalse, the private cloud will not be deleted if there are any children\nother than the management cluster. The management cluster is always\ndeleted.\n\n### setForce\n\nOptional. If set to true, cascade delete is enabled and all children of\nthis private cloud resource are also deleted. When this flag is set to\nfalse, the private cloud will not be deleted if there are any children\nother than the management cluster. The management cluster is always\ndeleted.\n\n### getDelayHours\n\nOptional. Time delay of the deletion specified in hours. The default value\nis `3`. Specifying a non-zero value for this field changes the value of\n`PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned\ndeletion time. Deletion can be cancelled before `expire_time` elapses using\n[VmwareEngine.UndeletePrivateCloud](/php/docs/reference/cloud-vmware-engine/latest/V1.Client.VmwareEngineClient#_Google_Cloud_VmwareEngine_V1_Client_VmwareEngineClient__undeletePrivateCloud__).\n\nSpecifying a value of `0` for this field instead begins the deletion\nprocess and ceases billing immediately. During the final deletion process,\nthe value of `PrivateCloud.state` becomes `PURGING`.\n\n### hasDelayHours\n\n### clearDelayHours\n\n### setDelayHours\n\nOptional. Time delay of the deletion specified in hours. The default value\nis `3`. Specifying a non-zero value for this field changes the value of\n`PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned\ndeletion time. Deletion can be cancelled before `expire_time` elapses using\n[VmwareEngine.UndeletePrivateCloud](/php/docs/reference/cloud-vmware-engine/latest/V1.Client.VmwareEngineClient#_Google_Cloud_VmwareEngine_V1_Client_VmwareEngineClient__undeletePrivateCloud__).\n\nSpecifying a value of `0` for this field instead begins the deletion\nprocess and ceases billing immediately. During the final deletion process,\nthe value of `PrivateCloud.state` becomes `PURGING`.\n\n### static::build"]]
