# Package Methods (2.39.0)

2.39.0 (latest) 2.38.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.1 2.28.0 2.27.3 2.26.1 2.25.2 2.23.1 2.22.0 2.21.5 2.20.3 2.19.8 2.18.4 2.17.1 2.16.1 2.15.2 2.14.1 2.13.12 2.12.1 2.11.1 2.10.0 2.9.0 2.8.0 2.7.1 2.6.1 2.5.0 2.4.2 2.3.0 2.2.0 2.1.0 2.0.0 1.7.2 1.6.1 1.5.0 1.4.3 1.3.1 1.2.0 1.1.0 1.0.2 0.45.0 0.44.0 0.43.0 Summary of entries of Methods for pubsub.

### google.cloud.pubsub_v1.publisher.client.Client

    Client(
        batch_settings: typing.Union[
            google.cloud.pubsub_v1.types.BatchSettings, typing.Sequence
        ] = (),
        publisher_options: typing.Union[
            google.cloud.pubsub_v1.types.PublisherOptions, typing.Sequence
        ] = (),
        **kwargs: typing.Any
    )

Instantiates the publisher client.

See more: [google.cloud.pubsub_v1.publisher.client.Client](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_Client)

### google.cloud.pubsub_v1.publisher.client.Client.__exit__

    __exit__(type, value, traceback)

Releases underlying transport's resources.

See more: [google.cloud.pubsub_v1.publisher.client.Client.**exit**](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client___exit__)

### google.cloud.pubsub_v1.publisher.client.Client.common_billing_account_path

    common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.common_billing_account_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_common_billing_account_path)

### google.cloud.pubsub_v1.publisher.client.Client.common_folder_path

    common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.common_folder_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_common_folder_path)

### google.cloud.pubsub_v1.publisher.client.Client.common_location_path

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

Returns a fully-qualified location string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.common_location_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_common_location_path)

### google.cloud.pubsub_v1.publisher.client.Client.common_organization_path

    common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.common_organization_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_common_organization_path)

### google.cloud.pubsub_v1.publisher.client.Client.common_project_path

    common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.common_project_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_common_project_path)

### google.cloud.pubsub_v1.publisher.client.Client.create_topic

    create_topic(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.Topic, 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Topic

Creates the given topic with the given name.

See more: [google.cloud.pubsub_v1.publisher.client.Client.create_topic](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_create_topic)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.crypto_key_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_crypto_key_path)

### google.cloud.pubsub_v1.publisher.client.Client.delete_topic

    delete_topic(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.DeleteTopicRequest, dict]
        ] = None,
        *,
        topic: 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> None

Deletes the topic with the given name.

See more: [google.cloud.pubsub_v1.publisher.client.Client.delete_topic](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_delete_topic)

### google.cloud.pubsub_v1.publisher.client.Client.detach_subscription

    detach_subscription(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.DetachSubscriptionRequest, dict]
        ] = 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.DetachSubscriptionResponse

Detaches a subscription from this topic.

See more: [google.cloud.pubsub_v1.publisher.client.Client.detach_subscription](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_detach_subscription)

### google.cloud.pubsub_v1.publisher.client.Client.ensure_cleanup_and_commit_timer_runs

    ensure_cleanup_and_commit_timer_runs() -> None

Ensure a cleanup/commit timer thread is running.

See more: [google.cloud.pubsub_v1.publisher.client.Client.ensure_cleanup_and_commit_timer_runs](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_ensure_cleanup_and_commit_timer_runs)

### google.cloud.pubsub_v1.publisher.client.Client.from_service_account_file

    from_service_account_file(
        filename: str,
        batch_settings: typing.Union[
            google.cloud.pubsub_v1.types.BatchSettings, typing.Sequence
        ] = (),
        **kwargs: typing.Any
    ) -> google.cloud.pubsub_v1.publisher.client.Client

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

See more: [google.cloud.pubsub_v1.publisher.client.Client.from_service_account_file](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_from_service_account_file)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.from_service_account_info](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_from_service_account_info)

### google.cloud.pubsub_v1.publisher.client.Client.from_service_account_json

    from_service_account_json(
        filename: str,
        batch_settings: typing.Union[
            google.cloud.pubsub_v1.types.BatchSettings, typing.Sequence
        ] = (),
        **kwargs: typing.Any
    ) -> google.cloud.pubsub_v1.publisher.client.Client

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

See more: [google.cloud.pubsub_v1.publisher.client.Client.from_service_account_json](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_from_service_account_json)

### google.cloud.pubsub_v1.publisher.client.Client.get_iam_policy

    get_iam_policy(
        request: typing.Optional[
            typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
        ] = 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.iam.v1.policy_pb2.Policy

Gets the IAM access control policy for a function.

See more: [google.cloud.pubsub_v1.publisher.client.Client.get_iam_policy](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_get_iam_policy)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.get_mtls_endpoint_and_cert_source](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_get_mtls_endpoint_and_cert_source)

### google.cloud.pubsub_v1.publisher.client.Client.get_topic

    get_topic(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.GetTopicRequest, dict]
        ] = None,
        *,
        topic: 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Topic

Gets the configuration of a topic.

See more: [google.cloud.pubsub_v1.publisher.client.Client.get_topic](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_get_topic)

### google.cloud.pubsub_v1.publisher.client.Client.list_topic_snapshots

    list_topic_snapshots(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.ListTopicSnapshotsRequest, dict]
        ] = None,
        *,
        topic: 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsPager

