Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1336200169.6 KB
projects

Updates a discovery client.

patch/v1/{+name}

Path parameters

namestring required

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

Query parameters

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

updateMaskstring

Required. Update mask is used to specify the fields to be overwritten in the DiscoveryClient resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

Request body

updateTimestring google-datetime

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 heartbeat_time field.

displayNamestring

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

serviceAccountstring

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

heartbeatTimestring google-datetime

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

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'OFFLINE' | 'DEGRADED' | 'EXPIRED'

Output only. Current state of the discovery client.

createTimestring google-datetime

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

signalsEndpointstring

Output only. This field is intended for internal use.

sourcestring

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

descriptionstring

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

ttlstring google-duration

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 expire_time field.

namestring

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

versionstring

Output only. Client version, as reported in recent heartbeat.

expireTimestring google-datetime

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

labelsobject

Optional. Labels as key value pairs.

Response

Successful response