Managed Service for Apache Kafka API (managedkafka:v1)

2025-03-21

14 new methods

Additions

    Methods
  • managedkafka.projects.locations.connectClusters.list

      Path : v1/{+parent}/connectClusters

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent project/location whose Connect 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 Connect 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 `ListConnectClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectClusters` 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 Kafka Connect clusters in a given project and location.

  • managedkafka.projects.locations.connectClusters.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the Kafka Connect cluster whose configuration to return. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Returns the properties of a single Kafka Connect cluster.

  • managedkafka.projects.locations.connectClusters.create

      Path : v1/{+parent}/connectClusters

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent project/location in which to create the Kafka Connect cluster. Structured like `projects/{project}/locations/{location}/`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        connectClusterId

          Description : Required. The ID to use for the Connect 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 Kafka Connect cluster in a given project and location.

  • managedkafka.projects.locations.connectClusters.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$

          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 Kafka Connect cluster.

  • managedkafka.projects.locations.connectClusters.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the Kafka Connect cluster to delete. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$

          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 Connect cluster.

  • managedkafka.projects.locations.connectClusters.connectors.list

      Path : v1/{+parent}/connectors

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent Connect cluster whose connectors are to be listed. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. The maximum number of connectors 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 `ListConnectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectors` 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 connectors in a given Connect cluster.

  • managedkafka.projects.locations.connectClusters.connectors.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the connector whose configuration to return. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Returns the properties of a single connector.

  • managedkafka.projects.locations.connectClusters.connectors.create

      Path : v1/{+parent}/connectors

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent Connect cluster in which to create the connector. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$

          Location : path

          Required : Yes

          Type : string

        connectorId

          Description : Required. The ID to use for the connector, which will become the final component of the connector'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-connector-id`.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a new connector in a given Connect cluster.

  • managedkafka.projects.locations.connectClusters.connectors.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$

          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

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Updates the properties of a connector.

  • managedkafka.projects.locations.connectClusters.connectors.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the connector to delete. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a connector.

  • managedkafka.projects.locations.connectClusters.connectors.pause

      Path : v1/{+name}:pause

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:pause

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Pauses the connector and its tasks.

  • managedkafka.projects.locations.connectClusters.connectors.resume

      Path : v1/{+name}:resume

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:resume

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Resumes the connector and its tasks.

  • managedkafka.projects.locations.connectClusters.connectors.restart

      Path : v1/{+name}:restart

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:restart

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the connector to restart. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Restarts the connector.

  • managedkafka.projects.locations.connectClusters.connectors.stop

      Path : v1/{+name}:stop

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:stop

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the connector to stop. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}

          Pattern : ^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Stops the connector.