v1

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

Updates the parameters of a single Collector.

patch/v1/{+name}

Path parameters

namestring required

name of resource.

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. Field mask is used to specify the fields to be overwritten in the Collector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Request body

namestring

name of resource.

collectionDaysinteger

How many days to collect data.

updateTimestring google-datetime

Output only. Update time stamp.

descriptionstring

User specified description of the Collector.

clientVersionstring

Output only. Client version.

eulaUristring

Uri for EULA (End User License Agreement) from customer.

labelsobject

Labels as key value pairs.

createTimestring google-datetime

Output only. Create time stamp.

serviceAccountstring

Service Account email used to ingest data to this Collector.

state'STATE_UNSPECIFIED' | 'STATE_INITIALIZING' | 'STATE_READY_TO_USE' | 'STATE_REGISTERED' | 'STATE_ACTIVE' | 'STATE_PAUSED' | 'STATE_DELETING' | 'STATE_DECOMMISSIONED' | 'STATE_ERROR'

Output only. State of the Collector.

expectedAssetCountstring int64

User specified expected asset count.

bucketstring

Output only. Store cloud storage bucket name (which is a guid) created with this Collector.

displayNamestring

User specified name of the Collector.

Response

Successful response