REST Resource: projects.locations.instances.integrations.jobs.jobInstances

Resource: IntegrationJobInstance

Allows saving & restoring different instances of job definitions. This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. Job instance resource describes the job's instances. Job instance is a configured instance of a job definition. The job instance is the actual timed script that runs every X seconds.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "intervalSeconds": integer,
  "script": string,
  "author": string,
  "lastRunTime": string,
  "parameters": [
    {
      object (IntegrationJobInstanceParameter)
    }
  ],
  "job": string,
  "integration": string,
  "advancedConfig": {
    object (AdvancedConfig)
  },
  "nextScheduledRunTime": string,
  "custom": boolean,
  "enabled": boolean,
  "description": string,
  "lastRunStatus": enum (JobResultStatus),
  "agent": string,
  "advanced": boolean,
  "uniqueIdentifier": string
}
Fields
name

string

Identifier. The unique name(ID) of the job instance. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/jobs/{job}/jobInstances/{jobInstance}"
createTime

string (int64 format)

Output only. Job instance creation time.
updateTime

string (int64 format)

Output only. Job instance update time.
displayName

string

Required. Job instance display name.
intervalSeconds

integer (uint32 format)

Required. Job instance interval in seconds. Minimum of 60 seconds.
script

string

Output only. Job instance script.
author

string

Output only. Job instance author.
lastRunTime

string (int64 format)

Output only. Job instance last execution time. In unix time.
parameters[]

object (IntegrationJobInstanceParameter)

Optional. Job instance parameters.
job

string

Output only. The job definition this instance belongs to.
integration

string

Output only. The integration this job instance is associated with.
advancedConfig

object (AdvancedConfig)

Optional. Advanced configuration for the job instance.
nextScheduledRunTime

string (int64 format)

Output only. Job instance next scheduled run time. In unix time.
custom

boolean

Output only. Determines whether the job is custom or commercial.
enabled

boolean

Required. Determines whether the job instance is enabled.
description

string

Optional. Job instance description.
lastRunStatus

enum (JobResultStatus)

Output only. Job instance last run status.
agent

string

Optional. Agent identifier in case the job runs remotely, otherwise will be null. This cannot be patched and must be defined when creating the instance.
advanced

boolean

Required. Indicates if the job instance uses an advanced scheduling configuration.
uniqueIdentifier

string

Output only. Unique identifier of the job instance.

JobResultStatus

Job result status options.

Enums
SUCCESS Job result status success.
ERROR Job result status error.

IntegrationJobInstanceParameter

Job instance parameters.

JSON representation 
{
  "id": integer,
  "mandatory": boolean,
  "value": string,
  "displayName": string,
  "type": enum (ParamType)
}
Fields
id

integer

Output only. The parameter's id.
mandatory

boolean

Output only. Is parameter mandatory.
value

string

Optional. The value of the parameter.
displayName

string

Output only. The parameter display name.
type

enum (ParamType)

Output only. The parameter's type.

ParamType

Parameter type options.

Enums
BOOLEAN Boolean parameter type.
INT Integer parameter type.
STRING String parameter type.
PASSWORD Password parameter type.
IP IP parameter type.
IP_OR_HOST IP or host parameter type.
URL URL parameter type.
DOMAIN Domain parameter type.
EMAIL Email parameter type.
VALUES_LIST Values parameter type.
VALUES_AS_SEMI_COLON_SEPARATED_STRING Values as semi-colon separated string parameter type.
MULTI_VALUES_SELECTION Multi values selection parameter type.
SCRIPT Script parameter type.
FILTER_LIST Filter list parameter type.
NUMERICAL_VALUES Numerical values parameter type.

AdvancedConfig

AdvancedConfig defines detailed scheduling options for an integration job instance. It allows specifying the time zone, and one of several schedule types such as one-time, daily, weekly, or monthly recurrences.

JSON representation 
{
  "timeZone": string,
  "scheduleType": enum (ScheduleType),

  // Union field schedule_details can be only one of the following:
  "oneTimeSchedule": {
    object (OneTimeScheduleDetails)
  },
  "dailySchedule": {
    object (DailyScheduleDetails)
  },
  "weeklySchedule": {
    object (WeeklyScheduleDetails)
  },
  "monthlySchedule": {
    object (MonthlyScheduleDetails)
  }
  // End of list of possible types for union field schedule_details.
}
Fields
timeZone

string

Required. The zone id.
scheduleType

enum (ScheduleType)

Required. The schedule type.
Union field schedule_details. Details of the schedule, corresponding to the schedule_type. schedule_details can be only one of the following:
oneTimeSchedule

object (OneTimeScheduleDetails)

Optional. The one time schedule details.
dailySchedule

object (DailyScheduleDetails)

Optional. The daily schedule details.
weeklySchedule

object (WeeklyScheduleDetails)

Optional. The weekly schedule details.
monthlySchedule

object (MonthlyScheduleDetails)

Optional. The monthly schedule details.

OneTimeScheduleDetails

The one time schedule details.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "time": {
    object (TimeOfDay)
  }
}
Fields
startDate

object (Date)

Required. The date to run the job.
time

object (TimeOfDay)

Required. The time to run the job.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

  • A full date, with non-zero year, month, and day values.
  • A month and day, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

JSON representation 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

JSON representation 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Fields
hours

integer

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes

integer

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
seconds

integer

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
nanos

integer

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

DailyScheduleDetails

The daily schedule details.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "time": {
    object (TimeOfDay)
  },
  "interval": integer
}
Fields
startDate

object (Date)

Required. The start date.
time

object (TimeOfDay)

Required. The time to run the job.
interval

integer

Required. The day interval.

WeeklyScheduleDetails

The weekly schedule details.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "days": [
    enum (DayOfWeek)
  ],
  "time": {
    object (TimeOfDay)
  },
  "interval": integer
}
Fields
startDate

object (Date)

Required. The start date.
days[]

enum (DayOfWeek)

Required. The days of the week to run the job.
time

object (TimeOfDay)

Required. The time to run the job.
interval

integer

Required. The week interval.

DayOfWeek

Represents a day of the week.

Enums
DAY_OF_WEEK_UNSPECIFIED The day of the week is unspecified.
MONDAY Monday
TUESDAY Tuesday
WEDNESDAY Wednesday
THURSDAY Thursday
FRIDAY Friday
SATURDAY Saturday
SUNDAY Sunday

MonthlyScheduleDetails

The monthly schedule details.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "day": integer,
  "time": {
    object (TimeOfDay)
  },
  "interval": integer
}
Fields
startDate

object (Date)

Required. The start date.
day

integer

Required. The day of the month to run the job.
time

object (TimeOfDay)

Required. The time to run the job.
interval

integer

Required. The month interval.

ScheduleType

The schedule type.

Enums
SCHEDULE_TYPE_UNSPECIFIED Schedule type unspecified.
ONCE Schedule type once.
DAILY Schedule type daily.
WEEKLY Schedule type weekly.
MONTHLY Schedule type monthly.

Methods

create

 CreateJobInstance creates a new job instance.

delete

 DeleteJobInstance deletes a job instance.

get

 Get instance of a job.

list

 List all instances of a job.

patch

 UpdateIntegrationJobInstance updates an instance of a job instance.

runOnDemand

 RunOnDemandIntegrationJobInstance runs job instance script once.