pub struct CreateJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateJob
.
Creates an Amazon Braket job.
Implementations§
source§impl CreateJobFluentBuilder
impl CreateJobFluentBuilder
sourcepub fn as_input(&self) -> &CreateJobInputBuilder
pub fn as_input(&self) -> &CreateJobInputBuilder
Access the CreateJob as a reference.
sourcepub async fn send(
self
) -> Result<CreateJobOutput, SdkError<CreateJobError, HttpResponse>>
pub async fn send( self ) -> Result<CreateJobOutput, SdkError<CreateJobError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateJobOutput, CreateJobError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateJobOutput, CreateJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique token that guarantees that the call to this API is idempotent.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique token that guarantees that the call to this API is idempotent.
sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique token that guarantees that the call to this API is idempotent.
sourcepub fn algorithm_specification(self, input: AlgorithmSpecification) -> Self
pub fn algorithm_specification(self, input: AlgorithmSpecification) -> Self
Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.
sourcepub fn set_algorithm_specification(
self,
input: Option<AlgorithmSpecification>
) -> Self
pub fn set_algorithm_specification( self, input: Option<AlgorithmSpecification> ) -> Self
Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.
sourcepub fn get_algorithm_specification(&self) -> &Option<AlgorithmSpecification>
pub fn get_algorithm_specification(&self) -> &Option<AlgorithmSpecification>
Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.
sourcepub fn input_data_config(self, input: InputFileConfig) -> Self
pub fn input_data_config(self, input: InputFileConfig) -> Self
Appends an item to inputDataConfig
.
To override the contents of this collection use set_input_data_config
.
A list of parameters that specify the name and type of input data and where it is located.
sourcepub fn set_input_data_config(self, input: Option<Vec<InputFileConfig>>) -> Self
pub fn set_input_data_config(self, input: Option<Vec<InputFileConfig>>) -> Self
A list of parameters that specify the name and type of input data and where it is located.
sourcepub fn get_input_data_config(&self) -> &Option<Vec<InputFileConfig>>
pub fn get_input_data_config(&self) -> &Option<Vec<InputFileConfig>>
A list of parameters that specify the name and type of input data and where it is located.
sourcepub fn output_data_config(self, input: JobOutputDataConfig) -> Self
pub fn output_data_config(self, input: JobOutputDataConfig) -> Self
The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
sourcepub fn set_output_data_config(self, input: Option<JobOutputDataConfig>) -> Self
pub fn set_output_data_config(self, input: Option<JobOutputDataConfig>) -> Self
The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
sourcepub fn get_output_data_config(&self) -> &Option<JobOutputDataConfig>
pub fn get_output_data_config(&self) -> &Option<JobOutputDataConfig>
The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
sourcepub fn checkpoint_config(self, input: JobCheckpointConfig) -> Self
pub fn checkpoint_config(self, input: JobCheckpointConfig) -> Self
Information about the output locations for job checkpoint data.
sourcepub fn set_checkpoint_config(self, input: Option<JobCheckpointConfig>) -> Self
pub fn set_checkpoint_config(self, input: Option<JobCheckpointConfig>) -> Self
Information about the output locations for job checkpoint data.
sourcepub fn get_checkpoint_config(&self) -> &Option<JobCheckpointConfig>
pub fn get_checkpoint_config(&self) -> &Option<JobCheckpointConfig>
Information about the output locations for job checkpoint data.
sourcepub fn set_job_name(self, input: Option<String>) -> Self
pub fn set_job_name(self, input: Option<String>) -> Self
The name of the Amazon Braket job.
sourcepub fn get_job_name(&self) -> &Option<String>
pub fn get_job_name(&self) -> &Option<String>
The name of the Amazon Braket job.
sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.
sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.
sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.
sourcepub fn stopping_condition(self, input: JobStoppingCondition) -> Self
pub fn stopping_condition(self, input: JobStoppingCondition) -> Self
The user-defined criteria that specifies when a job stops running.
sourcepub fn set_stopping_condition(self, input: Option<JobStoppingCondition>) -> Self
pub fn set_stopping_condition(self, input: Option<JobStoppingCondition>) -> Self
The user-defined criteria that specifies when a job stops running.
sourcepub fn get_stopping_condition(&self) -> &Option<JobStoppingCondition>
pub fn get_stopping_condition(&self) -> &Option<JobStoppingCondition>
The user-defined criteria that specifies when a job stops running.
sourcepub fn instance_config(self, input: InstanceConfig) -> Self
pub fn instance_config(self, input: InstanceConfig) -> Self
Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
sourcepub fn set_instance_config(self, input: Option<InstanceConfig>) -> Self
pub fn set_instance_config(self, input: Option<InstanceConfig>) -> Self
Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
sourcepub fn get_instance_config(&self) -> &Option<InstanceConfig>
pub fn get_instance_config(&self) -> &Option<InstanceConfig>
Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
sourcepub fn hyper_parameters(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
pub fn hyper_parameters( self, k: impl Into<String>, v: impl Into<String> ) -> Self
Adds a key-value pair to hyperParameters
.
To override the contents of this collection use set_hyper_parameters
.
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
sourcepub fn set_hyper_parameters(
self,
input: Option<HashMap<String, String>>
) -> Self
pub fn set_hyper_parameters( self, input: Option<HashMap<String, String>> ) -> Self
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
sourcepub fn get_hyper_parameters(&self) -> &Option<HashMap<String, String>>
pub fn get_hyper_parameters(&self) -> &Option<HashMap<String, String>>
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
sourcepub fn device_config(self, input: DeviceConfig) -> Self
pub fn device_config(self, input: DeviceConfig) -> Self
The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
sourcepub fn set_device_config(self, input: Option<DeviceConfig>) -> Self
pub fn set_device_config(self, input: Option<DeviceConfig>) -> Self
The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
sourcepub fn get_device_config(&self) -> &Option<DeviceConfig>
pub fn get_device_config(&self) -> &Option<DeviceConfig>
The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
Trait Implementations§
source§impl Clone for CreateJobFluentBuilder
impl Clone for CreateJobFluentBuilder
source§fn clone(&self) -> CreateJobFluentBuilder
fn clone(&self) -> CreateJobFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more