Close httplib2 connections.
create(parent, body=None, topicId=None, x__xgafv=None)
Creates a new topic in a given project and location.
Deletes a single topic.
Returns the properties of a single topic.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the topics in a given cluster.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the properties of a single topic.
close()
Close httplib2 connections.
create(parent, body=None, topicId=None, x__xgafv=None)
Creates a new topic in a given project and location. Args: parent: string, Required. The parent cluster in which to create the topic. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`. (required) body: object, The request body. The object takes the form of: { # A Kafka topic in a given cluster. "configs": { # Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`. "a_key": "A String", }, "name": "A String", # 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} "partitionCount": 42, # Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected. "replicationFactor": 42, # Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability. } topicId: string, 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`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A Kafka topic in a given cluster. "configs": { # Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`. "a_key": "A String", }, "name": "A String", # 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} "partitionCount": 42, # Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected. "replicationFactor": 42, # Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability. }
delete(name, x__xgafv=None)
Deletes a single topic. Args: name: string, Required. The name of the topic to delete. `projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}`. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }
get(name, x__xgafv=None)
Returns the properties of a single topic. Args: name: string, Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A Kafka topic in a given cluster. "configs": { # Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`. "a_key": "A String", }, "name": "A String", # 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} "partitionCount": 42, # Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected. "replicationFactor": 42, # Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability. }
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the topics in a given cluster. Args: parent: string, Required. The parent cluster whose topics are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`. (required) pageSize: integer, 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. pageToken: string, 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. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response for ListTopics. "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. "topics": [ # The list of topics in the requested parent. The order of the topics is unspecified. { # A Kafka topic in a given cluster. "configs": { # Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`. "a_key": "A String", }, "name": "A String", # 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} "partitionCount": 42, # Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected. "replicationFactor": 42, # Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability. }, ], }
list_next()
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the properties of a single topic. Args: name: string, 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} (required) body: object, The request body. The object takes the form of: { # A Kafka topic in a given cluster. "configs": { # Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`. "a_key": "A String", }, "name": "A String", # 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} "partitionCount": 42, # Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected. "replicationFactor": 42, # Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability. } updateMask: string, 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. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A Kafka topic in a given cluster. "configs": { # Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`. "a_key": "A String", }, "name": "A String", # 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} "partitionCount": 42, # Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected. "replicationFactor": 42, # Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability. }