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.

HealthProfileService¶

class google.devicesandservices.health_v4.services.health_profile_service.HealthProfileServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.devicesandservices.health_v4.services.health_profile_service.transports.base.HealthProfileServiceTransport, typing.Callable[[...], google.devicesandservices.health_v4.services.health_profile_service.transports.base.HealthProfileServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Health Profile Service

Instantiates the health profile service async client.

Parameters

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,HealthProfileServiceTransport,Callable[..., HealthProfileServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the HealthProfileServiceTransport 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 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.

property api_endpoint: str¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

HealthProfileServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

HealthProfileServiceAsyncClient

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

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

Parameters

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

The constructed client.

Return type

HealthProfileServiceAsyncClient

async get_identity(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetIdentityRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Identity[source]¶

Gets the user’s identity.

It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.

# 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

async def sample_get_identity():
    # Create a client
    client = health_v4.HealthProfileServiceAsyncClient()

    # Initialize request argument(s)
    request = health_v4.GetIdentityRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_identity(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.devicesandservices.health_v4.types.GetIdentityRequest, dict]]) – The request object. Request message for getting Identity details.
name (str) –
Required. The resource name of the Identity. Format: users/me/identity

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Represents details about the Google user’s identity.

Return type

google.devicesandservices.health_v4.types.Identity

async get_irn_profile(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetIrnProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.IrnProfile[source]¶

Returns user’s IRN Profile details.

# 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

async def sample_get_irn_profile():
    # Create a client
    client = health_v4.HealthProfileServiceAsyncClient()

    # Initialize request argument(s)
    request = health_v4.GetIrnProfileRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_irn_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.devicesandservices.health_v4.types.GetIrnProfileRequest, dict]]) – The request object. Request message for getting IRN Profile details.
name (str) –
Required. The resource name of the IRN Profile. Format: users/{user}/irnProfile Example: users/1234567890/irnProfile or users/me/irnProfile The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal me can also be used to refer to the authenticated user.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Irregular Rhythm Notifications (IRN) Profile details. The Irregular Rhythm Notifications (IRN) feature checks for signs of atrial fibrillation (AFib). The IrnProfile details include information about the user’s onboarding status, enrollment status, and the last update time of analyzable data for this feature.

Return type

google.devicesandservices.health_v4.types.IrnProfile

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_paired_device(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetPairedDeviceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.PairedDevice[source]¶

Returns user’s Device.

# 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

async def sample_get_paired_device():
    # Create a client
    client = health_v4.HealthProfileServiceAsyncClient()

    # Initialize request argument(s)
    request = health_v4.GetPairedDeviceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_paired_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.devicesandservices.health_v4.types.GetPairedDeviceRequest, dict]]) – The request object. Request message for getting a Device.
name (str) –
Required. The name of the device to retrieve. Format: users/{user}/devices/{device}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

User’s Paired 1P Device

The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.

Return type

google.devicesandservices.health_v4.types.PairedDevice

async get_profile(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Profile[source]¶

Returns user Profile details.

# 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

async def sample_get_profile():
    # Create a client
    client = health_v4.HealthProfileServiceAsyncClient()

    # Initialize request argument(s)
    request = health_v4.GetProfileRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.devicesandservices.health_v4.types.GetProfileRequest, dict]]) – The request object. Request message for getting Profile details.
name (str) –
Required. The name of the Profile. Format: users/me/profile.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Profile details.

Return type

google.devicesandservices.health_v4.types.Profile

async get_settings(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Settings[source]¶

Returns user settings details.

# 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

async def sample_get_settings():
    # Create a client
    client = health_v4.HealthProfileServiceAsyncClient()

    # Initialize request argument(s)
    request = health_v4.GetSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_settings(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.devicesandservices.health_v4.types.GetSettingsRequest, dict]]) – The request object. Request message for getting Settings details.
name (str) –
Required. The name of the Settings. Format: users/me/settings.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Settings details.

Return type

google.devicesandservices.health_v4.types.Settings

classmethod get_transport_class(label: Optional[str] = None) → Type[google.devicesandservices.health_v4.services.health_profile_service.transports.base.HealthProfileServiceTransport]¶

Returns an appropriate transport class.

Parameters: 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.

