Gcp/health

@swamp/gcp/healthv2026.10.23.1· AGPL-3.0-or-later(was none)· 8d agoBEHAVIORS

01README

Google Cloud health infrastructure models

02Release Notes

Updated: subscribers, subscribers_subscriptions, shl_r, users_datatypes_datapoints, users_paireddevices

03Behaviors5

shl_r.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
externalShlId	string	yes	Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q

fn get(identifier: string)

Get a r

Argument	Type	Required	Description
identifier	string	yes	The name of the r

fn sync(identifier?: string)

Sync r state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific r by name (e.g. one discovered by list)

Resources

state(infinite)— Message that represents an arbitrary HTTP body. It should only be used for pa...

subscribers.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
endpointAuthorization?	object	no	Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint.
endpointUri?	string	no	Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details.
subscriberConfigs?	array	no	Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case.
createTime?	string	no	Output only. The time at which the subscriber was created.
name?	string	no	Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. 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 (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef
state?	enum	no	Output only. The state of the subscriber.
updateTime?	string	no	Output only. The time at which the subscriber was last updated.
subscriberId?	string	no	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])/.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a subscribers

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a subscribers

Argument	Type	Required	Description
identifier	string	yes	The name of the subscribers

fn update(identifier?: string, waitForReady?: boolean)

Update subscribers attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific subscribers by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the subscribers

Argument	Type	Required	Description
identifier	string	yes	The name of the subscribers

fn sync(identifier?: string)

Sync subscribers state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific subscribers by name (e.g. one discovered by list)

fn list(pageSize?: number, maxPages?: number)

List subscribers resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of subscribers to return. The service may return fewer than this value. If unspecified, at most 50 subscribers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— -- Resource Messages -- A subscriber receives notifications from Google Healt...

subscribers_subscriptions.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
dataTypes?	array	no	Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
user?	string	no	Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
name?	string	no	Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) 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 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
subscriptionId?	string	no	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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a subscriptions

fn get(identifier: string)

Get a subscriptions

Argument	Type	Required	Description
identifier	string	yes	The name of the subscriptions

fn update(identifier?: string)

Update subscriptions attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific subscriptions by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the subscriptions

Argument	Type	Required	Description
identifier	string	yes	The name of the subscriptions

fn sync(identifier?: string)

Sync subscriptions state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific subscriptions by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, maxPages?: number)

List subscriptions resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields: - `user` - `data_type` The `user` identifier (e.g., `user1` in `users/user1`) refers to the public `health_user_id` Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")
pageSize?	number	no	Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A subscription to a data collection for a specific user, to be delivered to a...

users_datatypes_datapoints.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
activeEnergyBurned?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
activeMinutes?	object	no	Required. Number of whole minutes spent in activity.
activeZoneMinutes?	object	no	Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
activityLevel?	object	no	Required. Activity level type in the given time interval.
altitude?	object	no	Required. Altitude gain in millimeters over the observed interval. Must be in the range `[-1000000000, 1000000000]`.
basalEnergyBurned?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
bloodGlucose?	object	no	Required. Blood glucose level concentration in mg/dL. Must be in the range `[0, 900]`.
bodyFat?	object	no	Required. Body fat percentage. Must be in the range `[0, 100]`.
coreBodyTemperature?	object	no	Optional. The unique identifier of the core body temperature measurement.
dailyHeartRateVariability?	object	no	Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
dailyHeartRateZones?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
dailyOxygenSaturation?	object	no	Required. The average value of the oxygen saturation samples during the sleep. Must be in the range `[0, 100]`.
dailyRespiratoryRate?	object	no	Required. The average number of breaths taken per minute.
dailyRestingHeartRate?	object	no	Required. The resting heart rate value in beats per minute.
dailySleepTemperatureDerivations?	object	no	Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
dailyVo2Max?	object	no	Optional. Represents the user's cardio fitness level based on their VO2 max.
dataSource?	object	no	Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.
distance?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
electrocardiogram?	object	no	Optional. Average heart rate recorded during ECG reading in beats per minute.
exercise?	object	no	Optional. Duration excluding pauses.
floors?	object	no	Required. Number of floors in the recorded interval. Must be in the range `[0, 1000000]`.
food?	object	no	Required. The access level of the food.
foodMeasurementUnit?	object	no	Required. The display name of the food measurement unit (e.g., "gram", "piece").
heartRate?	object	no	Required. The heart rate value in beats per minute. Must be in the range `[1, 300]`.
heartRateVariability?	object	no	Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz).
height?	object	no	Required. Height of the user in millimeters. Must be in the range `[0, 3000]`.
hydrationLog?	object	no	Required. Value representing the volume in milliliters. Must be in the range `[0, 100000]`.
irregularRhythmNotification?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
menstrualPeriod?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
moods?	object	no	Required. The moods logged.
name?	string	no	Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` ## Examples: ## `users/me/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` `users/1234567890/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` can be either the alias `me` or the authenticated user's numeric Health User ID, which can be retrieved by calling GetIdentity (see Identity.health_user_id). The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.
nutritionLog?	object	no	Required. The energy value in kilocalories. Must be in the range `[0, 100000]`.
ovulationTest?	object	no	Required. The result of the ovulation test.
oxygenSaturation?	object	no	Required. The oxygen saturation percentage. Must be in the range `[0, 100]`.
respiratoryRateSleepSummary?	object	no	Required. Average breaths per minute.
runVo2Max?	object	no	Required. Run VO2 max value in ml/kg/min. Must be in the range `[0, 100]`.
sedentaryPeriod?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
sleep?	object	no	Output only. Creation time of this sleep observation.
steps?	object	no	Required. Number of steps in the recorded interval. Must be in the range `[0, 1000000]`.
swimLengthsData?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
symptoms?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
timeInHeartRateZone?	object	no	Required. Heart rate zone type.
vo2Max?	object	no	Optional. The method used to measure the VO2 max value.
weight?	object	no	Optional. Standard free-form notes captured at manual logging.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a dataPoints

fn get(identifier: string)

Get a dataPoints

Argument	Type	Required	Description
identifier	string	yes	The name of the dataPoints

fn update(identifier?: string)

Update dataPoints attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific dataPoints by name (e.g. one discovered by list)

fn sync(identifier?: string)

Sync dataPoints state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific dataPoints by name (e.g. one discovered by list)

fn list(dataSourceFamily?: string, filter?: string, pageSize?: number, maxPages?: number)

List dataPoints resources

Argument	Type	Required	Description
dataSourceFamily?	string	no	Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/{user}/dataSourceFamilies/{data_source_family}` The `{user}` can be either the alias `me` or the authenticated user's numeric Health User ID, retrieved via GetIdentity (e.g. `users/me/dataSourceFamilies/...` or `users/1234567890/dataSourceFamilies/...`). The supported values are: - `users/{user}/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/{user}/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/{user}/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/{user}/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data types may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. Filtering by data source family is not supported for the `sleep`, `food` and `food-measurement-unit` data types, because the underlying listing implementation cannot restrict results by data source. Such requests fail with `INVALID_ARGUMENT` when the data source family is set explicitly, and with `PERMISSION_DENIED` when the restriction is only implied by the caller's scopes. For `sleep`, use ReconcileDataPoints instead.
filter?	string	no	Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (Excluding Sleep and ECG): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session start time (ECG specific): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (Sleep specific): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (Sleep specific): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order.
pageSize?	number	no	Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_delete(names?: any)

