REST Resource: projects.locations.collectors

Stay organized with collections Save and categorize content based on your preferences.

Resource: Collector

Message describing Collector object.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "description": string,
  "serviceAccount": string,
  "bucket": string,
  "expectedAssetCount": string,
  "state": enum (State),
  "clientVersion": string,
  "guestOsScan": {
    object (GuestOsScan)
  },
  "vsphereScan": {
    object (VSphereScan)
  },
  "collectionDays": integer,
  "eulaUri": string
}
Fields
name

string

name of resource.

createTime

string (Timestamp format)

Output only. Create time stamp.

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. Update time stamp.

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".

labels

map (key: string, value: string)

Labels as key value pairs.

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

displayName

string

User specified name of the Collector.

description

string

User specified description of the Collector.

serviceAccount

string

Service Account email used to ingest data to this Collector.

bucket

string

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

expectedAssetCount

string (int64 format)

User specified expected asset count.

state

enum (State)

Output only. State of the Collector.

clientVersion

string

Output only. Client version.

guestOsScan

object (GuestOsScan)

Output only. Reference to MC Source Guest Os Scan.

vsphereScan

object (VSphereScan)

Output only. Reference to MC Source vsphereScan.

collectionDays

integer

How many days to collect data.

eulaUri

string

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

State

-- Using suggestion from API Linter Analyzer for nesting enum -- -- https://linter.aip.dev/216/nesting -- State of a Collector (server_side). States are used for internal purposes and named to keep convention of legacy product: https://cloud.google.com/migrate/stratozone/docs/about-stratoprobe.

Enums
STATE_UNSPECIFIED Collector state is not recognized.
STATE_INITIALIZING Collector started to create, but hasn't been completed MC source creation and db object creation.
STATE_READY_TO_USE Collector has been created, MC source creation and db object creation completed.
STATE_REGISTERED Collector client has been registered with client.
STATE_ACTIVE Collector client is actively scanning.
STATE_PAUSED Collector is not actively scanning.
STATE_DELETING Collector is starting background job for deletion.
STATE_DECOMMISSIONED Collector completed all tasks for deletion.
STATE_ERROR Collector is in error state.

GuestOsScan

Message describing a MC Source of type Guest OS Scan.

JSON representation
{
  "coreSource": string
}
Fields
coreSource

string

reference to the corresponding Guest OS Scan in MC Source.

VSphereScan

Message describing a MC Source of type VSphere Scan.

JSON representation
{
  "coreSource": string
}
Fields
coreSource

string

reference to the corresponding VSphere Scan in MC Source.

Methods

create

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

delete

Deletes a single Collector - changes state of collector to "Deleting".

get

Gets details of a single Collector.

list

Lists Collectors in a given project and location.

patch

Updates the parameters of a single Collector.

pause

Pauses the given collector.

register

Registers the given collector.

resume

Resumes the given collector.