# The Endpoint object

## Attributes

- `name` (string)
  Output only. The full resource path of the endpoint.
   Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- `uid` (string)
  System-generated unique ID for the endpoint.
- `parent` (string)
  The branch containing this endpoint (API resource hierarchy).
   Format: projects/{project_id}/branches/{branch_id}
- `create_time` (string)
  A timestamp indicating when the compute endpoint was created.
- `update_time` (string)
  A timestamp indicating when the compute endpoint was last updated.
- `spec` (object)
  The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state.
  - `endpoint_type` (string)
    The endpoint type. A branch can only have one READ_WRITE endpoint.
    Possible values: `ENDPOINT_TYPE_UNSPECIFIED`, `ENDPOINT_TYPE_READ_WRITE`, `ENDPOINT_TYPE_READ_ONLY`
  - `autoscaling_limit_min_cu` (double)
    The minimum number of Compute Units. Minimum value is 0.5.
  - `autoscaling_limit_max_cu` (double)
    The maximum number of Compute Units. The maximum value is 64.
     The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
  - `disabled` (boolean)
    Whether to restrict connections to the compute endpoint.
     Enabling this option schedules a suspend compute operation.
     A disabled compute endpoint cannot be enabled by a connection or
     console action.
  - `suspend_timeout_duration` (string)
    Duration of inactivity after which the compute endpoint is automatically suspended.
     If specified should be between 60s and 604800s (1 minute to 1 week).
     Mutually exclusive with `no_suspension`. When updating, use `spec.suspension` in the update_mask.
  - `no_suspension` (boolean)
    When set to true, explicitly disables automatic suspension (never suspend).
     Should be set to true when provided.
     Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.suspension` in the update_mask.
  - `settings` (object)
    - `pg_settings` (object)
      A raw representation of Postgres settings.
  - `group` (object)
    Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults
     to non HA settings, with a single compute backing the endpoint (and no readable secondaries
     for Read/Write endpoints).
    - `min` (int32)
      The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
       than or equal to 1.
    - `max` (int32)
      The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
       compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
       true on the EndpointSpec.
    - `enable_readable_secondaries` (boolean)
      Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where
       size.max > 1.
- `status` (object)
  Current operational status of the compute endpoint.
  - `endpoint_type` (string)
    The endpoint type. A branch can only have one READ_WRITE endpoint.
    Possible values: `ENDPOINT_TYPE_UNSPECIFIED`, `ENDPOINT_TYPE_READ_WRITE`, `ENDPOINT_TYPE_READ_ONLY`
  - `hosts` (object)
    Contains host information for connecting to the endpoint.
    - `host` (string)
      The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects
       to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations.
    - `read_only_host` (string)
      An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,
       this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined
       if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled.
    - `read_write_pooled_host` (string)
      The read-write hostname of the compute endpoint, with pooling. This attribute is only defined for read-write endpoints.
    - `read_only_pooled_host` (string)
      The read-only hostname of the compute endpoint, with pooling. This attribute is always defined for read-only endpoints,
       and may be defined for read-write endpoints if configured with read replicas and allow read-only connections.
  - `last_active_time` (string)
    A timestamp indicating when the compute endpoint was last active.
  - `autoscaling_limit_min_cu` (double)
    The minimum number of Compute Units.
  - `autoscaling_limit_max_cu` (double)
    The maximum number of Compute Units. The maximum value is 64.
     The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
  - `current_state` (string)
    Possible values: `STATE_UNSPECIFIED`, `INIT`, `ACTIVE`, `IDLE`, `DEGRADED`
  - `pending_state` (string)
    Possible values: `STATE_UNSPECIFIED`, `INIT`, `ACTIVE`, `IDLE`, `DEGRADED`
  - `disabled` (boolean)
    Whether to restrict connections to the compute endpoint.
     Enabling this option schedules a suspend compute operation.
     A disabled compute endpoint cannot be enabled by a connection or
     console action.
  - `suspend_timeout_duration` (string)
    Duration of inactivity after which the compute endpoint is automatically suspended.
  - `settings` (object)
    - `pg_settings` (object)
      A raw representation of Postgres settings.
  - `group` (object)
    Details on the HA configuration of the endpoint.
    - `min` (int32)
      The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
       than or equal to 1.
    - `max` (int32)
      The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
       compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
       true on the EndpointSpec.
    - `enable_readable_secondaries` (boolean)
      Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured
       by specifying size.max > 1.
  - `endpoint_id` (string)
    Part of the resource name.
- `endpoint_id` (string)
  The part of the name, chosen by the user when the resource was created.

## Example

```json
{
  "name": "string",
  "uid": "string",
  "parent": "string",
  "create_time": "string",
  "update_time": "string",
  "spec": {
    "endpoint_type": "string",
    "autoscaling_limit_min_cu": 0,
    "autoscaling_limit_max_cu": 0,
    "disabled": true,
    "suspend_timeout_duration": "string",
    "no_suspension": true,
    "settings": {},
    "group": {}
  },
  "status": {
    "endpoint_type": "string",
    "hosts": {},
    "last_active_time": "string",
    "autoscaling_limit_min_cu": 0,
    "autoscaling_limit_max_cu": 0,
    "current_state": "string",
    "pending_state": "string",
    "disabled": true,
    "suspend_timeout_duration": "string",
    "settings": {},
    "group": {},
    "endpoint_id": "string"
  },
  "endpoint_id": "string"
}
```