batch delete

Argument	Type	Required	Description
names?	any	no

fn daily_roll_up(dataSourceFamily?: any, pageSize?: any, pageToken?: any, range?: any, windowSizeDays?: any)

daily roll up

Argument	Type	Required
dataSourceFamily?	any	no
pageSize?	any	no
pageToken?	any	no
range?	any	no
windowSizeDays?	any	no

fn export_exercise_tcx(partialData?: any)

export exercise tcx

Argument	Type	Required	Description
partialData?	any	no

fn reconcile(dataSourceFamily?: any, filter?: any, pageSize?: any, pageToken?: any)

reconcile

Argument	Type	Required
dataSourceFamily?	any	no
filter?	any	no
pageSize?	any	no
pageToken?	any	no

fn roll_up(dataSourceFamily?: any, pageSize?: any, pageToken?: any, range?: any, windowSize?: any)

roll up

Argument	Type	Required
dataSourceFamily?	any	no
pageSize?	any	no
pageToken?	any	no
range?	any	no
windowSize?	any	no

Resources

state(infinite)— A computed or recorded metric.

users_paireddevices.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a pairedDevices

Argument	Type	Required	Description
identifier	string	yes	The name of the pairedDevices

fn sync(identifier?: string)

Sync pairedDevices state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific pairedDevices by name (e.g. one discovered by list)

fn list(pageSize?: number, maxPages?: number)

List pairedDevices resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of devices to return. The service may return fewer than this value. If unspecified, at most 5 devices will be returned. The maximum value is 100. values above 100 will be coerced to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— User's Paired 1P Device The PairedDevice details include information about th...

04Previous Versions19

2026.10.13.1Oct 13, 2026

Updated: subscribers, subscribers_subscriptions, shl_r, users_datatypes_datapoints, users_paireddevices

2026.10.09.1Oct 10, 2026

Updated: users_datatypes_datapoints

2026.10.06.1Oct 6, 2026

Updated: subscribers, subscribers_subscriptions

2026.09.29.1Sep 29, 2026

Updated: users_datatypes_datapoints

2026.09.25.1Sep 25, 2026

Updated: users_datatypes_datapoints

Modified 1 behaviors

2026.09.09.1Sep 9, 2026

Updated: users_datatypes_datapoints

2026.09.07.1Sep 8, 2026

Updated: users_datatypes_datapoints

2026.08.19.1Aug 19, 2026

Updated: users_datatypes_datapoints

2026.08.12.2Aug 12, 2026

Updated: subscribers, subscribers_subscriptions, shl_r, users_datatypes_datapoints, users_paireddevices

2026.08.06.1Aug 6, 2026

Updated: users_datatypes_datapoints

2026.08.03.1Aug 3, 2026

Updated: users_datatypes_datapoints

2026.07.29.2Jul 30, 2026

Updated: subscribers, subscribers_subscriptions, shl_r, users_datatypes_datapoints, users_paireddevices

2026.07.29.1Jul 29, 2026

Updated: users_datatypes_datapoints

2026.07.21.4Jul 21, 2026

Added: subscribers, subscribers_subscriptions, shl_r, users_paireddevices
Updated: users_datatypes_datapoints

2026.07.21.1Jul 21, 2026

Updated: subscribers, users_datatypes_datapoints

2026.07.20.2Jul 20, 2026

Added: subscribers, subscribers_subscriptions, shl_r, users_paireddevices
Updated: users_datatypes_datapoints

Modified 1 behaviors

2026.07.20.1Jul 20, 2026

Updated: users_datatypes_datapoints

Modified 1 behaviors

2026.07.19.2Jul 19, 2026

Updated: shl_r

2026.07.19.1Jul 19, 2026

Updated: subscribers, subscribers_subscriptions, shl_r, users_datatypes_datapoints, users_paireddevices

05Stats

100 / 100

Downloads

Archive size

132.4 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#gcp #google-cloud #health #cloud #infrastructure