Resource

Information about a resource such as a task, Cloud Storage bucket, database, disk, logical policy, or something similar.

JSON representation
{
  "type": string,
  "resourceType": enum (ResourceType),
  "resourceSubtype": string,
  "id": string,
  "name": string,
  "parent": string,
  "productObjectId": string,
  "attribute": {
    object (Attribute)
  },
  "scheduledTask": {
    object (ScheduledTask)
  },
  "scheduledCronTask": {
    object (ScheduledCronTask)
  },
  "scheduledAnacronTask": {
    object (ScheduledAnacronTask)
  },
  "windowsScheduledTask": {
    object (WindowsScheduledTask)
  },
  "volume": {
    object (Volume)
  },
  "service": {
    object (Service)
  }
}
Fields
type
(deprecated)

string

Deprecated: use resourceType instead.

resourceType

enum (ResourceType)

Resource type.

resourceSubtype

string

Resource sub-type (e.g. "BigQuery", "Bigtable").

id
(deprecated)

string

Deprecated: Use resource.name or resource.product_object_id.

name

string

The full name of the resource. For example, Google Cloud: //cloudresourcemanager.googleapis.com/projects/wombat-123, and AWS: arn:aws:iam::123456789012:user/johndoe.

parent
(deprecated)

string

The parent of the resource. For a database table, the parent is the database. For a storage object, the bucket name. Deprecated: use resourceAncestors.name.

productObjectId

string

A vendor-specific identifier to uniquely identify the entity (a GUID, OID, or similar) This field can be used as an entity indicator for a Resource entity.

attribute

object (Attribute)

Generic entity metadata attributes of the resource.

scheduledTask
(deprecated)

object (ScheduledTask)

DEPRECATED: use windowsScheduledTask for Windows scheduled tasks or scheduledCronTask for cron jobs. Information about a scheduled task associated with the resource.

scheduledCronTask

object (ScheduledCronTask)

Information about a scheduled cron task associated with the resource.

scheduledAnacronTask

object (ScheduledAnacronTask)

Information about a scheduled anacron task associated with the resource.

windowsScheduledTask

object (WindowsScheduledTask)

Information about a Windows scheduled task associated with the resource.

volume

object (Volume)

Information about a storage volume associated with the resource.

service

object (Service)

Information about a Windows service associated with the resource.

ScheduledTask

Deprecated: use WindowsScheduledTask for Windows scheduled tasks or ScheduledCronTask for cron jobs. Information about a scheduled task.

JSON representation
{
  "minute": integer,
  "hour": integer,
  "monthDay": integer,
  "month": integer,
  "weekDay": integer,
  "comment": string,
  "author": string
}
Fields
minute

integer

The minute of the hour (0-59).

hour

integer

The hour of the day (0-23).

monthDay

integer

The day of the month (1-31).

month

integer

The month of the year (1-12).

weekDay

integer

The day of the week (0-6, Sunday=0).

comment

string

A comment or description for the task.

author

string

The account name that authored or last modified the scheduled task.

ScheduledCronTask

Information about a scheduled cron task.

JSON representation
{
  "minute": string,
  "hour": string,
  "monthDay": string,
  "month": string,
  "weekDay": string,
  "comment": string,
  "author": string,
  "event": string,
  "path": string
}
Fields
minute

string

Crontab minute field. Value is an integer between 0 and 59 and can also be a range or list of values (e.g., "0-59", "0-59/5", "0,15,30,45") and it // can also be an asterisk (*) to indicate first-last minutes. More on crontab format can be found here: https://linux.die.net/man/5/crontab

hour

string

Crontab hour field. Value is an integer between 0 and 23, a range or list of values (e.g., "0-6", "*/2", "1,2"), or an asterisk (*) to indicate first-last hours.

monthDay

string

Crontab day of month field. Value is an integer between 1 and 31, a range or list of values (e.g., "1-7", "1-31/7", "1,15"), or an asterisk (*) to indicate first-last days of month.

month

string

Crontab month field. Value is an integer between 1 and 12 or a 3-letter name (e.g., "Jan"), a range or list of values (e.g., "1-3", "*/2", "1,6"), or an asterisk (*) to indicate first-last months.

weekDay

string

Crontab day of week field. Value is an integer between 0 and 7 (0 or 7 is Sunday) or a 3-letter name (e.g., "Fri"), a range or list of values (e.g., "1-5", "0,6"), or an asterisk (*) to indicate first-last days of week.

