Class Client (2.10.0)

Client(**kwargs: Any)

A subscriber client for Google Cloud Pub/Sub.

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

Properties

api

The underlying gapic API client.

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

deprecated: Use the GAPIC methods and properties on the client instance directly instead of through the api attribute.

closed

Return whether the client has been closed and cannot be used anymore.

.. versionadded:: 2.8.0

target

Return the target (where the API is).

transport

Returns the transport used by the client instance.

Returns
Type	Description
`SubscriberTransport`	The transport used by the client instance.

Methods

Client

Client(**kwargs: Any)

Instantiates the subscriber client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, SubscriberTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

acknowledge

acknowledge(request: Optional[Union[google.cloud.pubsub_v1.types.AcknowledgeRequest, dict]] = None, *, subscription: Optional[str] = None, ack_ids: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription.

Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

from google import pubsub_v1

def sample_acknowledge():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.AcknowledgeRequest(
        subscription="subscription_value",
        ack_ids=['ack_ids_value_1', 'ack_ids_value_2'],
    )

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

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.AcknowledgeRequest, dict]` The request object. Request for the Acknowledge method.
`subscription`	`str` Required. The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`. This corresponds to the `subscription` field on the `request` instance; if `request` is provided, this should not be set.
`ack_ids`	`Sequence[str]` Required. The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty. This corresponds to the `ack_ids` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

close

close()

Close the underlying channel to release socket resources.

After a channel has been closed, the client instance cannot be used anymore.

This method is idempotent.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_snapshot