Lists the names of the snapshots on this topic.

See more: [google.cloud.pubsub_v1.publisher.client.Client.list_topic_snapshots](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_list_topic_snapshots)

### google.cloud.pubsub_v1.publisher.client.Client.list_topic_subscriptions

    list_topic_subscriptions(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.ListTopicSubscriptionsRequest, dict]
        ] = None,
        *,
        topic: 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.pubsub_v1.services.publisher.pagers.ListTopicSubscriptionsPager

Lists the names of the attached subscriptions on this
topic.

See more: [google.cloud.pubsub_v1.publisher.client.Client.list_topic_subscriptions](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_list_topic_subscriptions)

### google.cloud.pubsub_v1.publisher.client.Client.list_topics

    list_topics(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.ListTopicsRequest, dict]
        ] = None,
        *,
        project: 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.pubsub_v1.services.publisher.pagers.ListTopicsPager

Lists matching topics.

See more: [google.cloud.pubsub_v1.publisher.client.Client.list_topics](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_list_topics)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.parse_common_billing_account_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_common_billing_account_path)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.parse_common_folder_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_common_folder_path)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.parse_common_location_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_common_location_path)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.parse_common_organization_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_common_organization_path)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.parse_common_project_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_common_project_path)

### google.cloud.pubsub_v1.publisher.client.Client.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.pubsub_v1.publisher.client.Client.parse_crypto_key_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_crypto_key_path)

### google.cloud.pubsub_v1.publisher.client.Client.parse_schema_path

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

Parses a schema path into its component segments.

See more: [google.cloud.pubsub_v1.publisher.client.Client.parse_schema_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_schema_path)

### google.cloud.pubsub_v1.publisher.client.Client.parse_snapshot_path

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

Parses a snapshot path into its component segments.

See more: [google.cloud.pubsub_v1.publisher.client.Client.parse_snapshot_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_snapshot_path)

### google.cloud.pubsub_v1.publisher.client.Client.parse_subscription_path

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

Parses a subscription path into its component segments.

See more: [google.cloud.pubsub_v1.publisher.client.Client.parse_subscription_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_subscription_path)

### google.cloud.pubsub_v1.publisher.client.Client.parse_topic_path

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

Parses a topic path into its component segments.

See more: [google.cloud.pubsub_v1.publisher.client.Client.parse_topic_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_parse_topic_path)

### google.cloud.pubsub_v1.publisher.client.Client.publish

    publish(
        topic: str,
        data: bytes,
        ordering_key: str = "",
        retry: OptionalRetry = _MethodDefault._DEFAULT_VALUE,
        timeout: types.OptionalTimeout = _MethodDefault._DEFAULT_VALUE,
        **attrs: typing.Union[bytes, str]
    ) -> pubsub_v1.publisher.futures.Future

Publish a single message.

See more: [google.cloud.pubsub_v1.publisher.client.Client.publish](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_publish)

### google.cloud.pubsub_v1.publisher.client.Client.resume_publish

    resume_publish(topic: str, ordering_key: str) -> None

Resume publish on an ordering key that has had unrecoverable errors.

See more: [google.cloud.pubsub_v1.publisher.client.Client.resume_publish](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_resume_publish)

### google.cloud.pubsub_v1.publisher.client.Client.schema_path

    schema_path(project: str, schema: str) -> str

Returns a fully-qualified schema string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.schema_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_schema_path)

### google.cloud.pubsub_v1.publisher.client.Client.set_iam_policy

    set_iam_policy(
        request: typing.Optional[
            typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
        ] = 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.iam.v1.policy_pb2.Policy

Sets the IAM access control policy on the specified function.

See more: [google.cloud.pubsub_v1.publisher.client.Client.set_iam_policy](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_set_iam_policy)

### google.cloud.pubsub_v1.publisher.client.Client.snapshot_path

    snapshot_path(project: str, snapshot: str) -> str

Returns a fully-qualified snapshot string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.snapshot_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_snapshot_path)

### google.cloud.pubsub_v1.publisher.client.Client.stop

    stop() -> None

Immediately publish all outstanding messages.

See more: [google.cloud.pubsub_v1.publisher.client.Client.stop](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_stop)

### google.cloud.pubsub_v1.publisher.client.Client.subscription_path

    subscription_path(project: str, subscription: str) -> str

Returns a fully-qualified subscription string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.subscription_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_subscription_path)

### google.cloud.pubsub_v1.publisher.client.Client.test_iam_permissions

    test_iam_permissions(
        request: typing.Optional[
            typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
        ] = 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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Tests the specified IAM permissions against the IAM access control
policy for a function.

See more: [google.cloud.pubsub_v1.publisher.client.Client.test_iam_permissions](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_test_iam_permissions)

### google.cloud.pubsub_v1.publisher.client.Client.topic_path

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

Returns a fully-qualified topic string.

See more: [google.cloud.pubsub_v1.publisher.client.Client.topic_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_topic_path)

### google.cloud.pubsub_v1.publisher.client.Client.update_topic

    update_topic(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.UpdateTopicRequest, dict]
        ] = None,
        *,
        topic: typing.Optional[google.cloud.pubsub_v1.types.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[
            int,
            float,
            google.api_core.timeout.ConstantTimeout,
            google.api_core.timeout.ExponentialTimeout,
        ] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Topic

Updates an existing topic by updating the fields
specified in the update mask.

See more: [google.cloud.pubsub_v1.publisher.client.Client.update_topic](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client#google_cloud_pubsub_v1_publisher_client_Client_update_topic)

### google.cloud.pubsub_v1.publisher.futures.Future

    Future()

Initializes the future.

See more: [google.cloud.pubsub_v1.publisher.futures.Future](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_Future)

### google.cloud.pubsub_v1.publisher.futures.Future.add_done_callback

    add_done_callback(
        callback: typing.Callable[[pubsub_v1.publisher.futures.Future], typing.Any],
    ) -> None

Attach a callable that will be called when the future finishes.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.add_done_callback](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_add_done_callback)

### google.cloud.pubsub_v1.publisher.futures.Future.cancel

    cancel() -> bool

Actions in Pub/Sub generally may not be canceled.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.cancel](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_cancel)

