Interface ScheduleOrBuilder (1.42.0)

Version 1.42.0

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.6
• 0.6.2

public interface ScheduleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time the schedule was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time the schedule was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCronSchedule()

public abstract 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

string cron_schedule = 5;

Returns
Type	Description
String	The cronSchedule.

getCronScheduleBytes()

public abstract ByteString getCronScheduleBytes()

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

string cron_schedule = 5;

Returns
Type	Description
ByteString	The bytes for cronSchedule.

getDescription()

public abstract String getDescription()

A brief description of this environment.

string description = 3;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A brief description of this environment.

string description = 3;

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for displayName.

getExecutionTemplate()

public abstract ExecutionTemplate getExecutionTemplate()

Notebook Execution Template corresponding to this schedule.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;

Returns
Type	Description
ExecutionTemplate	The executionTemplate.

getExecutionTemplateOrBuilder()

public abstract ExecutionTemplateOrBuilder getExecutionTemplateOrBuilder()

Notebook Execution Template corresponding to this schedule.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;

Returns
Type	Description
ExecutionTemplateOrBuilder

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getRecentExecutions(int index)

public abstract Execution getRecentExecutions(int index)

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

repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Execution

getRecentExecutionsCount()

public abstract int getRecentExecutionsCount()

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

repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getRecentExecutionsList()

public abstract List<Execution> getRecentExecutionsList()

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

repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Execution>

getRecentExecutionsOrBuilder(int index)

public abstract ExecutionOrBuilder getRecentExecutionsOrBuilder(int index)

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

repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
ExecutionOrBuilder

getRecentExecutionsOrBuilderList()

public abstract List<? extends ExecutionOrBuilder> getRecentExecutionsOrBuilderList()

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

repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.notebooks.v1.ExecutionOrBuilder>

getState()

public abstract Schedule.State getState()

.google.cloud.notebooks.v1.Schedule.State state = 4;

Returns
Type	Description
Schedule.State	The state.

getStateValue()

public abstract int getStateValue()

.google.cloud.notebooks.v1.Schedule.State state = 4;

Returns
Type	Description
int	The enum numeric value on the wire for state.

getTimeZone()

public abstract 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).

string time_zone = 6;

Returns
Type	Description
String	The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

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

string time_zone = 6;

Returns
Type	Description
ByteString	The bytes for timeZone.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Time the schedule was last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time the schedule was last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time the schedule was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasExecutionTemplate()

public abstract boolean hasExecutionTemplate()

Notebook Execution Template corresponding to this schedule.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;

Returns
Type	Description
boolean	Whether the executionTemplate field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Time the schedule was last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.