ManagedKafka

import { ManagedKafka } from "https://googleapis.deno.dev/v1/managedkafka:v1.ts";

Manage Apache Kafka clusters and resources.

class ManagedKafka {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsClustersConsumerGroupsDelete(name: string): Promise<Empty>;

async projectsLocationsClustersConsumerGroupsGet(name: string): Promise<ConsumerGroup>;

async projectsLocationsClustersConsumerGroupsList(parent: string, opts?: ProjectsLocationsClustersConsumerGroupsListOptions): Promise<ListConsumerGroupsResponse>;

async projectsLocationsClustersConsumerGroupsPatch(

req: ConsumerGroup,

opts?: ProjectsLocationsClustersConsumerGroupsPatchOptions,

): Promise<ConsumerGroup>;

async projectsLocationsClustersCreate(

parent: string,

req: Cluster,

opts?: ProjectsLocationsClustersCreateOptions,

): Promise<Operation>;

async projectsLocationsClustersDelete(name: string, opts?: ProjectsLocationsClustersDeleteOptions): Promise<Operation>;

async projectsLocationsClustersGet(name: string): Promise<Cluster>;

async projectsLocationsClustersList(parent: string, opts?: ProjectsLocationsClustersListOptions): Promise<ListClustersResponse>;

async projectsLocationsClustersPatch(

req: Cluster,

opts?: ProjectsLocationsClustersPatchOptions,

): Promise<Operation>;

async projectsLocationsClustersTopicsCreate(

parent: string,

req: Topic,

opts?: ProjectsLocationsClustersTopicsCreateOptions,

): Promise<Topic>;

async projectsLocationsClustersTopicsDelete(name: string): Promise<Empty>;

async projectsLocationsClustersTopicsGet(name: string): Promise<Topic>;

async projectsLocationsClustersTopicsList(parent: string, opts?: ProjectsLocationsClustersTopicsListOptions): Promise<ListTopicsResponse>;

async projectsLocationsClustersTopicsPatch(

req: Topic,

opts?: ProjectsLocationsClustersTopicsPatchOptions,

): Promise<Topic>;

async projectsLocationsConnectClustersConnectorsCreate(

parent: string,

req: Connector,

opts?: ProjectsLocationsConnectClustersConnectorsCreateOptions,

): Promise<Connector>;

async projectsLocationsConnectClustersConnectorsDelete(name: string): Promise<Empty>;

async projectsLocationsConnectClustersConnectorsGet(name: string): Promise<Connector>;

async projectsLocationsConnectClustersConnectorsList(parent: string, opts?: ProjectsLocationsConnectClustersConnectorsListOptions): Promise<ListConnectorsResponse>;

async projectsLocationsConnectClustersConnectorsPatch(

req: Connector,

opts?: ProjectsLocationsConnectClustersConnectorsPatchOptions,

): Promise<Connector>;

async projectsLocationsConnectClustersConnectorsPause(name: string, req: PauseConnectorRequest): Promise<PauseConnectorResponse>;

async projectsLocationsConnectClustersConnectorsRestart(name: string, req: RestartConnectorRequest): Promise<RestartConnectorResponse>;

async projectsLocationsConnectClustersConnectorsResume(name: string, req: ResumeConnectorRequest): Promise<ResumeConnectorResponse>;

async projectsLocationsConnectClustersConnectorsStop(name: string, req: StopConnectorRequest): Promise<StopConnectorResponse>;

async projectsLocationsConnectClustersCreate(

parent: string,

req: ConnectCluster,

opts?: ProjectsLocationsConnectClustersCreateOptions,

): Promise<Operation>;

async projectsLocationsConnectClustersDelete(name: string, opts?: ProjectsLocationsConnectClustersDeleteOptions): Promise<Operation>;

async projectsLocationsConnectClustersGet(name: string): Promise<ConnectCluster>;

async projectsLocationsConnectClustersList(parent: string, opts?: ProjectsLocationsConnectClustersListOptions): Promise<ListConnectClustersResponse>;

async projectsLocationsConnectClustersPatch(

req: ConnectCluster,

opts?: ProjectsLocationsConnectClustersPatchOptions,

): Promise<Operation>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

}

§Constructors

new ManagedKafka(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsClustersConsumerGroupsDelete(name: string): Promise<Empty>

[src]

Deletes a single consumer group.

@param name

Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.

projectsLocationsClustersConsumerGroupsGet(name: string): Promise<ConsumerGroup>

[src]

Returns the properties of a single consumer group.

@param name

Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.

projectsLocationsClustersConsumerGroupsList(parent: string, opts?: ProjectsLocationsClustersConsumerGroupsListOptions): Promise<ListConsumerGroupsResponse>

[src]

Lists the consumer groups in a given cluster.

@param parent

Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

projectsLocationsClustersConsumerGroupsPatch(name: string, req: ConsumerGroup, opts?: ProjectsLocationsClustersConsumerGroupsPatchOptions): Promise<ConsumerGroup>

[src]

Updates the properties of a single consumer group.

@param name

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}