### google.cloud.pubsub_v1.publisher.futures.Future.cancelled

    cancelled() -> bool

Actions in Pub/Sub generally may not be canceled.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.cancelled](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_cancelled)

### google.cloud.pubsub_v1.publisher.futures.Future.done

    done()

Return True if the future was cancelled or finished executing.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.done](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_done)

### google.cloud.pubsub_v1.publisher.futures.Future.exception

    exception(timeout=None)

Return the exception raised by the call that the future represents.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.exception](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_exception)

### google.cloud.pubsub_v1.publisher.futures.Future.result

    result(timeout: typing.Optional[typing.Union[int, float]] = None) -> str

Return the message ID or raise an exception.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.result](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_result)

### google.cloud.pubsub_v1.publisher.futures.Future.running

    running() -> bool

Return `True` if the associated Pub/Sub action has not yet completed.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.running](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_running)

### google.cloud.pubsub_v1.publisher.futures.Future.set_exception

    set_exception(exception: typing.Optional[BaseException])

Set the result of the future as being the given exception.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.set_exception](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_set_exception)

### google.cloud.pubsub_v1.publisher.futures.Future.set_result

    set_result(result: typing.Any)

Set the return value of work associated with the future.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.set_result](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_set_result)

### google.cloud.pubsub_v1.publisher.futures.Future.set_running_or_notify_cancel

    set_running_or_notify_cancel() -> typing.NoReturn

Mark the future as running or process any cancel notifications.

See more: [google.cloud.pubsub_v1.publisher.futures.Future.set_running_or_notify_cancel](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.futures.Future#google_cloud_pubsub_v1_publisher_futures_Future_set_running_or_notify_cancel)

### google.cloud.pubsub_v1.subscriber.client.Client

    Client(
        subscriber_options: typing.Union[
            google.cloud.pubsub_v1.types.SubscriberOptions, typing.Sequence
        ] = (),
        **kwargs: typing.Any
    )

Instantiates the subscriber client.

See more: [google.cloud.pubsub_v1.subscriber.client.Client](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_Client)

### google.cloud.pubsub_v1.subscriber.client.Client.acknowledge

    acknowledge(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.AcknowledgeRequest, dict]
        ] = None,
        *,
        subscription: typing.Optional[str] = None,
        ack_ids: typing.Optional[typing.MutableSequence[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, typing.Union[str, bytes]]] = ()
    ) -> None

Acknowledges the messages associated with the `ack_ids` in the
`AcknowledgeRequest`.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.acknowledge](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_acknowledge)

### google.cloud.pubsub_v1.subscriber.client.Client.close

    close() -> None

Close the underlying channel to release socket resources.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.close](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_close)

### google.cloud.pubsub_v1.subscriber.client.Client.common_billing_account_path

    common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.common_billing_account_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_common_billing_account_path)

### google.cloud.pubsub_v1.subscriber.client.Client.common_folder_path

    common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.common_folder_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_common_folder_path)

### google.cloud.pubsub_v1.subscriber.client.Client.common_location_path

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

Returns a fully-qualified location string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.common_location_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_common_location_path)

### google.cloud.pubsub_v1.subscriber.client.Client.common_organization_path

    common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.common_organization_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_common_organization_path)

### google.cloud.pubsub_v1.subscriber.client.Client.common_project_path

    common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.common_project_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_common_project_path)

### google.cloud.pubsub_v1.subscriber.client.Client.create_snapshot

    create_snapshot(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.CreateSnapshotRequest, dict]
        ] = None,
        *,
        name: typing.Optional[str] = None,
        subscription: 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, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Snapshot

Creates a snapshot from the requested subscription.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.create_snapshot](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_create_snapshot)

### google.cloud.pubsub_v1.subscriber.client.Client.create_subscription

    create_subscription(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.Subscription, dict]
        ] = None,
        *,
        name: typing.Optional[str] = None,
        topic: typing.Optional[str] = None,
        push_config: typing.Optional[google.cloud.pubsub_v1.types.PushConfig] = None,
        ack_deadline_seconds: typing.Optional[int] = 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, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Subscription

Creates a subscription to a given topic.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.create_subscription](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_create_subscription)

### google.cloud.pubsub_v1.subscriber.client.Client.delete_snapshot

    delete_snapshot(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.DeleteSnapshotRequest, dict]
        ] = None,
        *,
        snapshot: 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, typing.Union[str, bytes]]] = ()
    ) -> None

Removes an existing snapshot.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.delete_snapshot](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_delete_snapshot)

