Subscriber

-- Resource Messages -- A subscriber receives notifications from Google Health API.

JSON representation
{
  "name": string,
  "endpointUri": string,
  "createTime": string,
  "updateTime": string,
  "subscriberConfigs": [
    {
      object (SubscriberConfig)
    }
  ],
  "endpointAuthorization": {
    object (EndpointAuthorization)
  },
  "state": enum (Subscriber.State)
}
Fields
name

string

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/) 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

endpointUri

string

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.

createTime

string (Timestamp format)

Output only. The time at which the subscriber was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time at which the subscriber was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

subscriberConfigs[]

object (SubscriberConfig)

Optional. Configuration for the subscriber.

endpointAuthorization

object (EndpointAuthorization)

Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified.

state

enum (Subscriber.State)

Output only. The state of the subscriber.

Subscriber.State

The state of the subscriber.

Enums
STATE_UNSPECIFIED Represents an unspecified subscriber state.
UNVERIFIED Represents an unverified subscriber. This is the initial state of the subscriber when it is created. The backend will verify the subscriber's endpointUri.
ACTIVE Represents an active subscriber. The endpoint has been verified.
INACTIVE Represents an inactive subscriber.