static identity_path(user: str) → str¶: Returns a fully-qualified identity string.

static irn_profile_path(user: str) → str¶: Returns a fully-qualified irn_profile string.

async list_paired_devices(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.ListPairedDevicesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.services.health_profile_service.pagers.ListPairedDevicesAsyncPager[source]¶

Returns the user’s list of paired 1P trackers and smartwatches.

# 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

async def sample_list_paired_devices():
    # Create a client
    client = health_v4.HealthProfileServiceAsyncClient()

    # Initialize request argument(s)
    request = health_v4.ListPairedDevicesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.devicesandservices.health_v4.types.ListPairedDevicesRequest, dict]]) – The request object. Request message for listing Devices.
parent (str) –
Required. The parent, which owns this collection of devices. Format: users/{user}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListPairedDevices. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.devicesandservices.health_v4.services.health_profile_service.pagers.ListPairedDevicesAsyncPager

static paired_device_path(user: str, paired_device: str) → str¶: Returns a fully-qualified paired_device string.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_identity_path(path: str) → Dict[str, str]¶: Parses a identity path into its component segments.

static parse_irn_profile_path(path: str) → Dict[str, str]¶: Parses a irn_profile path into its component segments.

static parse_paired_device_path(path: str) → Dict[str, str]¶: Parses a paired_device path into its component segments.

static parse_profile_path(path: str) → Dict[str, str]¶: Parses a profile path into its component segments.

static parse_settings_path(path: str) → Dict[str, str]¶: Parses a settings path into its component segments.

static profile_path(user: str) → str¶: Returns a fully-qualified profile string.

static settings_path(user: str) → str¶: Returns a fully-qualified settings string.

property transport: google.devicesandservices.health_v4.services.health_profile_service.transports.base.HealthProfileServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: HealthProfileServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_profile(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.UpdateProfileRequest, dict]] = None, *, profile: Optional[google.devicesandservices.health_v4.types.health_profile.Profile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Profile[source]¶

Updates the user’s profile details.

# 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

async def sample_update_profile():
    # Create a client
    client = health_v4.HealthProfileServiceAsyncClient()

    # Initialize request argument(s)
    request = health_v4.UpdateProfileRequest(
    )

    # Make the request
    response = await client.update_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.devicesandservices.health_v4.types.UpdateProfileRequest, dict]]) – The request object. Request message for updating Profile details.
profile (google.devicesandservices.health_v4.types.Profile) – Required. Profile details. This corresponds to the profile 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 be updated.

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_async.AsyncRetry) – 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

Profile details.

Return type

google.devicesandservices.health_v4.types.Profile

async update_settings(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.UpdateSettingsRequest, dict]] = None, *, settings: Optional[google.devicesandservices.health_v4.types.health_profile.Settings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Settings[source]¶

Updates the user’s settings details.

# 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

async def sample_update_settings():
    # Create a client
    client = health_v4.HealthProfileServiceAsyncClient()

    # Initialize request argument(s)
    request = health_v4.UpdateSettingsRequest(
    )

    # Make the request
    response = await client.update_settings(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.devicesandservices.health_v4.types.UpdateSettingsRequest, dict]]) – The request object. Request message for updating Settings details.
settings (google.devicesandservices.health_v4.types.Settings) – Required. Settings details This corresponds to the settings 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 be updated.

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_async.AsyncRetry) – 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

Settings details.

Return type

google.devicesandservices.health_v4.types.Settings

class google.devicesandservices.health_v4.services.health_profile_service.HealthProfileServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.devicesandservices.health_v4.services.health_profile_service.transports.base.HealthProfileServiceTransport, typing.Callable[[...], google.devicesandservices.health_v4.services.health_profile_service.transports.base.HealthProfileServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Health Profile Service

Instantiates the health profile service client.

Parameters

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,HealthProfileServiceTransport,Callable[..., HealthProfileServiceTransport]]]) – 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 HealthProfileServiceTransport 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.

__exit__(type, value, traceback)[source]¶: 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!

property api_endpoint: str¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

HealthProfileServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

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

The constructed client.

Return type

HealthProfileServiceClient

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

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

Parameters

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

The constructed client.

Return type

HealthProfileServiceClient