### google.cloud.pubsub_v1.subscriber.client.Client.delete_subscription

    delete_subscription(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.DeleteSubscriptionRequest, dict]
        ] = None,
        *,
        subscription: 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, typing.Union[str, bytes]]] = ()
    ) -> None

Deletes an existing subscription.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.delete_subscription](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_delete_subscription)

### google.cloud.pubsub_v1.subscriber.client.Client.from_service_account_file

    from_service_account_file(
        filename: str, **kwargs: typing.Any
    ) -> google.cloud.pubsub_v1.subscriber.client.Client

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

See more: [google.cloud.pubsub_v1.subscriber.client.Client.from_service_account_file](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_from_service_account_file)

### google.cloud.pubsub_v1.subscriber.client.Client.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.pubsub_v1.subscriber.client.Client.from_service_account_info](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_from_service_account_info)

### google.cloud.pubsub_v1.subscriber.client.Client.from_service_account_json

    from_service_account_json(
        filename: str, **kwargs: typing.Any
    ) -> google.cloud.pubsub_v1.subscriber.client.Client

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

See more: [google.cloud.pubsub_v1.subscriber.client.Client.from_service_account_json](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_from_service_account_json)

### google.cloud.pubsub_v1.subscriber.client.Client.get_iam_policy

    get_iam_policy(
        request: typing.Optional[
            typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
        ] = 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, typing.Union[str, bytes]]] = ()
    ) -> google.iam.v1.policy_pb2.Policy

Gets the IAM access control policy for a function.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.get_iam_policy](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_get_iam_policy)

### google.cloud.pubsub_v1.subscriber.client.Client.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.pubsub_v1.subscriber.client.Client.get_mtls_endpoint_and_cert_source](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_get_mtls_endpoint_and_cert_source)

### google.cloud.pubsub_v1.subscriber.client.Client.get_snapshot

    get_snapshot(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.GetSnapshotRequest, dict]
        ] = None,
        *,
        snapshot: 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, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Snapshot

Gets the configuration details of a snapshot.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.get_snapshot](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_get_snapshot)

### google.cloud.pubsub_v1.subscriber.client.Client.get_subscription

    get_subscription(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.GetSubscriptionRequest, dict]
        ] = None,
        *,
        subscription: 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, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Subscription

Gets the configuration details of a subscription.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.get_subscription](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_get_subscription)

### google.cloud.pubsub_v1.subscriber.client.Client.list_snapshots

    list_snapshots(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.ListSnapshotsRequest, dict]
        ] = None,
        *,
        project: 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, typing.Union[str, bytes]]] = ()
    ) -> google.pubsub_v1.services.subscriber.pagers.ListSnapshotsPager

Lists the existing snapshots.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.list_snapshots](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_list_snapshots)

### google.cloud.pubsub_v1.subscriber.client.Client.list_subscriptions

    list_subscriptions(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.ListSubscriptionsRequest, dict]
        ] = None,
        *,
        project: 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, typing.Union[str, bytes]]] = ()
    ) -> google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsPager

Lists matching subscriptions.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.list_subscriptions](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_list_subscriptions)

### google.cloud.pubsub_v1.subscriber.client.Client.listing_path

    listing_path(project: str, location: str, data_exchange: str, listing: str) -> str

Returns a fully-qualified listing string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.listing_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_listing_path)

### google.cloud.pubsub_v1.subscriber.client.Client.modify_ack_deadline

    modify_ack_deadline(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.ModifyAckDeadlineRequest, dict]
        ] = None,
        *,
        subscription: typing.Optional[str] = None,
        ack_ids: typing.Optional[typing.MutableSequence[str]] = None,
        ack_deadline_seconds: typing.Optional[int] = 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, typing.Union[str, bytes]]] = ()
    ) -> None

Modifies the ack deadline for a specific message.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.modify_ack_deadline](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_modify_ack_deadline)

### google.cloud.pubsub_v1.subscriber.client.Client.modify_push_config

    modify_push_config(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.ModifyPushConfigRequest, dict]
        ] = None,
        *,
        subscription: typing.Optional[str] = None,
        push_config: typing.Optional[google.cloud.pubsub_v1.types.PushConfig] = 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, typing.Union[str, bytes]]] = ()
    ) -> None

Modifies the `PushConfig` for a specified subscription.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.modify_push_config](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_modify_push_config)

### google.cloud.pubsub_v1.subscriber.client.Client.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.pubsub_v1.subscriber.client.Client.parse_common_billing_account_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_common_billing_account_path)

### google.cloud.pubsub_v1.subscriber.client.Client.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.pubsub_v1.subscriber.client.Client.parse_common_folder_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_common_folder_path)

### google.cloud.pubsub_v1.subscriber.client.Client.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.pubsub_v1.subscriber.client.Client.parse_common_location_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_common_location_path)

### google.cloud.pubsub_v1.subscriber.client.Client.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.pubsub_v1.subscriber.client.Client.parse_common_organization_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_common_organization_path)

### google.cloud.pubsub_v1.subscriber.client.Client.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.pubsub_v1.subscriber.client.Client.parse_common_project_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_common_project_path)

### google.cloud.pubsub_v1.subscriber.client.Client.parse_listing_path

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

Parses a listing path into its component segments.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.parse_listing_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_listing_path)

### google.cloud.pubsub_v1.subscriber.client.Client.parse_snapshot_path

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

Parses a snapshot path into its component segments.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.parse_snapshot_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_snapshot_path)

