com.google.api.services.notebooks.v1.model

Class Schedule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.notebooks.v1.model.Schedule

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Schedule
extends GenericJson

The definition of a schedule.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Notebooks API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Schedule()

Method Summary

Modifier and Type	Method and Description
Schedule	clone()
String	getCreateTime() Output only.
String	getCronSchedule() Cron-tab formatted schedule by which the job will execute.
String	getDescription() A brief description of this environment.
String	getDisplayName() Output only.
ExecutionTemplate	getExecutionTemplate() Notebook Execution Template corresponding to this schedule.
String	getName() Output only.
List<Execution>	getRecentExecutions() Output only.
String	getState()
String	getTimeZone() Timezone on which the cron_schedule.
String	getUpdateTime() Output only.
Schedule	set(String fieldName, Object value)
Schedule	setCreateTime(String createTime) Output only.
Schedule	setCronSchedule(String cronSchedule) Cron-tab formatted schedule by which the job will execute.
Schedule	setDescription(String description) A brief description of this environment.
Schedule	setDisplayName(String displayName) Output only.
Schedule	setExecutionTemplate(ExecutionTemplate executionTemplate) Notebook Execution Template corresponding to this schedule.
Schedule	setName(String name) Output only.
Schedule	setRecentExecutions(List<Execution> recentExecutions) Output only.
Schedule	setState(String state)
Schedule	setTimeZone(String timeZone) Timezone on which the cron_schedule.
Schedule	setUpdateTime(String updateTime) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Schedule

public Schedule()

Method Detail

getCreateTime

public String getCreateTime()

Output only. Time the schedule was created.

Returns:

value or null for none

setCreateTime

public Schedule setCreateTime(String createTime)

Output only. Time the schedule was created.

Parameters:

createTime - createTime or null for none

getCronSchedule

public String getCronSchedule()

Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html

Returns:

value or null for none

setCronSchedule

public Schedule setCronSchedule(String cronSchedule)

Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html

Parameters:

cronSchedule - cronSchedule or null for none

getDescription

public String getDescription()

A brief description of this environment.

Returns:

value or null for none

setDescription

public Schedule setDescription(String description)

A brief description of this environment.

Parameters:

description - description or null for none

getDisplayName

public String getDisplayName()

Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'.

Returns:

value or null for none

setDisplayName

public Schedule setDisplayName(String displayName)

Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'.

Parameters:

displayName - displayName or null for none

getExecutionTemplate

public ExecutionTemplate getExecutionTemplate()

Notebook Execution Template corresponding to this schedule.

Returns:

value or null for none

setExecutionTemplate

public Schedule setExecutionTemplate(ExecutionTemplate executionTemplate)

Notebook Execution Template corresponding to this schedule.

Parameters:

executionTemplate - executionTemplate or null for none

getName

public String getName()

Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`

Returns:

value or null for none

setName

public Schedule setName(String name)

Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`

Parameters:

name - name or null for none

getRecentExecutions

public List<Execution> getRecentExecutions()

Output only. The most recent execution names triggered from this schedule and their corresponding states.

Returns:

value or null for none

setRecentExecutions

public Schedule setRecentExecutions(List<Execution> recentExecutions)

Output only. The most recent execution names triggered from this schedule and their corresponding states.

Parameters:

recentExecutions - recentExecutions or null for none

getState

public String getState()

Returns:

value or null for none

setState

public Schedule setState(String state)

Parameters:

state - state or null for none

getTimeZone

public String getTimeZone()

Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).

Returns:

value or null for none

setTimeZone

public Schedule setTimeZone(String timeZone)

Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).

Parameters:

timeZone - timeZone or null for none

getUpdateTime

public String getUpdateTime()

Output only. Time the schedule was last updated.

Returns:

value or null for none

setUpdateTime

public Schedule setUpdateTime(String updateTime)

Output only. Time the schedule was last updated.

Parameters:

updateTime - updateTime or null for none

set

public Schedule set(String fieldName,
                    Object value)

Overrides:

set in class GenericJson

clone

public Schedule clone()

Overrides:

clone in class GenericJson