Class Client (2.26.1)

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
)

A publisher client for Google Cloud Pub/Sub.

This creates an object that is capable of publishing messages. Generally, you can instantiate this client with no arguments, and you get sensible defaults.

The underlying gapic API client.

.. versionchanged:: 2.10.0 Instead of a GAPIC PublisherClient client instance, this property is a proxy object to it with the same interface.

Return the API endpoint used by the client instance.

Return the target (where the API is).

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

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.

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

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

Returns a fully-qualified location string.

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path(project: str) -> str

Returns a fully-qualified project string.

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, str]] = ()
) -> google.cloud.pubsub_v1.types.Topic

Creates the given topic with the given name. See the resource name rules.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google import pubsub_v1

def sample_create_topic():
    # Create a client
    client = pubsub_v1.PublisherClient()

    # Initialize request argument(s)
    request = pubsub_v1.Topic(
        name="name_value",
    )

    # Make the request
    response = client.create_topic(request=request)

    # Handle the response
    print(response)

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, str]] = ()
) -> None

Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their topic field is set to _deleted-topic_.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google import pubsub_v1

def sample_delete_topic():
    # Create a client
    client = pubsub_v1.PublisherClient()

    # Initialize request argument(s)
    request = pubsub_v1.DeleteTopicRequest(
        topic="topic_value",
    )

    # Make the request
    client.delete_topic(request=request)

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, str]] = ()
) -> google.cloud.pubsub_v1.types.DetachSubscriptionResponse

Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google import pubsub_v1

def sample_detach_subscription():
    # Create a client
    client = pubsub_v1.PublisherClient()

    # Initialize request argument(s)
    request = pubsub_v1.DetachSubscriptionRequest(
        subscription="subscription_value",
    )

    # Make the request
    response = client.detach_subscription(request=request)

    # Handle the response
    print(response)

ensure_cleanup_and_commit_timer_runs() -> None

Ensure a cleanup/commit timer thread is running.

If a cleanup/commit timer thread is already running, this does nothing.

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.

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

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

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.

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

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

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

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

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

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, str]] = ()
) -> google.cloud.pubsub_v1.types.Topic

Gets the configuration of a topic.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google import pubsub_v1

def sample_get_topic():
    # Create a client
    client = pubsub_v1.PublisherClient()

    # Initialize request argument(s)
    request = pubsub_v1.GetTopicRequest(
        topic="topic_value",
    )

    # Make the request
    response = client.get_topic(request=request)

    # Handle the response
    print(response)

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, str]] = ()
) -> google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsPager

Lists the names of the snapshots on this topic. Snapshots are used in Seek <https://cloud.google.com/pubsub/docs/replay-overview>__ operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google import pubsub_v1

def sample_list_topic_snapshots():
    # Create a client
    client = pubsub_v1.PublisherClient()

    # Initialize request argument(s)
    request = pubsub_v1.ListTopicSnapshotsRequest(
        topic="topic_value",
    )

    # Make the request
    page_result = client.list_topic_snapshots(request=request)

    # Handle the response
    for response in page_result:
        print(response)

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, str]] = ()
) -> google.pubsub_v1.services.publisher.pagers.ListTopicSubscriptionsPager

Lists the names of the attached subscriptions on this topic.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google import pubsub_v1

def sample_list_topic_subscriptions():
    # Create a client
    client = pubsub_v1.PublisherClient()

    # Initialize request argument(s)
    request = pubsub_v1.ListTopicSubscriptionsRequest(
        topic="topic_value",
    )

    # Make the request
    page_result = client.list_topic_subscriptions(request=request)

    # Handle the response
    for response in page_result:
        print(response)

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, str]] = ()
) -> google.pubsub_v1.services.publisher.pagers.ListTopicsPager

Lists matching topics.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google import pubsub_v1

def sample_list_topics():
    # Create a client
    client = pubsub_v1.PublisherClient()

    # Initialize request argument(s)
    request = pubsub_v1.ListTopicsRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.list_topics(request=request)

    # Handle the response
    for response in page_result:
        print(response)

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

Parse a billing_account path into its component segments.

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

Parse a folder path into its component segments.

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

Parse a location path into its component segments.

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

Parse a organization path into its component segments.

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

Parse a project path into its component segments.

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

Parses a schema path into its component segments.

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

Parses a subscription path into its component segments.

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

Parses a topic path into its component segments.

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.

The reason that this is so important (and why we do not try to coerce for you) is because Pub/Sub is also platform independent and there is no way to know how to decode messages properly on the other side; therefore, encoding and decoding is a required exercise for the developer.

Add the given message to this object; this will cause it to be published once the batch either has enough messages or a sufficient period of time has elapsed. This method may block if LimitExceededBehavior.BLOCK is used in the flow control settings.

.. rubric:: Example

from google.cloud import pubsub_v1 client = pubsub_v1.PublisherClient() topic = client.topic_path('[PROJECT]', '[TOPIC]') data = b'The rain in Wales falls mainly on the snails.' response = client.publish(topic, data, username='guido')

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

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

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

Returns a fully-qualified schema string.

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

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

stop() -> None

Immediately publish all outstanding messages.

Asynchronously sends all outstanding messages and prevents future calls to publish(). Method should be invoked prior to deleting this Client() object in order to ensure that no pending messages are lost.

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

Returns a fully-qualified subscription string.

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

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

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

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

Returns a fully-qualified topic string.

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, str]] = ()
) -> google.cloud.pubsub_v1.types.Topic

Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google import pubsub_v1

def sample_update_topic():
    # Create a client
    client = pubsub_v1.PublisherClient()

    # Initialize request argument(s)
    topic = pubsub_v1.Topic()
    topic.name = "name_value"

    request = pubsub_v1.UpdateTopicRequest(
        topic=topic,
    )

    # Make the request
    response = client.update_topic(request=request)

    # Handle the response
    print(response)