### google.cloud.pubsub_v1.subscriber.client.Client.parse_subscription_path

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

Parses a subscription path into its component segments.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.parse_subscription_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_subscription_path)

### google.cloud.pubsub_v1.subscriber.client.Client.parse_topic_path

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

Parses a topic path into its component segments.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.parse_topic_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_parse_topic_path)

### google.cloud.pubsub_v1.subscriber.client.Client.pull

    pull(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.PullRequest, dict]
        ] = None,
        *,
        subscription: typing.Optional[str] = None,
        return_immediately: typing.Optional[bool] = None,
        max_messages: typing.Optional[int] = 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, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.PullResponse

Pulls messages from the server.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.pull](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_pull)

### google.cloud.pubsub_v1.subscriber.client.Client.seek

    seek(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.SeekRequest, dict]
        ] = 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, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.SeekResponse

Seeks an existing subscription to a point in time or to a given
snapshot, whichever is provided in the request.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.seek](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_seek)

### google.cloud.pubsub_v1.subscriber.client.Client.set_iam_policy

    set_iam_policy(
        request: typing.Optional[
            typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
        ] = 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, typing.Union[str, bytes]]] = ()
    ) -> google.iam.v1.policy_pb2.Policy

Sets the IAM access control policy on the specified function.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.set_iam_policy](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_set_iam_policy)

### google.cloud.pubsub_v1.subscriber.client.Client.snapshot_path

    snapshot_path(project: str, snapshot: str) -> str

Returns a fully-qualified snapshot string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.snapshot_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_snapshot_path)

### google.cloud.pubsub_v1.subscriber.client.Client.streaming_pull

    streaming_pull(
        requests: typing.Optional[
            typing.Iterator[google.cloud.pubsub_v1.types.StreamingPullRequest]
        ] = 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, typing.Union[str, bytes]]] = ()
    ) -> typing.Iterable[google.cloud.pubsub_v1.types.StreamingPullResponse]

Establishes a stream with the server, which sends messages down
to the client.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.streaming_pull](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_streaming_pull)

### google.cloud.pubsub_v1.subscriber.client.Client.subscribe

    subscribe(
        subscription: str,
        callback: typing.Callable[[subscriber.message.Message], typing.Any],
        flow_control: typing.Union[
            google.cloud.pubsub_v1.types.FlowControl, typing.Sequence
        ] = (),
        scheduler: typing.Optional[subscriber.scheduler.ThreadScheduler] = None,
        use_legacy_flow_control: bool = False,
        await_callbacks_on_shutdown: bool = False,
    ) -> google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture

Asynchronously start receiving messages on a given subscription.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.subscribe](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_subscribe)

### google.cloud.pubsub_v1.subscriber.client.Client.subscription_path

    subscription_path(project: str, subscription: str) -> str

Returns a fully-qualified subscription string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.subscription_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_subscription_path)

### google.cloud.pubsub_v1.subscriber.client.Client.test_iam_permissions

    test_iam_permissions(
        request: typing.Optional[
            typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
        ] = 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, typing.Union[str, bytes]]] = ()
    ) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Tests the specified IAM permissions against the IAM access control
policy for a function.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.test_iam_permissions](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_test_iam_permissions)

### google.cloud.pubsub_v1.subscriber.client.Client.topic_path

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

Returns a fully-qualified topic string.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.topic_path](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_topic_path)

### google.cloud.pubsub_v1.subscriber.client.Client.update_snapshot

    update_snapshot(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.UpdateSnapshotRequest, dict]
        ] = None,
        *,
        snapshot: typing.Optional[google.cloud.pubsub_v1.types.Snapshot] = 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, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Snapshot

Updates an existing snapshot by updating the fields specified in
the update mask.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.update_snapshot](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_update_snapshot)

### google.cloud.pubsub_v1.subscriber.client.Client.update_subscription

    update_subscription(
        request: typing.Optional[
            typing.Union[google.cloud.pubsub_v1.types.UpdateSubscriptionRequest, dict]
        ] = None,
        *,
        subscription: typing.Optional[google.cloud.pubsub_v1.types.Subscription] = 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, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.pubsub_v1.types.Subscription

Updates an existing subscription by updating the
fields specified in the update mask.

See more: [google.cloud.pubsub_v1.subscriber.client.Client.update_subscription](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client#google_cloud_pubsub_v1_subscriber_client_Client_update_subscription)

### google.cloud.pubsub_v1.subscriber.futures.Future

    Future()

Initializes the future.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_Future)

### google.cloud.pubsub_v1.subscriber.futures.Future.add_done_callback

    add_done_callback(fn)

Attaches a callable that will be called when the future finishes.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.add_done_callback](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_add_done_callback)

### google.cloud.pubsub_v1.subscriber.futures.Future.cancel

    cancel() -> bool

Actions in Pub/Sub generally may not be canceled.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.cancel](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_cancel)

### google.cloud.pubsub_v1.subscriber.futures.Future.cancelled

    cancelled() -> bool

Actions in Pub/Sub generally may not be canceled.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.cancelled](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_cancelled)

### google.cloud.pubsub_v1.subscriber.futures.Future.done

    done()

Return True if the future was cancelled or finished executing.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.done](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_done)

### google.cloud.pubsub_v1.subscriber.futures.Future.exception

    exception(timeout=None)

Return the exception raised by the call that the future represents.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.exception](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_exception)

