Struct qcs_api_client_grpc::services::controller::ExecuteControllerJobRequest

pub struct ExecuteControllerJobRequest {
    pub execution_configurations: Vec<JobExecutionConfiguration>,
    pub options: Option<ExecutionOptions>,
    pub job: Option<Job>,
    pub target: Option<Target>,
}

A request to execute a given ControllerJob on a specific target with one or more configurations.

This action is atomic in that a job for each configuration will be queued, or none of them will. On success, the response will contain a sequence of job IDs where the number and order of IDs returned will correspond to the number and order of configurations given. However, note that execution in the order of the given configurations is not guaranteed. If there is a failure to queue any of the jobs, then none will be queued. A request must have at least one configuration, otherwise an error will be returned.

Fields

execution_configurations: Vec<JobExecutionConfiguration>

One or more configurations against which to execute the provided job.

The response will include one job_execution_id for each entry in this list, each corresponding to its configuration in the same order.

options: Option<ExecutionOptions>

job: Option<Job>

target: Option<Target>

Required by the gateway to forward requests to the correct execution host.

Trait Implementations

impl Clone for ExecuteControllerJobRequest

fn clone(&self) -> ExecuteControllerJobRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExecuteControllerJobRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExecuteControllerJobRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecuteControllerJobRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ExecuteControllerJobRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ExecuteControllerJobRequest

fn eq(&self, other: &ExecuteControllerJobRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExecuteControllerJobRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ExecuteControllerJobRequest