2025-03-12
▼ ▲ managedkafka.projects.locations.list
Path : v1/{+name}/locations
Flat Path : v1/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service.
▼ ▲ managedkafka.projects.locations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
▼ ▲ managedkafka.projects.locations.operations.list
Path : v1/{+name}/operations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ managedkafka.projects.locations.operations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ managedkafka.projects.locations.operations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ managedkafka.projects.locations.operations.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
▼ ▲ managedkafka.projects.locations.clusters.list
Path : v1/{+parent}/clusters
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters
HTTP Method : GET
Parameters :
parent
Description : Required. The parent location whose clusters are to be listed. Structured like `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClusters` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. Filter expression for the result.
Location : query
Type : string
orderBy
Description : Optional. Order by fields for the result.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the clusters in a given project and location.
▼ ▲ managedkafka.projects.locations.clusters.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the cluster whose configuration to return.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the properties of a single cluster.
▼ ▲ managedkafka.projects.locations.clusters.create
Path : v1/{+parent}/clusters
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters
HTTP Method : POST
Parameters :
parent
Description : Required. The parent region in which to create the cluster. Structured like `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
clusterId
Description : Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-cluster-id`.
Location : query
Type : string
requestId
Description : 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).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new cluster in a given project and location.
▼ ▲ managedkafka.projects.locations.clusters.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : 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).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the properties of a single cluster.
▼ ▲ managedkafka.projects.locations.clusters.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the cluster to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : 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).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single cluster.
▼ ▲ managedkafka.projects.locations.clusters.topics.list
Path : v1/{+parent}/topics
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics
HTTP Method : GET
Parameters :
parent
Description : Required. The parent cluster whose topics are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the topics in a given cluster.
▼ ▲ managedkafka.projects.locations.clusters.topics.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics/{topicsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/topics/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the properties of a single topic.
▼ ▲ managedkafka.projects.locations.clusters.topics.create
Path : v1/{+parent}/topics
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics
HTTP Method : POST
Parameters :
parent
Description : Required. The parent cluster in which to create the topic. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
topicId
Description : Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new topic in a given project and location.
▼ ▲ managedkafka.projects.locations.clusters.topics.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics/{topicsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the topic. The `topic` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/topics/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Field mask is used to specify the fields to be overwritten in the Topic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the properties of a single topic.
▼ ▲ managedkafka.projects.locations.clusters.topics.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics/{topicsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the topic to delete. `projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}`.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/topics/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single topic.
▼ ▲ managedkafka.projects.locations.clusters.consumerGroups.list
Path : v1/{+parent}/consumerGroups
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups
HTTP Method : GET
Parameters :
parent
Description : Required. The parent cluster whose consumer groups are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListConsumerGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConsumerGroups` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the consumer groups in a given cluster.
▼ ▲ managedkafka.projects.locations.clusters.consumerGroups.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups/{consumerGroupsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the consumer group whose configuration to return. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/consumerGroups/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the properties of a single consumer group.
▼ ▲ managedkafka.projects.locations.clusters.consumerGroups.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups/{consumerGroupsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/consumerGroups/.*$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the properties of a single consumer group.
▼ ▲ managedkafka.projects.locations.clusters.consumerGroups.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups/{consumerGroupsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the consumer group to delete. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/consumerGroups/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single consumer group.