### google.cloud.pubsub_v1.subscriber.futures.Future.result

    result(
        timeout: typing.Optional[typing.Union[int, float]] = None,
    ) -> google.cloud.pubsub_v1.subscriber.exceptions.AcknowledgeStatus

Return a success code or raise an exception.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.result](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_result)

### google.cloud.pubsub_v1.subscriber.futures.Future.running

    running() -> bool

Return `True` if the associated Pub/Sub action has not yet completed.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.running](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_running)

### google.cloud.pubsub_v1.subscriber.futures.Future.set_exception

    set_exception(exception: typing.Optional[BaseException])

Set the result of the future as being the given exception.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.set_exception](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_set_exception)

### google.cloud.pubsub_v1.subscriber.futures.Future.set_result

    set_result(result: typing.Any)

Set the return value of work associated with the future.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.set_result](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_set_result)

### google.cloud.pubsub_v1.subscriber.futures.Future.set_running_or_notify_cancel

    set_running_or_notify_cancel() -> typing.NoReturn

Mark the future as running or process any cancel notifications.

See more: [google.cloud.pubsub_v1.subscriber.futures.Future.set_running_or_notify_cancel](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.Future#google_cloud_pubsub_v1_subscriber_futures_Future_set_running_or_notify_cancel)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture

    StreamingPullFuture(manager: StreamingPullManager)

Initializes the future.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_StreamingPullFuture)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.add_done_callback

    add_done_callback(fn)

Attaches a callable that will be called when the future finishes.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.add_done_callback](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_add_done_callback)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.cancel

    cancel() -> bool

Stops pulling messages and shutdowns the background thread consuming
messages.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.cancel](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_cancel)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.cancelled

    cancelled() -> bool

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.cancelled](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_cancelled)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.done

    done()

Return True if the future was cancelled or finished executing.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.done](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_done)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.exception

    exception(timeout=None)

Return the exception raised by the call that the future represents.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.exception](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_exception)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.result

    result(timeout=None)

Return the result of the call that the future represents.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.result](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_result)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.running

    running() -> bool

Return `True` if the associated Pub/Sub action has not yet completed.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.running](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_running)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.set_exception

    set_exception(exception: typing.Optional[BaseException])

Set the result of the future as being the given exception.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.set_exception](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_set_exception)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.set_result

    set_result(result: typing.Any)

Set the return value of work associated with the future.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.set_result](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_set_result)

### google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.set_running_or_notify_cancel

    set_running_or_notify_cancel() -> typing.NoReturn

Mark the future as running or process any cancel notifications.

