Reference documentation and code samples for the Google Cloud Tpu V2 Client class DeleteQueuedResourceRequest.
Request for DeleteQueuedResource.
Generated from protobuf message google.cloud.tpu.v2.DeleteQueuedResourceRequest
Namespace
Google \ Cloud \ Tpu \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name. |
↳ request_id |
string
Optional. Idempotent request UUID. |
↳ force |
bool
Optional. If set to true, all running nodes belonging to this queued resource will be deleted first and then the queued resource will be deleted. Otherwise (i.e. force=false), the queued resource will only be deleted if its nodes have already been deleted or the queued resource is in the ACCEPTED, FAILED, or SUSPENDED state. |
getName
Required. The resource name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestId
Optional. Idempotent request UUID.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRequestId
Optional. Idempotent request UUID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForce
Optional. If set to true, all running nodes belonging to this queued resource will be deleted first and then the queued resource will be deleted. Otherwise (i.e. force=false), the queued resource will only be deleted if its nodes have already been deleted or the queued resource is in the ACCEPTED, FAILED, or SUSPENDED state.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForce
Optional. If set to true, all running nodes belonging to this queued resource will be deleted first and then the queued resource will be deleted. Otherwise (i.e. force=false), the queued resource will only be deleted if its nodes have already been deleted or the queued resource is in the ACCEPTED, FAILED, or SUSPENDED state.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The resource name. Please see TpuClient::queuedResourceName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
DeleteQueuedResourceRequest |
|