get_identity(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetIdentityRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Identity[source]¶

Gets the user’s identity.

It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.

# 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_get_identity():
    # Create a client
    client = health_v4.HealthProfileServiceClient()

    # Initialize request argument(s)
    request = health_v4.GetIdentityRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.devicesandservices.health_v4.types.GetIdentityRequest, dict]) – The request object. Request message for getting Identity details.
name (str) –
Required. The resource name of the Identity. Format: users/me/identity

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

Represents details about the Google user’s identity.

Return type

google.devicesandservices.health_v4.types.Identity

get_irn_profile(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetIrnProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.IrnProfile[source]¶

Returns user’s IRN Profile details.

# 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_get_irn_profile():
    # Create a client
    client = health_v4.HealthProfileServiceClient()

    # Initialize request argument(s)
    request = health_v4.GetIrnProfileRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.devicesandservices.health_v4.types.GetIrnProfileRequest, dict]) – The request object. Request message for getting IRN Profile details.
name (str) –
Required. The resource name of the IRN Profile. Format: users/{user}/irnProfile Example: users/1234567890/irnProfile or users/me/irnProfile The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal me can also be used to refer to the authenticated user.

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

Irregular Rhythm Notifications (IRN) Profile details. The Irregular Rhythm Notifications (IRN) feature checks for signs of atrial fibrillation (AFib). The IrnProfile details include information about the user’s onboarding status, enrollment status, and the last update time of analyzable data for this feature.

Return type

google.devicesandservices.health_v4.types.IrnProfile

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_paired_device(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetPairedDeviceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.PairedDevice[source]¶

Returns user’s Device.

# 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_get_paired_device():
    # Create a client
    client = health_v4.HealthProfileServiceClient()

    # Initialize request argument(s)
    request = health_v4.GetPairedDeviceRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.devicesandservices.health_v4.types.GetPairedDeviceRequest, dict]) – The request object. Request message for getting a Device.
name (str) –
Required. The name of the device to retrieve. Format: users/{user}/devices/{device}

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

User’s Paired 1P Device

The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.

Return type

google.devicesandservices.health_v4.types.PairedDevice

get_profile(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Profile[source]¶

Returns user Profile details.

# 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_get_profile():
    # Create a client
    client = health_v4.HealthProfileServiceClient()

    # Initialize request argument(s)
    request = health_v4.GetProfileRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.devicesandservices.health_v4.types.GetProfileRequest, dict]) – The request object. Request message for getting Profile details.
name (str) –
Required. The name of the Profile. Format: users/me/profile.

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

Profile details.

Return type

google.devicesandservices.health_v4.types.Profile

get_settings(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.GetSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Settings[source]¶

Returns user settings details.

# 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_get_settings():
    # Create a client
    client = health_v4.HealthProfileServiceClient()

    # Initialize request argument(s)
    request = health_v4.GetSettingsRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.devicesandservices.health_v4.types.GetSettingsRequest, dict]) – The request object. Request message for getting Settings details.
name (str) –
Required. The name of the Settings. Format: users/me/settings.

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

Settings details.

Return type

google.devicesandservices.health_v4.types.Settings

static identity_path(user: str) → str[source]¶: Returns a fully-qualified identity string.

static irn_profile_path(user: str) → str[source]¶: Returns a fully-qualified irn_profile string.

list_paired_devices(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.ListPairedDevicesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.services.health_profile_service.pagers.ListPairedDevicesPager[source]¶

Returns the user’s list of paired 1P trackers and smartwatches.

# 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_paired_devices():
    # Create a client
    client = health_v4.HealthProfileServiceClient()

    # Initialize request argument(s)
    request = health_v4.ListPairedDevicesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.devicesandservices.health_v4.types.ListPairedDevicesRequest, dict]) – The request object. Request message for listing Devices.
parent (str) –
Required. The parent, which owns this collection of devices. Format: users/{user}

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

Response message for ListPairedDevices. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.devicesandservices.health_v4.services.health_profile_service.pagers.ListPairedDevicesPager

static paired_device_path(user: str, paired_device: str) → str[source]¶: Returns a fully-qualified paired_device string.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_identity_path(path: str) → Dict[str, str][source]¶: Parses a identity path into its component segments.

static parse_irn_profile_path(path: str) → Dict[str, str][source]¶: Parses a irn_profile path into its component segments.

