Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class DeleteClusterRequest.
Request for DeleteCluster.
Generated from protobuf messagegoogle.cloud.managedkafka.v1.DeleteClusterRequest
Namespace
Google \ Cloud \ ManagedKafka \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the cluster to delete.
↳ request_id
string
Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).
getName
Required. The name of the cluster to delete.
Returns
Type
Description
string
setName
Required. The name of the cluster to delete.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRequestId
Optional. An optional request ID to identify requests. Specify a unique
request ID to avoid duplication of requests. If a request times out or
fails, retrying with the same ID allows the server to recognize the
previous attempt. For at least 60 minutes, the server ignores duplicate
requests bearing the same ID.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID
within 60 minutes of the last request, the server checks if an original
operation with the same request ID was received. If so, the server ignores
the second request.
The request ID must be a valid UUID. A zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
Returns
Type
Description
string
setRequestId
Optional. An optional request ID to identify requests. Specify a unique
request ID to avoid duplication of requests. If a request times out or
fails, retrying with the same ID allows the server to recognize the
previous attempt. For at least 60 minutes, the server ignores duplicate
requests bearing the same ID.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID
within 60 minutes of the last request, the server checks if an original
operation with the same request ID was received. If so, the server ignores
the second request.
The request ID must be a valid UUID. A zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The name of the cluster to delete. Please seeManagedKafkaClient::clusterName()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 Managed Kafka V1 Client - Class DeleteClusterRequest (0.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.1 (latest)](/php/docs/reference/cloud-managedkafka/latest/V1.DeleteClusterRequest)\n- [0.6.0](/php/docs/reference/cloud-managedkafka/0.6.0/V1.DeleteClusterRequest)\n- [0.5.0](/php/docs/reference/cloud-managedkafka/0.5.0/V1.DeleteClusterRequest)\n- [0.4.1](/php/docs/reference/cloud-managedkafka/0.4.1/V1.DeleteClusterRequest)\n- [0.3.1](/php/docs/reference/cloud-managedkafka/0.3.1/V1.DeleteClusterRequest)\n- [0.2.3](/php/docs/reference/cloud-managedkafka/0.2.3/V1.DeleteClusterRequest)\n- [0.1.3](/php/docs/reference/cloud-managedkafka/0.1.3/V1.DeleteClusterRequest) \nReference documentation and code samples for the Google Cloud Managed Kafka V1 Client class DeleteClusterRequest.\n\nRequest for DeleteCluster.\n\nGenerated from protobuf message `google.cloud.managedkafka.v1.DeleteClusterRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ManagedKafka \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The name of the cluster to delete.\n\n### setName\n\nRequired. The name of the cluster to delete.\n\n### getRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID to avoid duplication of requests. If a request times out or\nfails, retrying with the same ID allows the server to recognize the\nprevious attempt. For at least 60 minutes, the server ignores duplicate\nrequests bearing the same ID.\n\nFor example, consider a situation where you make an initial request and the\nrequest times out. If you make the request again with the same request ID\nwithin 60 minutes of the last request, the server checks if an original\noperation with the same request ID was received. If so, the server ignores\nthe second request.\nThe request ID must be a valid UUID. A zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID to avoid duplication of requests. If a request times out or\nfails, retrying with the same ID allows the server to recognize the\nprevious attempt. For at least 60 minutes, the server ignores duplicate\nrequests bearing the same ID.\n\nFor example, consider a situation where you make an initial request and the\nrequest times out. If you make the request again with the same request ID\nwithin 60 minutes of the last request, the server checks if an original\noperation with the same request ID was received. If so, the server ignores\nthe second request.\nThe request ID must be a valid UUID. A zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\n\n### static::build"]]