comment

string

A comment or description for the task.

author

string

The author or creator of the task.

event

string

Crontab special string or event (e.g., "@reboot", "@daily").

path

string

The PATH environment variable defined in the crontab file.

ScheduledAnacronTask

Information about a scheduled anacron task.

JSON representation
{
  "period": string,
  "delayMinutes": string,
  "jobId": string,
  "path": string,
  "sourceLine": string
}
Fields
period

string

Anacrontab period field. Value is an integer in days, or a string like "@daily", "@weekly", or "@monthly".

delayMinutes

string (int64 format)

The delay in minutes before the job is run.

jobId

string

The unique identifier of the job.

path

string

The PATH environment variable defined in the anacrontab file.

sourceLine

string

The original source line from the anacrontab file.

WindowsScheduledTask

Information about a Windows scheduled task.

JSON representation
{
  "author": string,
  "virtualPath": string,
  "exitCode": integer,
  "state": enum (TaskState),
  "logonType": enum (TaskLogonType),
  "taskActions": [
    {
      object (TaskAction)
    }
  ],
  "taskTriggers": [
    {
      object (TaskTrigger)
    }
  ]
}
Fields
author

string

The account name that authored or last modified the scheduled task.

virtualPath

string

The task's path in the Task Scheduler library.

exitCode

integer

The result which was returned the last time the registered task was run.

state

enum (TaskState)

The operation state of the task.

logonType

enum (TaskLogonType)

The logon type of the task.

taskActions[]

object (TaskAction)

The actions of the scheduled task.

taskTriggers[]

object (TaskTrigger)

The triggers of the scheduled task.

TaskAction

The task action.

JSON representation
{
  "actionType": enum (ActionType),
  "execArguments": [
    string
  ],
  "execWorkingDirectory": string,
  "comClassId": string,
  "comData": string
}
Fields
actionType

enum (ActionType)

The action type of the task.

execArguments[]

string

The arguments of the task. This field is only populated if the task action type is EXEC.

execWorkingDirectory

string

The executable working directory of the task. This field is only populated if the task action type is EXEC.

comClassId

string

The COM class IF the action is COM handler. This field is only populated if the task action type is COM_HANDLER.

comData

string

The data of the task. This field is only populated if the task action type is COM_HANDLER.

TaskTrigger

The trigger of the scheduled task.

JSON representation
{
  "enabled": boolean,
  "duration": string,
  "interval": string,
  "triggerType": enum (TriggerType)
}
Fields
enabled

boolean

Indicates whether the task trigger is enabled.

duration

string (Duration format)

The duration of the task trigger repetition.

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

interval

string

The interval between each repetition of the task. The format for this string is PDTHMS (for example, "PT5M" is 5 minutes, "PT1H" is 1 hour, and "PT20M" is 20 minutes). The maximum time allowed is 31 days, and the minimum time allowed is 1 minute.

triggerType

enum (TriggerType)

The trigger frequency of the task.

Volume

Information about a storage volume.

JSON representation
{
  "fileSystem": string,
  "mountPoint": string,
  "devicePath": string,
  "isMounted": boolean,
  "isReadOnly": boolean,
  "name": string
}
Fields
fileSystem

string

The name of the file system on the volume (e.g., "NTFS", "FAT32").

mountPoint

string

The path where the volume is mounted (e.g., "C:", "/mnt/data").

devicePath

string

The system path to the device (e.g., "\.\HarddiskVolume1", "/dev/sda1").

isMounted

boolean

Indicates whether the volume is currently mounted.

isReadOnly

boolean

Indicates whether the volume is mounted as read-only.

name

string

The user-assigned label or name for the volume.

Service

Information about a Windows service.

JSON representation
{
  "displayName": string,
  "serviceType": enum (ServiceType),
  "serviceTypes": [
    enum (ServiceType)
  ],
  "startupType": enum (StartupType),
  "state": enum (State)
}
Fields
displayName

string

The user-friendly display name of the service.

serviceType
(deprecated)

enum (ServiceType)

Deprecated: use serviceTypes instead. The type of service.

serviceTypes[]

enum (ServiceType)

The list of service types.

startupType

enum (StartupType)

The startup type of the service.

state

enum (State)

The status of the service.