Google Cloud Vmware Engine V1 Client - Class DeletePrivateCloudRequest (0.4.0)

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class DeletePrivateCloudRequest.

Request message for VmwareEngine.DeletePrivateCloud

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.

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

Required. The resource name of the private cloud to delete.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRequestId

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

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

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 Google\Cloud\VmwareEngine\V1\VmwareEngineClient::privateCloudName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\VmwareEngine\V1\DeletePrivateCloudRequest`