Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::ScheduledEvaluationRun.
Represents a scheduled evaluation run configuration.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#active
def active() -> ::Boolean
Returns
- (::Boolean) — Optional. Whether this config is active
#active=
def active=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Whether this config is active
Returns
- (::Boolean) — Optional. Whether this config is active
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the scheduled evaluation run was created.
#created_by
def created_by() -> ::String
Returns
- (::String) — Output only. The user who created the scheduled evaluation run.
#description
def description() -> ::String
Returns
- (::String) — Optional. User-defined description of the scheduled evaluation run.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. User-defined description of the scheduled evaluation run.
Returns
- (::String) — Optional. User-defined description of the scheduled evaluation run.
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. User-defined display name of the scheduled evaluation run config.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. User-defined display name of the scheduled evaluation run config.
Returns
- (::String) — Required. User-defined display name of the scheduled evaluation run config.
#etag
def etag() -> ::String
Returns
- (::String) — Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
#last_completed_run
def last_completed_run() -> ::String
Returns
-
(::String) — Output only. The last successful EvaluationRun of this scheduled execution.
Format:
projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}
#last_updated_by
def last_updated_by() -> ::String
Returns
- (::String) — Output only. The user who last updated the evaluation.
#name
def name() -> ::String
Returns
- (::String) — Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}
Returns
- (::String) — Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}
#next_scheduled_execution_time
def next_scheduled_execution_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The next time this is scheduled to execute
#request
def request() -> ::Google::Cloud::Ces::V1beta::RunEvaluationRequest
Returns
- (::Google::Cloud::Ces::V1beta::RunEvaluationRequest) — Required. The RunEvaluationRequest to schedule
#request=
def request=(value) -> ::Google::Cloud::Ces::V1beta::RunEvaluationRequest
Parameter
- value (::Google::Cloud::Ces::V1beta::RunEvaluationRequest) — Required. The RunEvaluationRequest to schedule
Returns
- (::Google::Cloud::Ces::V1beta::RunEvaluationRequest) — Required. The RunEvaluationRequest to schedule
#scheduling_config
def scheduling_config() -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun::SchedulingConfig
Returns
- (::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun::SchedulingConfig) — Required. Configuration for the timing and frequency with which to execute the evaluations.
#scheduling_config=
def scheduling_config=(value) -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun::SchedulingConfig
Parameter
- value (::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun::SchedulingConfig) — Required. Configuration for the timing and frequency with which to execute the evaluations.
Returns
- (::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun::SchedulingConfig) — Required. Configuration for the timing and frequency with which to execute the evaluations.
#total_executions
def total_executions() -> ::Integer
Returns
- (::Integer) — Output only. The total number of times this run has been executed
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the evaluation was last updated.