Package Methods (0.1.0)

Summary of entries of Methods for google-cloud-managedkafka.

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient

ManagedKafkaAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.managedkafka_v1.services.managed_kafka.transports.base.ManagedKafkaTransport, typing.Callable[[...], google.cloud.managedkafka_v1.services.managed_kafka.transports.base.ManagedKafkaTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the managed kafka async client.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.cancel_operation

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.cluster_path

cluster_path(project: str, location: str, cluster: str) -> str

Returns a fully-qualified cluster string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.cluster_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_billing_account_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_folder_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_location_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_organization_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.common_project_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.consumer_group_path

consumer_group_path(
    project: str, location: str, cluster: str, consumer_group: str
) -> str

Returns a fully-qualified consumer_group string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.consumer_group_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.create_cluster

create_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.CreateClusterRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    cluster: typing.Optional[
        google.cloud.managedkafka_v1.types.resources.Cluster
    ] = None,
    cluster_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new cluster in a given project and location.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.create_cluster

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.create_topic

create_topic(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.CreateTopicRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    topic: typing.Optional[google.cloud.managedkafka_v1.types.resources.Topic] = None,
    topic_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.Topic

Creates a new topic in a given project and location.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.create_topic

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.crypto_key_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.delete_cluster

delete_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.DeleteClusterRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a single cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.delete_cluster

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.delete_consumer_group

delete_consumer_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.DeleteConsumerGroupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a single consumer group.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.delete_consumer_group

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a long-running operation.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.delete_operation

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.delete_topic

delete_topic(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.DeleteTopicRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a single topic.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.delete_topic

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.from_service_account_file

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.from_service_account_info

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.from_service_account_json

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_cluster

get_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.GetClusterRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.Cluster

Returns the properties of a single cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_cluster

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_consumer_group

get_consumer_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.GetConsumerGroupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.ConsumerGroup

Returns the properties of a single consumer group.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_consumer_group

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_location

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_operation

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_topic

get_topic(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.GetTopicRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.Topic

Returns the properties of a single topic.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_topic

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.managedkafka_v1.services.managed_kafka.transports.base.ManagedKafkaTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.get_transport_class

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_clusters

list_clusters(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.ListClustersRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListClustersAsyncPager

Lists the clusters in a given project and location.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_clusters

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_consumer_groups

list_consumer_groups(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListConsumerGroupsAsyncPager
)

Lists the consumer groups in a given cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_consumer_groups

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_locations

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_operations

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_topics

list_topics(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListTopicsAsyncPager

Lists the topics in a given cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.list_topics

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_cluster_path

parse_cluster_path(path: str) -> typing.Dict[str, str]

Parses a cluster path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_cluster_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_billing_account_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_folder_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_location_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_organization_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_common_project_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_consumer_group_path

parse_consumer_group_path(path: str) -> typing.Dict[str, str]

Parses a consumer_group path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_consumer_group_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_crypto_key_path

parse_crypto_key_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_crypto_key_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_topic_path

parse_topic_path(path: str) -> typing.Dict[str, str]

Parses a topic path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.parse_topic_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.topic_path

topic_path(project: str, location: str, cluster: str, topic: str) -> str

Returns a fully-qualified topic string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.topic_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.update_cluster

update_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.UpdateClusterRequest, dict
        ]
    ] = None,
    *,
    cluster: typing.Optional[
        google.cloud.managedkafka_v1.types.resources.Cluster
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates the properties of a single cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.update_cluster

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.update_consumer_group

update_consumer_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.UpdateConsumerGroupRequest,
            dict,
        ]
    ] = None,
    *,
    consumer_group: typing.Optional[
        google.cloud.managedkafka_v1.types.resources.ConsumerGroup
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.ConsumerGroup

Updates the properties of a single consumer group.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.update_consumer_group

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.update_topic

update_topic(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.UpdateTopicRequest, dict
        ]
    ] = None,
    *,
    topic: typing.Optional[google.cloud.managedkafka_v1.types.resources.Topic] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.Topic

Updates the properties of a single topic.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaAsyncClient.update_topic

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient

ManagedKafkaClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.managedkafka_v1.services.managed_kafka.transports.base.ManagedKafkaTransport, typing.Callable[[...], google.cloud.managedkafka_v1.services.managed_kafka.transports.base.ManagedKafkaTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the managed kafka client.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.exit

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.cancel_operation

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.cluster_path

cluster_path(project: str, location: str, cluster: str) -> str

Returns a fully-qualified cluster string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.cluster_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_billing_account_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_folder_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_location_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_organization_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.common_project_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.consumer_group_path

consumer_group_path(
    project: str, location: str, cluster: str, consumer_group: str
) -> str

Returns a fully-qualified consumer_group string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.consumer_group_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.create_cluster

create_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.CreateClusterRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    cluster: typing.Optional[
        google.cloud.managedkafka_v1.types.resources.Cluster
    ] = None,
    cluster_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new cluster in a given project and location.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.create_cluster

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.create_topic

create_topic(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.CreateTopicRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    topic: typing.Optional[google.cloud.managedkafka_v1.types.resources.Topic] = None,
    topic_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.Topic

Creates a new topic in a given project and location.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.create_topic

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.crypto_key_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.delete_cluster

delete_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.DeleteClusterRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a single cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.delete_cluster

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.delete_consumer_group

delete_consumer_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.DeleteConsumerGroupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a single consumer group.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.delete_consumer_group

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a long-running operation.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.delete_operation

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.delete_topic

delete_topic(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.DeleteTopicRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a single topic.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.delete_topic

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.from_service_account_file

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.from_service_account_info

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.from_service_account_json

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_cluster

get_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.GetClusterRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.Cluster

Returns the properties of a single cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_cluster

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_consumer_group

get_consumer_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.GetConsumerGroupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.ConsumerGroup

Returns the properties of a single consumer group.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_consumer_group

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_location

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_mtls_endpoint_and_cert_source

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_operation

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_topic

get_topic(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.GetTopicRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.Topic

Returns the properties of a single topic.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.get_topic

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_clusters

list_clusters(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.ListClustersRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListClustersPager

Lists the clusters in a given project and location.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_clusters

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_consumer_groups

list_consumer_groups(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListConsumerGroupsPager

Lists the consumer groups in a given cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_consumer_groups

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_locations

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_operations

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_topics

list_topics(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListTopicsPager

Lists the topics in a given cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.list_topics

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_cluster_path

parse_cluster_path(path: str) -> typing.Dict[str, str]

Parses a cluster path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_cluster_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_billing_account_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_folder_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_location_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_organization_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_common_project_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_consumer_group_path

parse_consumer_group_path(path: str) -> typing.Dict[str, str]

Parses a consumer_group path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_consumer_group_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_crypto_key_path

parse_crypto_key_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_crypto_key_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_topic_path

parse_topic_path(path: str) -> typing.Dict[str, str]

Parses a topic path into its component segments.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.parse_topic_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.topic_path

topic_path(project: str, location: str, cluster: str, topic: str) -> str

Returns a fully-qualified topic string.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.topic_path

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.update_cluster

update_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.UpdateClusterRequest, dict
        ]
    ] = None,
    *,
    cluster: typing.Optional[
        google.cloud.managedkafka_v1.types.resources.Cluster
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates the properties of a single cluster.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.update_cluster

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.update_consumer_group

update_consumer_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.UpdateConsumerGroupRequest,
            dict,
        ]
    ] = None,
    *,
    consumer_group: typing.Optional[
        google.cloud.managedkafka_v1.types.resources.ConsumerGroup
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.ConsumerGroup

Updates the properties of a single consumer group.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.update_consumer_group

google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.update_topic

update_topic(
    request: typing.Optional[
        typing.Union[
            google.cloud.managedkafka_v1.types.managed_kafka.UpdateTopicRequest, dict
        ]
    ] = None,
    *,
    topic: typing.Optional[google.cloud.managedkafka_v1.types.resources.Topic] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.managedkafka_v1.types.resources.Topic

Updates the properties of a single topic.

See more: google.cloud.managedkafka_v1.services.managed_kafka.ManagedKafkaClient.update_topic

google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListClustersAsyncPager

ListClustersAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.managedkafka_v1.types.managed_kafka.ListClustersResponse
        ],
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListClustersRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListClustersResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListClustersAsyncPager

google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListClustersPager

ListClustersPager(
    method: typing.Callable[
        [...], google.cloud.managedkafka_v1.types.managed_kafka.ListClustersResponse
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListClustersRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListClustersResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListClustersPager

google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListConsumerGroupsAsyncPager

ListConsumerGroupsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsResponse
        ],
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListConsumerGroupsAsyncPager

google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListConsumerGroupsPager

ListConsumerGroupsPager(
    method: typing.Callable[
        [...],
        google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsResponse,
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListConsumerGroupsPager

google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListTopicsAsyncPager

ListTopicsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsResponse
        ],
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListTopicsAsyncPager

google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListTopicsPager

ListTopicsPager(
    method: typing.Callable[
        [...], google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsResponse
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.managedkafka_v1.services.managed_kafka.pagers.ListTopicsPager