See more: [google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture.set_running_or_notify_cancel](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.futures.StreamingPullFuture#google_cloud_pubsub_v1_subscriber_futures_StreamingPullFuture_set_running_or_notify_cancel)

### google.cloud.pubsub_v1.subscriber.message.Message

    Message(message: types.PubsubMessage._meta._pb, ack_id: str, delivery_attempt: int, request_queue: queue.Queue, exactly_once_delivery_enabled_func: typing.Callable[[], bool] = 

Construct the Message.

See more: [google.cloud.pubsub_v1.subscriber.message.Message](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.message.Message#google_cloud_pubsub_v1_subscriber_message_Message_Message)

### google.cloud.pubsub_v1.subscriber.message.Message.ack

    ack() -> None

Acknowledge the given message.

See more: [google.cloud.pubsub_v1.subscriber.message.Message.ack](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.message.Message#google_cloud_pubsub_v1_subscriber_message_Message_ack)

### google.cloud.pubsub_v1.subscriber.message.Message.ack_with_response

    ack_with_response() -> google.cloud.pubsub_v1.subscriber.futures.Future

Acknowledge the given message.

See more: [google.cloud.pubsub_v1.subscriber.message.Message.ack_with_response](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.message.Message#google_cloud_pubsub_v1_subscriber_message_Message_ack_with_response)

### google.cloud.pubsub_v1.subscriber.message.Message.drop

    drop() -> None

Release the message from lease management.

See more: [google.cloud.pubsub_v1.subscriber.message.Message.drop](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.message.Message#google_cloud_pubsub_v1_subscriber_message_Message_drop)

### google.cloud.pubsub_v1.subscriber.message.Message.modify_ack_deadline

    modify_ack_deadline(seconds: int) -> None

Resets the deadline for acknowledgement.

See more: [google.cloud.pubsub_v1.subscriber.message.Message.modify_ack_deadline](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.message.Message#google_cloud_pubsub_v1_subscriber_message_Message_modify_ack_deadline)

### google.cloud.pubsub_v1.subscriber.message.Message.modify_ack_deadline_with_response

    modify_ack_deadline_with_response(
        seconds: int,
    ) -> google.cloud.pubsub_v1.subscriber.futures.Future

Resets the deadline for acknowledgement and returns the response
status via a future.

See more: [google.cloud.pubsub_v1.subscriber.message.Message.modify_ack_deadline_with_response](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.message.Message#google_cloud_pubsub_v1_subscriber_message_Message_modify_ack_deadline_with_response)

### google.cloud.pubsub_v1.subscriber.message.Message.nack

    nack() -> None

Decline to acknowledge the given message.

See more: [google.cloud.pubsub_v1.subscriber.message.Message.nack](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.message.Message#google_cloud_pubsub_v1_subscriber_message_Message_nack)

### google.cloud.pubsub_v1.subscriber.message.Message.nack_with_response

    nack_with_response() -> google.cloud.pubsub_v1.subscriber.futures.Future

Decline to acknowledge the given message, returning the response status via
a future.

See more: [google.cloud.pubsub_v1.subscriber.message.Message.nack_with_response](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.message.Message#google_cloud_pubsub_v1_subscriber_message_Message_nack_with_response)

### google.cloud.pubsub_v1.subscriber.scheduler.Scheduler.schedule

    schedule(callback: typing.Callable, *args, **kwargs) -> None

Schedule the callback to be called asynchronously.

See more: [google.cloud.pubsub_v1.subscriber.scheduler.Scheduler.schedule](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.scheduler.Scheduler#google_cloud_pubsub_v1_subscriber_scheduler_Scheduler_schedule)

### google.cloud.pubsub_v1.subscriber.scheduler.Scheduler.shutdown

    shutdown(
        await_msg_callbacks: bool = False,
    ) -> typing.List[pubsub_v1.subscriber.message.Message]

Shuts down the scheduler and immediately end all pending callbacks.

See more: [google.cloud.pubsub_v1.subscriber.scheduler.Scheduler.shutdown](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.scheduler.Scheduler#google_cloud_pubsub_v1_subscriber_scheduler_Scheduler_shutdown)

### google.cloud.pubsub_v1.subscriber.scheduler.ThreadScheduler.schedule

    schedule(callback: typing.Callable, *args, **kwargs) -> None

Schedule the callback to be called asynchronously in a thread pool.

See more: [google.cloud.pubsub_v1.subscriber.scheduler.ThreadScheduler.schedule](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.scheduler.ThreadScheduler#google_cloud_pubsub_v1_subscriber_scheduler_ThreadScheduler_schedule)

### google.cloud.pubsub_v1.subscriber.scheduler.ThreadScheduler.shutdown

    shutdown(
        await_msg_callbacks: bool = False,
    ) -> typing.List[pubsub_v1.subscriber.message.Message]

Shut down the scheduler and immediately end all pending callbacks.

See more: [google.cloud.pubsub_v1.subscriber.scheduler.ThreadScheduler.shutdown](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.scheduler.ThreadScheduler#google_cloud_pubsub_v1_subscriber_scheduler_ThreadScheduler_shutdown)

### google.cloud.pubsub_v1.types.BatchSettings

    BatchSettings(
        max_bytes: int = 1000000, max_latency: float = 0.01, max_messages: int = 100
    )

Create new instance of BatchSettings(max_bytes, max_latency, max_messages).

See more: [google.cloud.pubsub_v1.types.BatchSettings](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.BatchSettings#google_cloud_pubsub_v1_types_BatchSettings_BatchSettings)

### google.cloud.pubsub_v1.types.FlowControl

    FlowControl(
        max_bytes: int = 104857600,
        max_messages: int = 1000,
        max_lease_duration: float = 3600,
        min_duration_per_lease_extension: float = 0,
        max_duration_per_lease_extension: float = 0,
    )

Create new instance of FlowControl(max_bytes, max_messages, max_lease_duration, min_duration_per_lease_extension, max_duration_per_lease_extension).

See more: [google.cloud.pubsub_v1.types.FlowControl](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.FlowControl#google_cloud_pubsub_v1_types_FlowControl_FlowControl)

### google.cloud.pubsub_v1.types.PublishFlowControl

    PublishFlowControl(
        message_limit: int = 1000,
        byte_limit: int = 10000000,
        limit_exceeded_behavior: google.cloud.pubsub_v1.types.LimitExceededBehavior = LimitExceededBehavior.IGNORE,
    )

Create new instance of PublishFlowControl(message_limit, byte_limit, limit_exceeded_behavior).

See more: [google.cloud.pubsub_v1.types.PublishFlowControl](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.PublishFlowControl#google_cloud_pubsub_v1_types_PublishFlowControl_PublishFlowControl)

### google.cloud.pubsub_v1.types.PublisherOptions

    PublisherOptions(enable_message_ordering: bool = False, flow_control: google.cloud.pubsub_v1.types.PublishFlowControl = PublishFlowControl(message_limit=1000, byte_limit=10000000, limit_exceeded_behavior=

Create new instance of PublisherOptions(enable_message_ordering, flow_control, retry, timeout, enable_open_telemetry_tracing).

See more: [google.cloud.pubsub_v1.types.PublisherOptions](https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.PublisherOptions#google_cloud_pubsub_v1_types_PublisherOptions_PublisherOptions)

### google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsAsyncPager

    ListTopicSnapshotsAsyncPager(
        method: typing.Callable[
            [...], typing.Awaitable[google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse]
        ],
        request: google.cloud.pubsub_v1.types.ListTopicSnapshotsRequest,
        response: google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiates the pager.

See more: [google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsAsyncPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsAsyncPager#google_pubsub_v1_services_publisher_pagers_ListTopicSnapshotsAsyncPager_ListTopicSnapshotsAsyncPager)

### google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsPager

    ListTopicSnapshotsPager(
        method: typing.Callable[
            [...], google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse
        ],
        request: google.cloud.pubsub_v1.types.ListTopicSnapshotsRequest,
        response: google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiate the pager.

See more: [google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsPager#google_pubsub_v1_services_publisher_pagers_ListTopicSnapshotsPager_ListTopicSnapshotsPager)

### google.pubsub_v1.services.publisher.pagers.ListTopicSubscriptionsAsyncPager

    ListTopicSubscriptionsAsyncPager(
        method: typing.Callable[
            [...],
            typing.Awaitable[google.cloud.pubsub_v1.types.ListTopicSubscriptionsResponse],
        ],
        request: google.cloud.pubsub_v1.types.ListTopicSubscriptionsRequest,
        response: google.cloud.pubsub_v1.types.ListTopicSubscriptionsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiates the pager.

See more: [google.pubsub_v1.services.publisher.pagers.ListTopicSubscriptionsAsyncPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.publisher.pagers.ListTopicSubscriptionsAsyncPager#google_pubsub_v1_services_publisher_pagers_ListTopicSubscriptionsAsyncPager_ListTopicSubscriptionsAsyncPager)

### google.pubsub_v1.services.publisher.pagers.ListTopicSubscriptionsPager

    ListTopicSubscriptionsPager(
        method: typing.Callable[
            [...], google.cloud.pubsub_v1.types.ListTopicSubscriptionsResponse
        ],
        request: google.cloud.pubsub_v1.types.ListTopicSubscriptionsRequest,
        response: google.cloud.pubsub_v1.types.ListTopicSubscriptionsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiate the pager.

See more: [google.pubsub_v1.services.publisher.pagers.ListTopicSubscriptionsPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.publisher.pagers.ListTopicSubscriptionsPager#google_pubsub_v1_services_publisher_pagers_ListTopicSubscriptionsPager_ListTopicSubscriptionsPager)

### google.pubsub_v1.services.publisher.pagers.ListTopicsAsyncPager

    ListTopicsAsyncPager(
        method: typing.Callable[
            [...], typing.Awaitable[google.cloud.pubsub_v1.types.ListTopicsResponse]
        ],
        request: google.cloud.pubsub_v1.types.ListTopicsRequest,
        response: google.cloud.pubsub_v1.types.ListTopicsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiates the pager.

See more: [google.pubsub_v1.services.publisher.pagers.ListTopicsAsyncPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.publisher.pagers.ListTopicsAsyncPager#google_pubsub_v1_services_publisher_pagers_ListTopicsAsyncPager_ListTopicsAsyncPager)

### google.pubsub_v1.services.publisher.pagers.ListTopicsPager

    ListTopicsPager(
        method: typing.Callable[[...], google.cloud.pubsub_v1.types.ListTopicsResponse],
        request: google.cloud.pubsub_v1.types.ListTopicsRequest,
        response: google.cloud.pubsub_v1.types.ListTopicsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiate the pager.

See more: [google.pubsub_v1.services.publisher.pagers.ListTopicsPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.publisher.pagers.ListTopicsPager#google_pubsub_v1_services_publisher_pagers_ListTopicsPager_ListTopicsPager)

### google.pubsub_v1.services.subscriber.pagers.ListSnapshotsAsyncPager

    ListSnapshotsAsyncPager(
        method: typing.Callable[
            [...], typing.Awaitable[google.cloud.pubsub_v1.types.ListSnapshotsResponse]
        ],
        request: google.cloud.pubsub_v1.types.ListSnapshotsRequest,
        response: google.cloud.pubsub_v1.types.ListSnapshotsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiates the pager.

See more: [google.pubsub_v1.services.subscriber.pagers.ListSnapshotsAsyncPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.subscriber.pagers.ListSnapshotsAsyncPager#google_pubsub_v1_services_subscriber_pagers_ListSnapshotsAsyncPager_ListSnapshotsAsyncPager)

### google.pubsub_v1.services.subscriber.pagers.ListSnapshotsPager

    ListSnapshotsPager(
        method: typing.Callable[[...], google.cloud.pubsub_v1.types.ListSnapshotsResponse],
        request: google.cloud.pubsub_v1.types.ListSnapshotsRequest,
        response: google.cloud.pubsub_v1.types.ListSnapshotsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiate the pager.

See more: [google.pubsub_v1.services.subscriber.pagers.ListSnapshotsPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.subscriber.pagers.ListSnapshotsPager#google_pubsub_v1_services_subscriber_pagers_ListSnapshotsPager_ListSnapshotsPager)

### google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsAsyncPager

    ListSubscriptionsAsyncPager(
        method: typing.Callable[
            [...], typing.Awaitable[google.cloud.pubsub_v1.types.ListSubscriptionsResponse]
        ],
        request: google.cloud.pubsub_v1.types.ListSubscriptionsRequest,
        response: google.cloud.pubsub_v1.types.ListSubscriptionsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiates the pager.

See more: [google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsAsyncPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsAsyncPager#google_pubsub_v1_services_subscriber_pagers_ListSubscriptionsAsyncPager_ListSubscriptionsAsyncPager)

### google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsPager

    ListSubscriptionsPager(
        method: typing.Callable[
            [...], google.cloud.pubsub_v1.types.ListSubscriptionsResponse
        ],
        request: google.cloud.pubsub_v1.types.ListSubscriptionsRequest,
        response: google.cloud.pubsub_v1.types.ListSubscriptionsResponse,
        *,
        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, typing.Union[str, bytes]]] = ()
    )

Instantiate the pager.

See more: [google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsPager](https://cloud.google.com/python/docs/reference/pubsub/latest/google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsPager#google_pubsub_v1_services_subscriber_pagers_ListSubscriptionsPager_ListSubscriptionsPager)