projectsLocationsClustersCreate(parent: string, req: Cluster, opts?: ProjectsLocationsClustersCreateOptions): Promise<Operation>

[src]

Creates a new cluster in a given project and location.

@param parent

Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.

projectsLocationsClustersDelete(name: string, opts?: ProjectsLocationsClustersDeleteOptions): Promise<Operation>

[src]

Deletes a single cluster.

@param name

Required. The name of the cluster to delete.

projectsLocationsClustersGet(name: string): Promise<Cluster>

[src]

Returns the properties of a single cluster.

@param name

Required. The name of the cluster whose configuration to return.

projectsLocationsClustersList(parent: string, opts?: ProjectsLocationsClustersListOptions): Promise<ListClustersResponse>

[src]

Lists the clusters in a given project and location.

@param parent

Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.

projectsLocationsClustersPatch(name: string, req: Cluster, opts?: ProjectsLocationsClustersPatchOptions): Promise<Operation>

[src]

Updates the properties of a single cluster.

@param name

Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}

projectsLocationsClustersTopicsCreate(parent: string, req: Topic, opts?: ProjectsLocationsClustersTopicsCreateOptions): Promise<Topic>

[src]

Creates a new topic in a given project and location.

@param parent

Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

projectsLocationsClustersTopicsDelete(name: string): Promise<Empty>

[src]

Deletes a single topic.

@param name

Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.

projectsLocationsClustersTopicsGet(name: string): Promise<Topic>

[src]

Returns the properties of a single topic.

@param name

Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.

projectsLocationsClustersTopicsList(parent: string, opts?: ProjectsLocationsClustersTopicsListOptions): Promise<ListTopicsResponse>

[src]

Lists the topics in a given cluster.

@param parent

Required. The parent cluster whose topics are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

projectsLocationsClustersTopicsPatch(name: string, req: Topic, opts?: ProjectsLocationsClustersTopicsPatchOptions): Promise<Topic>

[src]

Updates the properties of a single topic.

@param name

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}

projectsLocationsConnectClustersConnectorsCreate(parent: string, req: Connector, opts?: ProjectsLocationsConnectClustersConnectorsCreateOptions): Promise<Connector>

[src]

Creates a new connector in a given Connect cluster.

@param parent

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

projectsLocationsConnectClustersConnectorsDelete(name: string): Promise<Empty>

[src]

Deletes a connector.

@param name

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

projectsLocationsConnectClustersConnectorsGet(name: string): Promise<Connector>

[src]

Returns the properties of a single connector.

@param name

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

projectsLocationsConnectClustersConnectorsList(parent: string, opts?: ProjectsLocationsConnectClustersConnectorsListOptions): Promise<ListConnectorsResponse>

[src]

Lists the connectors in a given Connect cluster.

@param parent

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

projectsLocationsConnectClustersConnectorsPatch(name: string, req: Connector, opts?: ProjectsLocationsConnectClustersConnectorsPatchOptions): Promise<Connector>

[src]

Updates the properties of a connector.

@param name

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

projectsLocationsConnectClustersConnectorsPause(name: string, req: PauseConnectorRequest): Promise<PauseConnectorResponse>

[src]

Pauses the connector and its tasks.

@param name

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

projectsLocationsConnectClustersConnectorsRestart(name: string, req: RestartConnectorRequest): Promise<RestartConnectorResponse>

[src]

Restarts the connector.

@param name

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

projectsLocationsConnectClustersConnectorsResume(name: string, req: ResumeConnectorRequest): Promise<ResumeConnectorResponse>

[src]

Resumes the connector and its tasks.

@param name

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

projectsLocationsConnectClustersConnectorsStop(name: string, req: StopConnectorRequest): Promise<StopConnectorResponse>

[src]

Stops the connector.

@param name

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

projectsLocationsConnectClustersCreate(parent: string, req: ConnectCluster, opts?: ProjectsLocationsConnectClustersCreateOptions): Promise<Operation>

[src]

Creates a new Kafka Connect cluster in a given project and location.

@param parent

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

projectsLocationsConnectClustersDelete(name: string, opts?: ProjectsLocationsConnectClustersDeleteOptions): Promise<Operation>

[src]

Deletes a single Connect cluster.

@param name

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

projectsLocationsConnectClustersGet(name: string): Promise<ConnectCluster>

[src]

Returns the properties of a single Kafka Connect cluster.

@param name

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

projectsLocationsConnectClustersList(parent: string, opts?: ProjectsLocationsConnectClustersListOptions): Promise<ListConnectClustersResponse>

[src]

Lists the Kafka Connect clusters in a given project and location.

@param parent

Required. The parent project/location whose Connect clusters are to be listed. Structured like projects/{project}/locations/{location}.

projectsLocationsConnectClustersPatch(name: string, req: ConnectCluster, opts?: ProjectsLocationsConnectClustersPatchOptions): Promise<Operation>

[src]

Updates the properties of a single Kafka Connect cluster.

@param name

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

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.