As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit Python 2 support on Google Cloud.
Source code for google.devicesandservices.health_v4.services.data_subscription_service.client
# -*- coding: utf-8 -*-
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import json
import logging as std_logging
import os
import re
import warnings
from collections import OrderedDict
from http import HTTPStatus
from typing import (
Callable,
Dict,
Mapping,
MutableMapping,
MutableSequence,
Optional,
Sequence,
Tuple,
Type,
Union,
cast,
)
import google.protobuf
from google.api_core import client_options as client_options_lib
from google.api_core import exceptions as core_exceptions
from google.api_core import gapic_v1
from google.api_core import retry as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.exceptions import MutualTLSChannelError # type: ignore
from google.auth.transport import mtls # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.oauth2 import service_account # type: ignore
from google.devicesandservices.health_v4 import gapic_version as package_version
try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
except AttributeError: # pragma: NO COVER
OptionalRetry = Union[retries.Retry, object, None] # type: ignore
try:
from google.api_core import client_logging # type: ignore
CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER
except ImportError: # pragma: NO COVER
CLIENT_LOGGING_SUPPORTED = False
_LOGGER = std_logging.getLogger(__name__)
import google.api_core.operation as operation # type: ignore
import google.api_core.operation_async as operation_async # type: ignore
import google.protobuf.empty_pb2 as empty_pb2 # type: ignore
import google.protobuf.field_mask_pb2 as field_mask_pb2 # type: ignore
from google.devicesandservices.health_v4.services.data_subscription_service import (
pagers,
)
from google.devicesandservices.health_v4.types import data_subscription_service
from .transports.base import DEFAULT_CLIENT_INFO, DataSubscriptionServiceTransport
from .transports.grpc import DataSubscriptionServiceGrpcTransport
from .transports.grpc_asyncio import DataSubscriptionServiceGrpcAsyncIOTransport
from .transports.rest import DataSubscriptionServiceRestTransport
class DataSubscriptionServiceClientMeta(type):
"""Metaclass for the DataSubscriptionService client.
This provides class-level methods for building and retrieving
support objects (e.g. transport) without polluting the client instance
objects.
"""
_transport_registry = OrderedDict() # type: Dict[str, Type[DataSubscriptionServiceTransport]]
_transport_registry["grpc"] = DataSubscriptionServiceGrpcTransport
_transport_registry["grpc_asyncio"] = DataSubscriptionServiceGrpcAsyncIOTransport
_transport_registry["rest"] = DataSubscriptionServiceRestTransport
def get_transport_class(
cls,
label: Optional[str] = None,
) -> Type[DataSubscriptionServiceTransport]:
"""Returns an appropriate transport class.
Args:
label: The name of the desired transport. If none is
provided, then the first transport in the registry is used.
Returns:
The transport class to use.
"""
# If a specific transport is requested, return that one.
if label:
return cls._transport_registry[label]
# No transport is requested; return the default (that is, the first one
# in the dictionary).
return next(iter(cls._transport_registry.values()))
[docs]class DataSubscriptionServiceClient(metaclass=DataSubscriptionServiceClientMeta):
"""Data Subscription Service that allows clients (e.g., Fitbit
3P applications, internal Fitbit Services) to manage their
subscriber endpoints. This service provides CRUD APIs for
subscribers,
and also offers functionalities for subscriber verification and
statistics.
"""
@staticmethod
def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
"""Converts api endpoint to mTLS endpoint.
Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
"*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
Args:
api_endpoint (Optional[str]): the api endpoint to convert.
Returns:
Optional[str]: converted mTLS api endpoint.
"""
if not api_endpoint:
return api_endpoint
mtls_endpoint_re = re.compile(
r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?"
)
m = mtls_endpoint_re.match(api_endpoint)
if m is None:
# Could not parse api_endpoint; return as-is.
return api_endpoint
name, mtls, sandbox, googledomain = m.groups()
if mtls or not googledomain:
return api_endpoint
if sandbox:
return api_endpoint.replace(
"sandbox.googleapis.com", "mtls.sandbox.googleapis.com"
)
return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com")
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
DEFAULT_ENDPOINT = "health.googleapis.com"
DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore
DEFAULT_ENDPOINT
)
_DEFAULT_ENDPOINT_TEMPLATE = "health.{UNIVERSE_DOMAIN}"
_DEFAULT_UNIVERSE = "googleapis.com"
@staticmethod
def _use_client_cert_effective():
"""Returns whether client certificate should be used for mTLS if the
google-auth version supports should_use_client_cert automatic mTLS enablement.
Alternatively, read from the GOOGLE_API_USE_CLIENT_CERTIFICATE env var.
Returns:
bool: whether client certificate should be used for mTLS
Raises:
ValueError: (If using a version of google-auth without should_use_client_cert and
GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
"""
# check if google-auth version supports should_use_client_cert for automatic mTLS enablement
if hasattr(mtls, "should_use_client_cert"): # pragma: NO COVER
return mtls.should_use_client_cert()
else: # pragma: NO COVER
# if unsupported, fallback to reading from env var
use_client_cert_str = os.getenv(
"GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
).lower()
if use_client_cert_str not in ("true", "false"):
raise ValueError(
"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
" either `true` or `false`"
)
return use_client_cert_str == "true"
[docs] @classmethod
def from_service_account_info(cls, info: dict, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
info.
Args:
info (dict): The service account private key info.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
DataSubscriptionServiceClient: The constructed client.
"""
credentials = service_account.Credentials.from_service_account_info(info)
kwargs["credentials"] = credentials
return cls(*args, **kwargs)
[docs] @classmethod
def from_service_account_file(cls, filename: str, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
file.
Args:
filename (str): The path to the service account private key json
file.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
DataSubscriptionServiceClient: The constructed client.
"""
credentials = service_account.Credentials.from_service_account_file(filename)
kwargs["credentials"] = credentials
return cls(*args, **kwargs)
from_service_account_json = from_service_account_file
@property
def transport(self) -> DataSubscriptionServiceTransport:
"""Returns the transport used by the client instance.
Returns:
DataSubscriptionServiceTransport: The transport used by the client
instance.
"""
return self._transport
[docs] @staticmethod
def data_type_path(
user: str,
data_type: str,
) -> str:
"""Returns a fully-qualified data_type string."""
return "users/{user}/dataTypes/{data_type}".format(
user=user,
data_type=data_type,
)
[docs] @staticmethod
def parse_data_type_path(path: str) -> Dict[str, str]:
"""Parses a data_type path into its component segments."""
m = re.match(r"^users/(?P<user>.+?)/dataTypes/(?P<data_type>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def subscriber_path(
project: str,
subscriber: str,
) -> str:
"""Returns a fully-qualified subscriber string."""
return "projects/{project}/subscribers/{subscriber}".format(
project=project,
subscriber=subscriber,
)
[docs] @staticmethod
def parse_subscriber_path(path: str) -> Dict[str, str]:
"""Parses a subscriber path into its component segments."""
m = re.match(
r"^projects/(?P<project>.+?)/subscribers/(?P<subscriber>.+?)$", path
)
return m.groupdict() if m else {}
[docs] @staticmethod
def subscription_path(
project: str,
subscriber: str,
subscription: str,
) -> str:
"""Returns a fully-qualified subscription string."""
return "projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}".format(
project=project,
subscriber=subscriber,
subscription=subscription,
)
[docs] @staticmethod
def parse_subscription_path(path: str) -> Dict[str, str]:
"""Parses a subscription path into its component segments."""
m = re.match(
r"^projects/(?P<project>.+?)/subscribers/(?P<subscriber>.+?)/subscriptions/(?P<subscription>.+?)$",
path,
)
return m.groupdict() if m else {}
[docs] @staticmethod
def user_path(
user: str,
) -> str:
"""Returns a fully-qualified user string."""
return "users/{user}".format(
user=user,
)
[docs] @staticmethod
def parse_user_path(path: str) -> Dict[str, str]:
"""Parses a user path into its component segments."""
m = re.match(r"^users/(?P<user>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_billing_account_path(
billing_account: str,
) -> str:
"""Returns a fully-qualified billing_account string."""
return "billingAccounts/{billing_account}".format(
billing_account=billing_account,
)
[docs] @staticmethod
def parse_common_billing_account_path(path: str) -> Dict[str, str]:
"""Parse a billing_account path into its component segments."""
m = re.match(r"^billingAccounts/(?P<billing_account>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_folder_path(
folder: str,
) -> str:
"""Returns a fully-qualified folder string."""
return "folders/{folder}".format(
folder=folder,
)
[docs] @staticmethod
def parse_common_folder_path(path: str) -> Dict[str, str]:
"""Parse a folder path into its component segments."""
m = re.match(r"^folders/(?P<folder>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_organization_path(
organization: str,
) -> str:
"""Returns a fully-qualified organization string."""
return "organizations/{organization}".format(
organization=organization,
)
[docs] @staticmethod
def parse_common_organization_path(path: str) -> Dict[str, str]:
"""Parse a organization path into its component segments."""
m = re.match(r"^organizations/(?P<organization>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_project_path(
project: str,
) -> str:
"""Returns a fully-qualified project string."""
return "projects/{project}".format(
project=project,
)
[docs] @staticmethod
def parse_common_project_path(path: str) -> Dict[str, str]:
"""Parse a project path into its component segments."""
m = re.match(r"^projects/(?P<project>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_location_path(
project: str,
location: str,
) -> str:
"""Returns a fully-qualified location string."""
return "projects/{project}/locations/{location}".format(
project=project,
location=location,
)
[docs] @staticmethod
def parse_common_location_path(path: str) -> Dict[str, str]:
"""Parse a location path into its component segments."""
m = re.match(r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)$", path)
return m.groupdict() if m else {}
[docs] @classmethod
def get_mtls_endpoint_and_cert_source(
cls, client_options: Optional[client_options_lib.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.
Args:
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.
Returns:
Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the
client cert source to use.
Raises:
google.auth.exceptions.MutualTLSChannelError: If any errors happen.
"""
warnings.warn(
"get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.",
DeprecationWarning,
)
if client_options is None:
client_options = client_options_lib.ClientOptions()
use_client_cert = DataSubscriptionServiceClient._use_client_cert_effective()
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
if use_mtls_endpoint not in ("auto", "never", "always"):
raise MutualTLSChannelError(
"Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
)
# Figure out the client cert source to use.
client_cert_source = None
if use_client_cert:
if client_options.client_cert_source:
client_cert_source = client_options.client_cert_source
elif mtls.has_default_client_cert_source():
client_cert_source = mtls.default_client_cert_source()
# Figure out which api endpoint to use.
if client_options.api_endpoint is not None:
api_endpoint = client_options.api_endpoint
elif use_mtls_endpoint == "always" or (
use_mtls_endpoint == "auto" and client_cert_source
):
api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
else:
api_endpoint = cls.DEFAULT_ENDPOINT
return api_endpoint, client_cert_source
@staticmethod
def _read_environment_variables():
"""Returns the environment variables used by the client.
Returns:
Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
Raises:
ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
any of ["true", "false"].
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
is not any of ["auto", "never", "always"].
"""
use_client_cert = DataSubscriptionServiceClient._use_client_cert_effective()
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
if use_mtls_endpoint not in ("auto", "never", "always"):
raise MutualTLSChannelError(
"Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
)
return use_client_cert, use_mtls_endpoint, universe_domain_env
@staticmethod
def _get_client_cert_source(provided_cert_source, use_cert_flag):
"""Return the client cert source to be used by the client.
Args:
provided_cert_source (bytes): The client certificate source provided.
use_cert_flag (bool): A flag indicating whether to use the client certificate.
Returns:
bytes or None: The client cert source to be used by the client.
"""
client_cert_source = None
if use_cert_flag:
if provided_cert_source:
client_cert_source = provided_cert_source
elif mtls.has_default_client_cert_source():
client_cert_source = mtls.default_client_cert_source()
return client_cert_source
@staticmethod
def _get_api_endpoint(
api_override, client_cert_source, universe_domain, use_mtls_endpoint
) -> str:
"""Return the API endpoint used by the client.
Args:
api_override (str): The API endpoint override. If specified, this is always
the return value of this function and the other arguments are not used.
client_cert_source (bytes): The client certificate source used by the client.
universe_domain (str): The universe domain used by the client.
use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters.
Possible values are "always", "auto", or "never".
Returns:
str: The API endpoint to be used by the client.
"""
if api_override is not None:
api_endpoint = api_override
elif use_mtls_endpoint == "always" or (
use_mtls_endpoint == "auto" and client_cert_source
):
_default_universe = DataSubscriptionServiceClient._DEFAULT_UNIVERSE
if universe_domain != _default_universe:
raise MutualTLSChannelError(
f"mTLS is not supported in any universe other than {_default_universe}."
)
api_endpoint = DataSubscriptionServiceClient.DEFAULT_MTLS_ENDPOINT
else:
api_endpoint = (
DataSubscriptionServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(
UNIVERSE_DOMAIN=universe_domain
)
)
return api_endpoint
@staticmethod
def _get_universe_domain(
client_universe_domain: Optional[str], universe_domain_env: Optional[str]
) -> str:
"""Return the universe domain used by the client.
Args:
client_universe_domain (Optional[str]): The universe domain configured via the client options.
universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable.
Returns:
str: The universe domain to be used by the client.
Raises:
ValueError: If the universe domain is an empty string.
"""
universe_domain = DataSubscriptionServiceClient._DEFAULT_UNIVERSE
if client_universe_domain is not None:
universe_domain = client_universe_domain
elif universe_domain_env is not None:
universe_domain = universe_domain_env
if len(universe_domain.strip()) == 0:
raise ValueError("Universe Domain cannot be an empty string.")
return universe_domain
def _validate_universe_domain(self):
"""Validates client's and credentials' universe domains are consistent.
Returns:
bool: True iff the configured universe domain is valid.
Raises:
ValueError: If the configured universe domain is not valid.
"""
# NOTE (b/349488459): universe validation is disabled until further notice.
return True
def _add_cred_info_for_auth_errors(
self, error: core_exceptions.GoogleAPICallError
) -> None:
"""Adds credential info string to error details for 401/403/404 errors.
Args:
error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info.
"""
if error.code not in [
HTTPStatus.UNAUTHORIZED,
HTTPStatus.FORBIDDEN,
HTTPStatus.NOT_FOUND,
]:
return
cred = self._transport._credentials
# get_cred_info is only available in google-auth>=2.35.0
if not hasattr(cred, "get_cred_info"):
return
# ignore the type check since pypy test fails when get_cred_info
# is not available
cred_info = cred.get_cred_info() # type: ignore
if cred_info and hasattr(error._details, "append"):
error._details.append(json.dumps(cred_info))
@property
def api_endpoint(self) -> str:
"""Return the API endpoint used by the client instance.
Returns:
str: The API endpoint used by the client instance.
"""
return self._api_endpoint
@property
def universe_domain(self) -> str:
"""Return the universe domain used by the client instance.
Returns:
str: The universe domain used by the client instance.
"""
return self._universe_domain
def __init__(
self,
*,
credentials: Optional[ga_credentials.Credentials] = None,
transport: Optional[
Union[
str,
DataSubscriptionServiceTransport,
Callable[..., DataSubscriptionServiceTransport],
]
] = None,
client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the data subscription service client.
Args:
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 (Optional[Union[str,DataSubscriptionServiceTransport,Callable[..., DataSubscriptionServiceTransport]]]):
The transport to use, or a Callable that constructs and returns a new transport.
If a Callable is given, it will be called with the same set of initialization
arguments as used in the DataSubscriptionServiceTransport constructor.
If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]):
Custom options for the client.
1. The ``api_endpoint`` property can be used to override the
default endpoint provided by the client when ``transport`` is
not explicitly provided. Only if this property is not set and
``transport`` was not explicitly provided, the endpoint is
determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment
variable, which have one of the following values:
"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).
2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable
is "true", then the ``client_cert_source`` property can be used
to provide a client certificate for mTLS 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.
3. The ``universe_domain`` property can be used to override the
default "googleapis.com" universe. Note that the ``api_endpoint``
property still takes precedence; and ``universe_domain`` is
currently not supported for mTLS.
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.
Raises:
google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport
creation failed for any reason.
"""
self._client_options = client_options
if isinstance(self._client_options, dict):
self._client_options = client_options_lib.from_dict(self._client_options)
if self._client_options is None:
self._client_options = client_options_lib.ClientOptions()
self._client_options = cast(
client_options_lib.ClientOptions, self._client_options
)
universe_domain_opt = getattr(self._client_options, "universe_domain", None)
self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = (
DataSubscriptionServiceClient._read_environment_variables()
)
self._client_cert_source = (
DataSubscriptionServiceClient._get_client_cert_source(
self._client_options.client_cert_source, self._use_client_cert
)
)
self._universe_domain = DataSubscriptionServiceClient._get_universe_domain(
universe_domain_opt, self._universe_domain_env
)
self._api_endpoint: str = "" # updated below, depending on `transport`
# Initialize the universe domain validation.
self._is_universe_domain_valid = False
if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER
# Setup logging.
client_logging.initialize_logging()
api_key_value = getattr(self._client_options, "api_key", None)
if api_key_value and credentials:
raise ValueError(
"client_options.api_key and credentials are mutually exclusive"
)
# Save or instantiate the transport.
# Ordinarily, we provide the transport, but allowing a custom transport
# instance provides an extensibility point for unusual situations.
transport_provided = isinstance(transport, DataSubscriptionServiceTransport)
if transport_provided:
# transport is a DataSubscriptionServiceTransport instance.
if credentials or self._client_options.credentials_file or api_key_value:
raise ValueError(
"When providing a transport instance, "
"provide its credentials directly."
)
if self._client_options.scopes:
raise ValueError(
"When providing a transport instance, provide its scopes directly."
)
self._transport = cast(DataSubscriptionServiceTransport, transport)
self._api_endpoint = self._transport.host
self._api_endpoint = (
self._api_endpoint
or DataSubscriptionServiceClient._get_api_endpoint(
self._client_options.api_endpoint,
self._client_cert_source,
self._universe_domain,
self._use_mtls_endpoint,
)
)
if not transport_provided:
import google.auth._default # type: ignore
if api_key_value and hasattr(
google.auth._default, "get_api_key_credentials"
):
credentials = google.auth._default.get_api_key_credentials(
api_key_value
)
transport_init: Union[
Type[DataSubscriptionServiceTransport],
Callable[..., DataSubscriptionServiceTransport],
] = (
DataSubscriptionServiceClient.get_transport_class(transport)
if isinstance(transport, str) or transport is None
else cast(Callable[..., DataSubscriptionServiceTransport], transport)
)
# initialize with the provided callable or the passed in class
self._transport = transport_init(
credentials=credentials,
credentials_file=self._client_options.credentials_file,
host=self._api_endpoint,
scopes=self._client_options.scopes,
client_cert_source_for_mtls=self._client_cert_source,
quota_project_id=self._client_options.quota_project_id,
client_info=client_info,
always_use_jwt_access=True,
api_audience=self._client_options.api_audience,
)
if "async" not in str(self._transport):
if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
std_logging.DEBUG
): # pragma: NO COVER
_LOGGER.debug(
"Created client `google.devicesandservices.health_v4.DataSubscriptionServiceClient`.",
extra={
"serviceName": "google.devicesandservices.health.v4.DataSubscriptionService",
"universeDomain": getattr(
self._transport._credentials, "universe_domain", ""
),
"credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}",
"credentialsInfo": getattr(
self.transport._credentials, "get_cred_info", lambda: None
)(),
}
if hasattr(self._transport, "_credentials")
else {
"serviceName": "google.devicesandservices.health.v4.DataSubscriptionService",
"credentialsType": None,
},
)
[docs] def create_subscriber(
self,
request: Optional[
Union[data_subscription_service.CreateSubscriberRequest, dict]
] = None,
*,
parent: Optional[str] = None,
subscriber: Optional[data_subscription_service.CreateSubscriberPayload] = None,
subscriber_id: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> operation.Operation:
r"""Registers a new subscriber endpoint to receive notifications. A
subscriber represents an application or service that wishes to
receive data change notifications for users who have granted
consent.
**Endpoint Verification:** For a subscriber to be successfully
created, the provided ``endpoint_uri`` must be a valid HTTPS
endpoint and must pass an automated verification check. The
backend will send two HTTP POST requests to the
``endpoint_uri``:
1. **Verification with Authorization:**
- **Headers:** Includes ``Content-Type: application/json``
and ``Authorization`` (with the exact value from
``CreateSubscriberPayload.endpoint_authorization.secret``).
- **Body:** ``{"type": "verification"}``
- **Expected Response:** HTTP ``201 Created``.
2. **Verification without Authorization:**
- **Headers:** Includes ``Content-Type: application/json``.
The ``Authorization`` header is OMITTED.
- **Body:** ``{"type": "verification"}``
- **Expected Response:** HTTP ``401 Unauthorized`` or
``403 Forbidden``.
Both tests must pass for the subscriber creation to succeed. If
verification fails, the operation will not be completed and an
error will be returned. This process ensures the endpoint is
reachable and correctly validates the ``Authorization`` header.
.. code-block:: python
# 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.devicesandservices import health_v4
def sample_create_subscriber():
# Create a client
client = health_v4.DataSubscriptionServiceClient()
# Initialize request argument(s)
subscriber = health_v4.CreateSubscriberPayload()
subscriber.endpoint_uri = "endpoint_uri_value"
subscriber.endpoint_authorization.secret = "secret_value"
request = health_v4.CreateSubscriberRequest(
parent="parent_value",
subscriber=subscriber,
)
# Make the request
operation = client.create_subscriber(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.devicesandservices.health_v4.types.CreateSubscriberRequest, dict]):
The request object. -- Messages --
Request message for CreateSubscriber.
parent (str):
Required. The parent resource where
this subscriber will be created. Format:
projects/{project} Example:
projects/my-project-123
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
subscriber (google.devicesandservices.health_v4.types.CreateSubscriberPayload):
Required. The subscriber to create.
This corresponds to the ``subscriber`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
subscriber_id (str):
Optional. The ID to use for the subscriber, which will
become the final component of the subscriber's resource
name.
This value should be 4-36 characters, and valid
characters are /`a-z <[a-z0-9-]{2,34}[a-z0-9]>`__/.
This corresponds to the ``subscriber_id`` 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, Union[str, bytes]]]): Key/value pairs which should be
sent along with the request as metadata. Normally, each value must be of type `str`,
but for metadata keys ending with the suffix `-bin`, the corresponding values must
be of type `bytes`.
Returns:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be
:class:`google.devicesandservices.health_v4.types.Subscriber`
-- Resource Messages -- A subscriber receives
notifications from Google Health API.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
flattened_params = [parent, subscriber, subscriber_id]
has_flattened_params = (
len([param for param in flattened_params if param is not None]) > 0
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, data_subscription_service.CreateSubscriberRequest):
request = data_subscription_service.CreateSubscriberRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if subscriber is not None:
request.subscriber = subscriber
if subscriber_id is not None:
request.subscriber_id = subscriber_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.create_subscriber]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
data_subscription_service.Subscriber,
metadata_type=data_subscription_service.CreateSubscriberMetadata,
)
# Done; return the response.
return response
[docs] def list_subscribers(
self,
request: Optional[
Union[data_subscription_service.ListSubscribersRequest, dict]
] = None,
*,
parent: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> pagers.ListSubscribersPager:
r"""Lists all subscribers registered within the owned
Google Cloud Project.
.. code-block:: python
# 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.devicesandservices import health_v4
def sample_list_subscribers():
# Create a client
client = health_v4.DataSubscriptionServiceClient()
# Initialize request argument(s)
request = health_v4.ListSubscribersRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_subscribers(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.devicesandservices.health_v4.types.ListSubscribersRequest, dict]):
The request object. Request message for ListSubscribers.
parent (str):
Required. The parent, which owns this
collection of subscribers. Format:
projects/{project}
This corresponds to the ``parent`` 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, Union[str, bytes]]]): Key/value pairs which should be
sent along with the request as metadata. Normally, each value must be of type `str`,
but for metadata keys ending with the suffix `-bin`, the corresponding values must
be of type `bytes`.
Returns:
google.devicesandservices.health_v4.services.data_subscription_service.pagers.ListSubscribersPager:
Response message for ListSubscribers.
Iterating over this object will yield
results and resolve additional pages
automatically.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
flattened_params = [parent]
has_flattened_params = (
len([param for param in flattened_params if param is not None]) > 0
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, data_subscription_service.ListSubscribersRequest):
request = data_subscription_service.ListSubscribersRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_subscribers]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListSubscribersPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def update_subscriber(
self,
request: Optional[
Union[data_subscription_service.UpdateSubscriberRequest, dict]
] = None,
*,
subscriber: Optional[data_subscription_service.Subscriber] = None,
update_mask: Optional[field_mask_pb2.FieldMask] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> operation.Operation:
r"""Updates the configuration of an existing subscriber, such as the
endpoint URI or the data types it's interested in.
**Endpoint Verification:** If the ``endpoint_uri`` or
``endpoint_authorization`` field is included in the
``update_mask``, the backend will re-verify the endpoint. The
verification process is the same as described in
``CreateSubscriber``:
1. **Verification with Authorization:** POST to the new or
existing ``endpoint_uri`` with the new or existing
``Authorization`` secret. Expects HTTP ``201 Created``.
2. **Verification without Authorization:** POST to the
``endpoint_uri`` without the ``Authorization`` header.
Expects HTTP ``401 Unauthorized`` or ``403 Forbidden``.
Both tests must pass using the potentially updated values for
the subscriber update to succeed. If verification fails, the
update will not be applied, and an error will be returned.
.. code-block:: python
# 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.devicesandservices import health_v4
def sample_update_subscriber():
# Create a client
client = health_v4.DataSubscriptionServiceClient()
# Initialize request argument(s)
subscriber = health_v4.Subscriber()
subscriber.endpoint_uri = "endpoint_uri_value"
subscriber.endpoint_authorization.secret = "secret_value"
request = health_v4.UpdateSubscriberRequest(
subscriber=subscriber,
)
# Make the request
operation = client.update_subscriber(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.devicesandservices.health_v4.types.UpdateSubscriberRequest, dict]):
The request object. Request message for UpdateSubscriber.
subscriber (google.devicesandservices.health_v4.types.Subscriber):
Required. The subscriber resource to update. Its 'name'
field is mapped to the URI, and the value of the 'name'
field should be of the form:
"projects/{project}/subscribers/{subscriber_id}". The
remaining fields of the Subscriber object represent the
new values for the corresponding fields in the existing
subscriber resource.
This corresponds to the ``subscriber`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Optional. A field mask that specifies which fields of
the Subscriber message are to be updated. This allows
for partial updates. Supported fields:
- endpoint_uri
- subscriber_configs
- endpoint_authorization
This corresponds to the ``update_mask`` 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, Union[str, bytes]]]): Key/value pairs which should be
sent along with the request as metadata. Normally, each value must be of type `str`,
but for metadata keys ending with the suffix `-bin`, the corresponding values must
be of type `bytes`.
Returns:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be
:class:`google.devicesandservices.health_v4.types.Subscriber`
-- Resource Messages -- A subscriber receives
notifications from Google Health API.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
flattened_params = [subscriber, update_mask]
has_flattened_params = (
len([param for param in flattened_params if param is not None]) > 0
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, data_subscription_service.UpdateSubscriberRequest):
request = data_subscription_service.UpdateSubscriberRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if subscriber is not None:
request.subscriber = subscriber
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.update_subscriber]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("subscriber.name", request.subscriber.name),)
),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
data_subscription_service.Subscriber,
metadata_type=data_subscription_service.UpdateSubscriberMetadata,
)
# Done; return the response.
return response
[docs] def delete_subscriber(
self,
request: Optional[
Union[data_subscription_service.DeleteSubscriberRequest, dict]
] = None,
*,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> operation.Operation:
r"""Deletes a subscriber registration. This will stop all
notifications to the subscriber's endpoint.
.. code-block:: python
# 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.devicesandservices import health_v4
def sample_delete_subscriber():
# Create a client
client = health_v4.DataSubscriptionServiceClient()
# Initialize request argument(s)
request = health_v4.DeleteSubscriberRequest(
name="name_value",
)
# Make the request
operation = client.delete_subscriber(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.devicesandservices.health_v4.types.DeleteSubscriberRequest, dict]):
The request object. Request message for DeleteSubscriber.
name (str):
Required. The name of the subscriber to delete. Format:
projects/{project}/subscribers/{subscriber} Example:
projects/my-project/subscribers/my-subscriber-123 The
{subscriber} ID is user-settable (4-36 characters,
matching /`a-z <[a-z0-9-]{2,34}[a-z0-9]>`__/) or
system-generated if not provided during creation.
This corresponds to the ``name`` 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, Union[str, bytes]]]): Key/value pairs which should be
sent along with the request as metadata. Normally, each value must be of type `str`,
but for metadata keys ending with the suffix `-bin`, the corresponding values must
be of type `bytes`.
Returns:
google.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated
empty messages in your APIs. A typical example is to
use it as the request or the response type of an API
method. For instance:
service Foo {
rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
flattened_params = [name]
has_flattened_params = (
len([param for param in flattened_params if param is not None]) > 0
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, data_subscription_service.DeleteSubscriberRequest):
request = data_subscription_service.DeleteSubscriberRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.delete_subscriber]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
empty_pb2.Empty,
metadata_type=data_subscription_service.DeleteSubscriberMetadata,
)
# Done; return the response.
return response
[docs] def create_subscription(
self,
request: Optional[
Union[data_subscription_service.CreateSubscriptionRequest, dict]
] = None,
*,
parent: Optional[str] = None,
subscription: Optional[
data_subscription_service.CreateSubscriptionPayload
] = None,
subscription_id: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> data_subscription_service.Subscription:
r"""Creates a subscription for a specific user to a specific
subscriber. This method requires the subscriber to have a
``SubscriptionCreatePolicy`` set to ``MANUAL`` for the given
data types.
.. code-block:: python
# 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.devicesandservices import health_v4
def sample_create_subscription():
# Create a client
client = health_v4.DataSubscriptionServiceClient()
# Initialize request argument(s)
subscription = health_v4.CreateSubscriptionPayload()
subscription.user = "user_value"
request = health_v4.CreateSubscriptionRequest(
parent="parent_value",
subscription=subscription,
)
# Make the request
response = client.create_subscription(request=request)
# Handle the response
print(response)
Args:
request (Union[google.devicesandservices.health_v4.types.CreateSubscriptionRequest, dict]):
The request object. Request message for
CreateSubscription.
parent (str):
Required. The parent subscriber. Format:
projects/{project}/subscribers/{subscriber} The
{subscriber} ID is user-settable (4-36 characters,
matching /`a-z <[a-z0-9-]{2,34}[a-z0-9]>`__/) if
provided during creation, or system-generated otherwise.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
subscription (google.devicesandservices.health_v4.types.CreateSubscriptionPayload):
Required. The subscription to create.
This corresponds to the ``subscription`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
subscription_id (str):
Optional. The {subscription_id} is user-settable (4-36
chars, matching /`a-z <[a-z0-9-]{2,34}[a-z0-9]>`__/) or
system-generated otherwise. If provided, the ID must be
unique within the parent subscriber.
This corresponds to the ``subscription_id`` 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, Union[str, bytes]]]): Key/value pairs which should be
sent along with the request as metadata. Normally, each value must be of type `str`,
but for metadata keys ending with the suffix `-bin`, the corresponding values must
be of type `bytes`.
Returns:
google.devicesandservices.health_v4.types.Subscription:
A subscription to a data collection
for a specific user, to be delivered to
a subscriber.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
flattened_params = [parent, subscription, subscription_id]
has_flattened_params = (
len([param for param in flattened_params if param is not None]) > 0
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, data_subscription_service.CreateSubscriptionRequest):
request = data_subscription_service.CreateSubscriptionRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if subscription is not None:
request.subscription = subscription
if subscription_id is not None:
request.subscription_id = subscription_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.create_subscription]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def list_subscriptions(
self,
request: Optional[
Union[data_subscription_service.ListSubscriptionsRequest, dict]
] = None,
*,
parent: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> pagers.ListSubscriptionsPager:
r"""Lists all active subscriptions for a given
subscriber. This can be filtered, for example, by user
or data type.
.. code-block:: python
# 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.devicesandservices import health_v4
def sample_list_subscriptions():
# Create a client
client = health_v4.DataSubscriptionServiceClient()
# Initialize request argument(s)
request = health_v4.ListSubscriptionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_subscriptions(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.devicesandservices.health_v4.types.ListSubscriptionsRequest, dict]):
The request object. Request message for
ListSubscriptions.
parent (str):
Required. The parent subscriber. Format:
projects/{project}/subscribers/{subscriber} The
{subscriber} ID is user-settable (4-36 characters,
matching /`a-z <[a-z0-9-]{2,34}[a-z0-9]>`__/) if
provided during creation, or system-generated otherwise.
This corresponds to the ``parent`` 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, Union[str, bytes]]]): Key/value pairs which should be
sent along with the request as metadata. Normally, each value must be of type `str`,
but for metadata keys ending with the suffix `-bin`, the corresponding values must
be of type `bytes`.
Returns:
google.devicesandservices.health_v4.services.data_subscription_service.pagers.ListSubscriptionsPager:
Response message for
ListSubscriptions.
Iterating over this object will yield
results and resolve additional pages
automatically.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
flattened_params = [parent]
has_flattened_params = (
len([param for param in flattened_params if param is not None]) > 0
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, data_subscription_service.ListSubscriptionsRequest):
request = data_subscription_service.ListSubscriptionsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_subscriptions]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListSubscriptionsPager(
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def update_subscription(
self,
request: Optional[
Union[data_subscription_service.UpdateSubscriptionRequest, dict]
] = None,
*,
subscription: Optional[data_subscription_service.Subscription] = None,
update_mask: Optional[field_mask_pb2.FieldMask] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> data_subscription_service.Subscription:
r"""Updates the data types for an existing user
subscription.
.. code-block:: python
# 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.devicesandservices import health_v4
def sample_update_subscription():
# Create a client
client = health_v4.DataSubscriptionServiceClient()
# Initialize request argument(s)
request = health_v4.UpdateSubscriptionRequest(
)
# Make the request
response = client.update_subscription(request=request)
# Handle the response
print(response)
Args:
request (Union[google.devicesandservices.health_v4.types.UpdateSubscriptionRequest, dict]):
The request object. Request message for
UpdateSubscription.
subscription (google.devicesandservices.health_v4.types.Subscription):
Required. The subscription to update. The subscription's
``name`` field is used to identify the subscription to
update. Format:
projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}
This corresponds to the ``subscription`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Optional. The list of fields to
update.
This corresponds to the ``update_mask`` 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, Union[str, bytes]]]): Key/value pairs which should be
sent along with the request as metadata. Normally, each value must be of type `str`,
but for metadata keys ending with the suffix `-bin`, the corresponding values must
be of type `bytes`.
Returns:
google.devicesandservices.health_v4.types.Subscription:
A subscription to a data collection
for a specific user, to be delivered to
a subscriber.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
flattened_params = [subscription, update_mask]
has_flattened_params = (
len([param for param in flattened_params if param is not None]) > 0
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, data_subscription_service.UpdateSubscriptionRequest):
request = data_subscription_service.UpdateSubscriptionRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if subscription is not None:
request.subscription = subscription
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.update_subscription]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("subscription.name", request.subscription.name),)
),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] def delete_subscription(
self,
request: Optional[
Union[data_subscription_service.DeleteSubscriptionRequest, dict]
] = None,
*,
name: Optional[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> None:
r"""Deletes a specific user subscription, stopping
notifications for this user to this subscriber.
.. code-block:: python
# 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.devicesandservices import health_v4
def sample_delete_subscription():
# Create a client
client = health_v4.DataSubscriptionServiceClient()
# Initialize request argument(s)
request = health_v4.DeleteSubscriptionRequest(
name="name_value",
)
# Make the request
client.delete_subscription(request=request)
Args:
request (Union[google.devicesandservices.health_v4.types.DeleteSubscriptionRequest, dict]):
The request object. Request message for
DeleteSubscription.
name (str):
Required. The resource name of the subscription to
delete. Format:
``projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}``
Example:
``projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456``
The {subscriber} ID is user-settable (4-36 characters,
matching /`a-z <[a-z0-9-]{2,34}[a-z0-9]>`__/) if
provided during creation, or system-generated otherwise.
The {subscription} ID is user-settable (4-36 characters,
matching /`a-z <[a-z0-9-]{2,34}[a-z0-9]>`__/) or
system-generated if not provided during creation.
This corresponds to the ``name`` 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, Union[str, bytes]]]): Key/value pairs which should be
sent along with the request as metadata. Normally, each value must be of type `str`,
but for metadata keys ending with the suffix `-bin`, the corresponding values must
be of type `bytes`.
"""
# Create or coerce a protobuf request object.
# - Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
flattened_params = [name]
has_flattened_params = (
len([param for param in flattened_params if param is not None]) > 0
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, data_subscription_service.DeleteSubscriptionRequest):
request = data_subscription_service.DeleteSubscriptionRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.delete_subscription]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Validate the universe domain.
self._validate_universe_domain()
# Send the request.
rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
def __enter__(self) -> "DataSubscriptionServiceClient":
return self
[docs] def __exit__(self, type, value, traceback):
"""Releases underlying transport's resources.
.. warning::
ONLY use as a context manager if the transport is NOT shared
with other clients! Exiting the with block will CLOSE the transport
and may cause errors in other clients!
"""
self.transport.close()
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=package_version.__version__
)
if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
__all__ = ("DataSubscriptionServiceClient",)
