REST Resource: projects.locations.discoveryClients

Resource: DiscoveryClient

Represents an installed Migration Center Discovery Client instance.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "source": string,
  "serviceAccount": string,
  "signalsEndpoint": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "version": string,
  "errors": [
    {
      object (Status)
    }
  ],
  "heartbeatTime": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
Fields
name

string

Output only. Identifier. Full name of this discovery client.
createTime

string (Timestamp format)

Output only. Time when the discovery client was first created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Time when the discovery client was last updated. This value is not updated by heartbeats, to view the last heartbeat time please refer to the heartbeatTime field.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
source

string

Required. Immutable. Full name of the source object associated with this discovery client.
serviceAccount

string

Required. Service account used by the discovery client for various operation.
signalsEndpoint

string

Output only. This field is intended for internal use.
displayName

string

Optional. Free text display name. Maximum length is 63 characters.
description

string

Optional. Free text description. Maximum length is 1000 characters.
labels

map (key: string, value: string)

Optional. Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Output only. Current state of the discovery client.
version

string

Output only. Client version, as reported in recent heartbeat.
errors[]

object (Status)

Output only. Errors affecting client functionality.
heartbeatTime

string (Timestamp format)

Output only. Last heartbeat time. Healthy clients are expected to send heartbeats regularly (normally every few minutes).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Union field expiration.

expiration can be only one of the following:
expireTime

string (Timestamp format)

Optional. Client expiration time in UTC. If specified, the backend will not accept new frames after this time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

Optional. Input only. Client time-to-live. If specified, the backend will not accept new frames after this time. This field is input only. The derived expiration time is provided as output through the expireTime field.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

State

Discovery client states.

Enums
STATE_UNSPECIFIED Client state is unspecified.
ACTIVE Client is active.
OFFLINE Client is offline.
DEGRADED Client is in a degraded state. See the errors field for details.
EXPIRED Client has expired. See the expireTime field for the expire time.

Methods

create

 Creates a new discovery client.

delete

 Deletes a discovery client.

get

 Gets the details of a discovery client.

list

 Lists all the discovery clients in a given project and location.

patch

 Updates a discovery client.

sendHeartbeat

 Sends a discovery client heartbeat.