Class CreateJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateJobRequest.Builder,
CreateJobRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AlgorithmSpecification
Definition of the Amazon Braket job to be created.final List
<Association> The list of Amazon Braket resources associated with the hybrid job.static CreateJobRequest.Builder
builder()
final JobCheckpointConfig
Information about the output locations for hybrid job checkpoint data.final String
The client token associated with this request that guarantees that the request is idempotent.final DeviceConfig
The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Associations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the HyperParameters property.final boolean
For responses, this returns true if the service returned a value for the InputDataConfig property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job.final List
<InputFileConfig> A list of parameters that specify the name and type of input data and where it is located.final InstanceConfig
Configuration of the resource instances to use while running the hybrid job on Amazon Braket.final String
jobName()
The name of the Amazon Braket hybrid job.final JobOutputDataConfig
The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.final String
roleArn()
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.static Class
<? extends CreateJobRequest.Builder> final JobStoppingCondition
The user-defined criteria that specifies when a hybrid job stops running.tags()
Tags to be added to the hybrid job you're creating.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientToken
The client token associated with this request that guarantees that the request is idempotent.
- Returns:
- The client token associated with this request that guarantees that the request is idempotent.
-
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.
- Returns:
- 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.
-
hasInputDataConfig
public final boolean hasInputDataConfig()For responses, this returns true if the service returned a value for the InputDataConfig property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
inputDataConfig
A list of parameters that specify the name and type of input data and where it is located.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInputDataConfig()
method.- Returns:
- A list of parameters that specify the name and type of input data and where it is located.
-
outputDataConfig
The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.
- Returns:
- The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.
-
checkpointConfig
Information about the output locations for hybrid job checkpoint data.
- Returns:
- Information about the output locations for hybrid job checkpoint data.
-
jobName
The name of the Amazon Braket hybrid job.
- Returns:
- The name of the Amazon Braket hybrid job.
-
roleArn
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 results and hybrid job details to the users' s3 buckets.
- Returns:
- 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 results and hybrid job details to the users' s3 buckets.
-
stoppingCondition
The user-defined criteria that specifies when a hybrid job stops running.
- Returns:
- The user-defined criteria that specifies when a hybrid job stops running.
-
instanceConfig
Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
- Returns:
- Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
-
hasHyperParameters
public final boolean hasHyperParameters()For responses, this returns true if the service returned a value for the HyperParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
hyperParameters
Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasHyperParameters()
method.- Returns:
- Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the
training job. The values are set with a map of JSON key:value pairs, where the key is the name of the
hyperparameter and the value is the value of the hyperparameter.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.
-
deviceConfig
The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.
- Returns:
- The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Tags to be added to the hybrid job you're creating.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Tags to be added to the hybrid job you're creating.
-
hasAssociations
public final boolean hasAssociations()For responses, this returns true if the service returned a value for the Associations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
associations
The list of Amazon Braket resources associated with the hybrid job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAssociations()
method.- Returns:
- The list of Amazon Braket resources associated with the hybrid job.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateJobRequest.Builder,
CreateJobRequest> - Specified by:
toBuilder
in classBraketRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-