ScheduleConfig¶
- class oci.generative_ai.models.ScheduleConfig(**kwargs)¶
Bases:
objectThe Schedule configuration of a VectorStoreConnector to trigger a File Sync Operation.
Attributes:
A constant which can be used with the config_type property of a ScheduleConfig.
A constant which can be used with the config_type property of a ScheduleConfig.
A constant which can be used with the state property of a ScheduleConfig.
A constant which can be used with the state property of a ScheduleConfig.
[Required] Gets the config_type of this ScheduleConfig.
Gets the state of this ScheduleConfig.
Gets the time_end of this ScheduleConfig.
Gets the time_start of this ScheduleConfig.
Methods:
__init__(**kwargs)Initializes a new ScheduleConfig object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- CONFIG_TYPE_CRON = 'CRON'¶
A constant which can be used with the config_type property of a ScheduleConfig. This constant has a value of “CRON”
- CONFIG_TYPE_INTERVAL = 'INTERVAL'¶
A constant which can be used with the config_type property of a ScheduleConfig. This constant has a value of “INTERVAL”
- STATE_DISABLED = 'DISABLED'¶
A constant which can be used with the state property of a ScheduleConfig. This constant has a value of “DISABLED”
- STATE_ENABLED = 'ENABLED'¶
A constant which can be used with the state property of a ScheduleConfig. This constant has a value of “ENABLED”
- __init__(**kwargs)¶
Initializes a new ScheduleConfig object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
state (str) – The value to assign to the state property of this ScheduleConfig. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
config_type (str) – The value to assign to the config_type property of this ScheduleConfig. Allowed values for this property are: “INTERVAL”, “CRON”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_start (datetime) – The value to assign to the time_start property of this ScheduleConfig.
time_end (datetime) – The value to assign to the time_end property of this ScheduleConfig.
- property config_type¶
[Required] Gets the config_type of this ScheduleConfig. The schedule config type
Allowed values for this property are: “INTERVAL”, “CRON”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The config_type of this ScheduleConfig.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property state¶
Gets the state of this ScheduleConfig. The state of the schedule. The state can be either ENABLED or DISABLED.
Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The state of this ScheduleConfig.
- Return type
str