create_snapshot(request: Optional[Union[google.cloud.pubsub_v1.types.CreateSnapshotRequest, dict]] = None, *, name: Optional[str] = None, subscription: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a snapshot from the requested subscription. 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. If the snapshot already exists, returns ALREADY_EXISTS. If the requested subscription doesn't exist, returns NOT_FOUND. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then FAILED_PRECONDITION is returned. See also the Snapshot.expire_time field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the resource name format. The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

from google import pubsub_v1

def sample_create_snapshot():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.CreateSnapshotRequest(
        name="name_value",
        subscription="subscription_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.CreateSnapshotRequest, dict]` The request object. Request for the `CreateSnapshot` method.
`name`	`str` Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`subscription`	`str` Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`. This corresponds to the `subscription` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.types.Snapshot`	A snapshot resource. 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.

create_subscription

create_subscription(request: Optional[Union[google.cloud.pubsub_v1.types.Subscription, dict]] = None, *, name: Optional[str] = None, topic: Optional[str] = None, push_config: Optional[google.cloud.pubsub_v1.types.PushConfig] = None, ack_deadline_seconds: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a subscription to a given topic. See the resource name rules. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND.

If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

from google import pubsub_v1

def sample_create_subscription():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.Subscription(
        name="name_value",
        topic="topic_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.Subscription, dict]` The request object. A subscription resource.
`name`	`str` Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes ( ), plus (`<code>+</code><code>) or percent signs (</code><code>%</code><code>). It must be between 3 and 255 characters in length, and it must not start with </code>"goog"<code>. This corresponds to the </code>name<code> field on the </code>request<code> instance; if </code>request` is provided, this should not be set.
`topic`	`str` Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `deleted-topic` if the topic has been deleted. This corresponds to the `topic` field on the `request` instance; if `request` is provided, this should not be set.
`push_config`	`google.pubsub_v1.types.PushConfig` If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. This corresponds to the `push_config` field on the `request` instance; if `request` is provided, this should not be set.
`ack_deadline_seconds`	`int` The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. This corresponds to the `ack_deadline_seconds` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.types.Subscription`	A subscription resource.

delete_snapshot

delete_snapshot(request: Optional[Union[google.cloud.pubsub_v1.types.DeleteSnapshotRequest, dict]] = None, *, snapshot: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Removes an existing snapshot. Snapshots are used in Seek 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. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

from google import pubsub_v1

def sample_delete_snapshot():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.DeleteSnapshotRequest(
        snapshot="snapshot_value",
    )

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

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.DeleteSnapshotRequest, dict]` The request object. Request for the `DeleteSnapshot` method.
`snapshot`	`str` Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`. This corresponds to the `snapshot` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

delete_subscription

delete_subscription(request: Optional[Union[google.cloud.pubsub_v1.types.DeleteSubscriptionRequest, dict]] = None, *, subscription: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

from google import pubsub_v1

def sample_delete_subscription():
    # Create a client
    client = pubsub_v1.SubscriberClient()

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

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

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.DeleteSubscriptionRequest, dict]` The request object. Request for the DeleteSubscription method.
`subscription`	`str` Required. The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`. This corresponds to the `subscription` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

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

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

from_service_account_info

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

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`SubscriberClient`	The constructed client.

from_service_account_json

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

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

get_iam_policy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the IAM access control policy for a function.

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

Parameters
Name	Description
`request`	`.iam_policy_pb2.GetIamPolicyRequest` The request object. Request message for `GetIamPolicy` method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example**:: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_mtls_endpoint_and_cert_source

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

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 variabel 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.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_snapshot

get_snapshot(request: Optional[Union[google.cloud.pubsub_v1.types.GetSnapshotRequest, dict]] = None, *, snapshot: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the configuration details of a snapshot. Snapshots are used in a href="https://cloud.google.com/pubsub/docs/replay-overview"Seek 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.

from google import pubsub_v1

def sample_get_snapshot():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.GetSnapshotRequest(
        snapshot="snapshot_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.GetSnapshotRequest, dict]` The request object. Request for the GetSnapshot method.
`snapshot`	`str` Required. The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`. This corresponds to the `snapshot` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.types.Snapshot`	A snapshot resource. 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.

get_subscription

get_subscription(request: Optional[Union[google.cloud.pubsub_v1.types.GetSubscriptionRequest, dict]] = None, *, subscription: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the configuration details of a subscription.

from google import pubsub_v1

def sample_get_subscription():
    # Create a client
    client = pubsub_v1.SubscriberClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.GetSubscriptionRequest, dict]` The request object. Request for the GetSubscription method.
`subscription`	`str` Required. The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`. This corresponds to the `subscription` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.types.Subscription`	A subscription resource.

list_snapshots

list_snapshots(request: Optional[Union[google.cloud.pubsub_v1.types.ListSnapshotsRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the existing snapshots. 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.

from google import pubsub_v1

def sample_list_snapshots():
    # Create a client
    client = pubsub_v1.SubscriberClient()

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

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

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

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.ListSnapshotsRequest, dict]` The request object. Request for the `ListSnapshots` method.
`project`	`str` Required. The name of the project in which to list snapshots. Format is `projects/{project-id}`. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.services.subscriber.pagers.ListSnapshotsPager`	Response for the ListSnapshots method. Iterating over this object will yield results and resolve additional pages automatically.

list_subscriptions

list_subscriptions(request: Optional[Union[google.cloud.pubsub_v1.types.ListSubscriptionsRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists matching subscriptions.

from google import pubsub_v1

def sample_list_subscriptions():
    # Create a client
    client = pubsub_v1.SubscriberClient()

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

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

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

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.ListSubscriptionsRequest, dict]` The request object. Request for the `ListSubscriptions` method.
`project`	`str` Required. The name of the project in which to list subscriptions. Format is `projects/{project-id}`. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsPager`	Response for the ListSubscriptions method. Iterating over this object will yield results and resolve additional pages automatically.

modify_ack_deadline

modify_ack_deadline(request: Optional[Union[google.cloud.pubsub_v1.types.ModifyAckDeadlineRequest, dict]] = None, *, subscription: Optional[str] = None, ack_ids: Optional[Sequence[str]] = None, ack_deadline_seconds: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level ackDeadlineSeconds used for subsequent messages.

from google import pubsub_v1

def sample_modify_ack_deadline():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.ModifyAckDeadlineRequest(
        subscription="subscription_value",
        ack_ids=['ack_ids_value_1', 'ack_ids_value_2'],
        ack_deadline_seconds=2066,
    )

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

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.ModifyAckDeadlineRequest, dict]` The request object. Request for the ModifyAckDeadline method.
`subscription`	`str` Required. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. This corresponds to the `subscription` field on the `request` instance; if `request` is provided, this should not be set.
`ack_ids`	`Sequence[str]` Required. List of acknowledgment IDs. This corresponds to the `ack_ids` field on the `request` instance; if `request` is provided, this should not be set.
`ack_deadline_seconds`	`int` Required. The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes). This corresponds to the `ack_deadline_seconds` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

modify_push_config

modify_push_config(request: Optional[Union[google.cloud.pubsub_v1.types.ModifyPushConfigRequest, dict]] = None, *, subscription: Optional[str] = None, push_config: Optional[google.cloud.pubsub_v1.types.PushConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Modifies the PushConfig for a specified subscription.

This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.

from google import pubsub_v1

def sample_modify_push_config():
    # Create a client
    client = pubsub_v1.SubscriberClient()

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

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

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.ModifyPushConfigRequest, dict]` The request object. Request for the ModifyPushConfig method.
`subscription`	`str` Required. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. This corresponds to the `subscription` field on the `request` instance; if `request` is provided, this should not be set.
`push_config`	`google.pubsub_v1.types.PushConfig` Required. The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called. This corresponds to the `push_config` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_snapshot_path

parse_snapshot_path(path: str)

Parses a snapshot path into its component segments.

parse_subscription_path

parse_subscription_path(path: str)

Parses a subscription path into its component segments.

parse_topic_path

parse_topic_path(path: str)

Parses a topic path into its component segments.

pull

pull(request: Optional[Union[google.cloud.pubsub_v1.types.PullRequest, dict]] = None, *, subscription: Optional[str] = None, return_immediately: Optional[bool] = None, max_messages: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Pulls messages from the server. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.

from google import pubsub_v1

def sample_pull():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.PullRequest(
        subscription="subscription_value",
        max_messages=1277,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.PullRequest, dict]` The request object. Request for the `Pull` method.
`subscription`	`str` Required. The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`. This corresponds to the `subscription` field on the `request` instance; if `request` is provided, this should not be set.
`return_immediately`	`bool` Optional. If this field set to true, the system will respond immediately even if it there are no messages available to return in the `Pull` response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. Warning: setting this field to `true` is discouraged because it adversely impacts the performance of `Pull` operations. We recommend that users do not set this field. This corresponds to the `return_immediately` field on the `request` instance; if `request` is provided, this should not be set.
`max_messages`	`int` Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified. This corresponds to the `max_messages` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.types.PullResponse`	Response for the Pull method.

seek

seek(request: Optional[Union[google.cloud.pubsub_v1.types.SeekRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in Seek 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. Note that both the subscription and the snapshot must be on the same topic.

from google import pubsub_v1

def sample_seek():
    # Create a client
    client = pubsub_v1.SubscriberClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.SeekRequest, dict]` The request object. Request for the `Seek` method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.types.SeekResponse`	Response for the Seek method (this response is empty).

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters
Name	Description
`request`	`.iam_policy_pb2.SetIamPolicyRequest` The request object. Request message for `SetIamPolicy` method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

snapshot_path

snapshot_path(project: str, snapshot: str)

Returns a fully-qualified snapshot string.

streaming_pull

streaming_pull(requests: Optional[Iterator[google.cloud.pubsub_v1.types.StreamingPullRequest]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status UNAVAILABLE to reassign server-side resources, in which case, the client should re-establish the stream. Flow control can be achieved by configuring the underlying RPC channel.

from google import pubsub_v1

def sample_streaming_pull():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.StreamingPullRequest(
        subscription="subscription_value",
        stream_ack_deadline_seconds=2813,
    )

    # This method expects an iterator which contains
    # 'pubsub_v1.StreamingPullRequest' objects
    # Here we create a generator that yields a single `request` for
    # demonstrative purposes.
    requests = [request]

    def request_generator():
        for request in requests:
            yield request

    # Make the request
    stream = client.streaming_pull(requests=request_generator())

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

Parameters
Name	Description
`requests`	`Iterator[google.pubsub_v1.types.StreamingPullRequest]` The request object iterator. Request for the `StreamingPull` streaming RPC method. This request is used to establish the initial stream as well as to stream acknowledgements and ack deadline modifications from the client to the server.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`Iterable[google.pubsub_v1.types.StreamingPullResponse]`	Response for the StreamingPull method. This response is used to stream messages from the server to the client.

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

Asynchronously start receiving messages on a given subscription.

This method starts a background thread to begin pulling messages from a Pub/Sub subscription and scheduling them to be processed using the provided callback.

The callback will be called with an individual xref_Message. It is the responsibility of the callback to either call ack() or nack() on the message when it finished processing. If an exception occurs in the callback during processing, the exception is logged and the message is nack() ed.

The flow_control argument can be used to control the rate of at which messages are pulled. The settings are relatively conservative by default to prevent "message hoarding" - a situation where the client pulls a large number of messages but can not process them fast enough leading it to "starve" other clients of messages. Increasing these settings may lead to faster throughput for messages that do not take a long time to process.

The use_legacy_flow_control argument disables enforcing flow control settings at the Cloud Pub/Sub server, and only the client side flow control will be enforced.

This method starts the receiver in the background and returns a Future representing its execution. Waiting on the future (calling result()) will block forever or until a non-recoverable error is encountered (such as loss of network connectivity). Cancelling the future will signal the process to shutdown gracefully and exit.

Example:

from google.cloud import pubsub_v1

subscriber_client = pubsub_v1.SubscriberClient()

# existing subscription
subscription = subscriber_client.subscription_path(
    'my-project-id', 'my-subscription')

def callback(message):
    print(message)
    message.ack()

future = subscriber_client.subscribe(
    subscription, callback)

try:
    future.result()
except KeyboardInterrupt:
    future.cancel()  # Trigger the shutdown.
    future.result()  # Block until the shutdown is complete.

Parameter
Name	Description
`use_legacy_flow_control`	`bool` If set to `True`, flow control at the Cloud Pub/Sub server is disabled, though client-side flow control is still enabled. If set to `False` (default), both server-side and client-side flow control are enabled.

subscription_path

subscription_path(project: str, subscription: str)

Returns a fully-qualified subscription string.

test_iam_permissions

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
`request`	`.iam_policy_pb2.TestIamPermissionsRequest` The request object. Request message for `TestIamPermissions` method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.iam_policy_pb2.TestIamPermissionsResponse`	Response message for `TestIamPermissions` method.

topic_path

topic_path(project: str, topic: str)

Returns a fully-qualified topic string.

update_snapshot

update_snapshot(request: Optional[Union[google.cloud.pubsub_v1.types.UpdateSnapshotRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing snapshot. Snapshots are used in a href="https://cloud.google.com/pubsub/docs/replay-overview"Seek 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.

from google import pubsub_v1

def sample_update_snapshot():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    request = pubsub_v1.UpdateSnapshotRequest(
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.UpdateSnapshotRequest, dict]` The request object. Request for the UpdateSnapshot method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.types.Snapshot`	A snapshot resource. 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.

update_subscription

update_subscription(request: Optional[Union[google.cloud.pubsub_v1.types.UpdateSubscriptionRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.

from google import pubsub_v1

def sample_update_subscription():
    # Create a client
    client = pubsub_v1.SubscriberClient()

    # Initialize request argument(s)
    subscription = pubsub_v1.Subscription()
    subscription.name = "name_value"
    subscription.topic = "topic_value"

    request = pubsub_v1.UpdateSubscriptionRequest(
        subscription=subscription,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.pubsub_v1.types.UpdateSubscriptionRequest, dict]` The request object. Request for the UpdateSubscription method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.pubsub_v1.types.Subscription`	A subscription resource.