static parse_paired_device_path(path: str) → Dict[str, str][source]¶: Parses a paired_device path into its component segments.

static parse_profile_path(path: str) → Dict[str, str][source]¶: Parses a profile path into its component segments.

static parse_settings_path(path: str) → Dict[str, str][source]¶: Parses a settings path into its component segments.

static profile_path(user: str) → str[source]¶: Returns a fully-qualified profile string.

static settings_path(user: str) → str[source]¶: Returns a fully-qualified settings string.

property transport: google.devicesandservices.health_v4.services.health_profile_service.transports.base.HealthProfileServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

HealthProfileServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_profile(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.UpdateProfileRequest, dict]] = None, *, profile: Optional[google.devicesandservices.health_v4.types.health_profile.Profile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Profile[source]¶

Updates the user’s profile details.

# 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_profile():
    # Create a client
    client = health_v4.HealthProfileServiceClient()

    # Initialize request argument(s)
    request = health_v4.UpdateProfileRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.devicesandservices.health_v4.types.UpdateProfileRequest, dict]) – The request object. Request message for updating Profile details.
profile (google.devicesandservices.health_v4.types.Profile) – Required. Profile details. This corresponds to the profile 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 be updated.

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

Profile details.

Return type

google.devicesandservices.health_v4.types.Profile

update_settings(request: Optional[Union[google.devicesandservices.health_v4.types.health_profile.UpdateSettingsRequest, dict]] = None, *, settings: Optional[google.devicesandservices.health_v4.types.health_profile.Settings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) → google.devicesandservices.health_v4.types.health_profile.Settings[source]¶

Updates the user’s settings details.

# 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_settings():
    # Create a client
    client = health_v4.HealthProfileServiceClient()

    # Initialize request argument(s)
    request = health_v4.UpdateSettingsRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.devicesandservices.health_v4.types.UpdateSettingsRequest, dict]) – The request object. Request message for updating Settings details.
settings (google.devicesandservices.health_v4.types.Settings) – Required. Settings details This corresponds to the settings 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 be updated.

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

Settings details.

Return type

google.devicesandservices.health_v4.types.Settings

class google.devicesandservices.health_v4.services.health_profile_service.pagers.ListPairedDevicesAsyncPager(method: Callable[[...], Awaitable[google.devicesandservices.health_v4.types.health_profile.ListPairedDevicesResponse]], request: google.devicesandservices.health_v4.types.health_profile.ListPairedDevicesRequest, response: google.devicesandservices.health_v4.types.health_profile.ListPairedDevicesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶

A pager for iterating through list_paired_devices requests.

This class thinly wraps an initial google.devicesandservices.health_v4.types.ListPairedDevicesResponse object, and provides an __aiter__ method to iterate through its paired_devices field.

If there are more pages, the __aiter__ method will make additional ListPairedDevices requests and continue to iterate through the paired_devices field on the corresponding responses.

All the usual google.devicesandservices.health_v4.types.ListPairedDevicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.devicesandservices.health_v4.types.ListPairedDevicesRequest) – The initial request object.
response (google.devicesandservices.health_v4.types.ListPairedDevicesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.devicesandservices.health_v4.services.health_profile_service.pagers.ListPairedDevicesPager(method: Callable[[...], google.devicesandservices.health_v4.types.health_profile.ListPairedDevicesResponse], request: google.devicesandservices.health_v4.types.health_profile.ListPairedDevicesRequest, response: google.devicesandservices.health_v4.types.health_profile.ListPairedDevicesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶

A pager for iterating through list_paired_devices requests.

This class thinly wraps an initial google.devicesandservices.health_v4.types.ListPairedDevicesResponse object, and provides an __iter__ method to iterate through its paired_devices field.

If there are more pages, the __iter__ method will make additional ListPairedDevices requests and continue to iterate through the paired_devices field on the corresponding responses.

All the usual google.devicesandservices.health_v4.types.ListPairedDevicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.devicesandservices.health_v4.types.ListPairedDevicesRequest) – The initial request object.
response (google.devicesandservices.health_v4.types.ListPairedDevicesResponse) – The initial response object.
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.

HealthProfileService¶

google-devicesandservices-health

Navigation

Related Topics