Package software.amazon.awssdk.services.braket.model

Class GetJobResponse

    • Method Detail

      • algorithmSpecification

        public final AlgorithmSpecification algorithmSpecification()

        Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.

        Returns:
        Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.

      • 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 the isEmpty() 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

        public final List<Association> 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.

      • billableDuration

        public final Integer billableDuration()

        The billable time the Amazon Braket job used to complete.

        Returns:
        The billable time the Amazon Braket job used to complete.

      • checkpointConfig

        public final JobCheckpointConfig checkpointConfig()

        Information about the output locations for job checkpoint data.

        Returns:
        Information about the output locations for job checkpoint data.

      • createdAt

        public final Instant createdAt()

        The date and time that the Amazon Braket job was created.

        Returns:
        The date and time that the Amazon Braket job was created.

      • deviceConfig

        public final DeviceConfig deviceConfig()

        The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

        Returns:
        The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

      • endedAt

        public final Instant endedAt()

        The date and time that the Amazon Braket job ended.

        Returns:
        The date and time that the Amazon Braket job ended.

      • hasEvents

        public final boolean hasEvents()
        For responses, this returns true if the service returned a value for the Events property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

      • events

        public final List<JobEventDetails> events()

        Details about the type and time events occurred related to the Amazon Braket 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 hasEvents() method.

        Returns:
        Details about the type and time events occurred related to the Amazon Braket job.

      • failureReason

        public final String failureReason()

        A description of the reason why an Amazon Braket job failed, if it failed.

        Returns:
        A description of the reason why an Amazon Braket job failed, if it failed.

      • 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 the isEmpty() 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

        public final Map<String,​String> hyperParameters()

        Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing 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.

        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 job that influence the quality of the traiing 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.

      • 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 the isEmpty() 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

        public final List<InputFileConfig> 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.

      • instanceConfig

        public final InstanceConfig instanceConfig()

        The resource instances to use while running the hybrid job on Amazon Braket.

        Returns:
        The resource instances to use while running the hybrid job on Amazon Braket.

      • jobArn

        public final String jobArn()

        The ARN of the Amazon Braket job.

        Returns:
        The ARN of the Amazon Braket job.

      • jobName

        public final String jobName()

        The name of the Amazon Braket job.

        Returns:
        The name of the Amazon Braket job.

      • outputDataConfig

        public final JobOutputDataConfig outputDataConfig()

        The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

        Returns:
        The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

      • queueInfo

        public final HybridJobQueueInfo queueInfo()

        Queue information for the requested job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

        Returns:
        Queue information for the requested job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

      • roleArn

        public 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. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.

        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 resources to the s3 buckets of a user.

      • startedAt

        public final Instant startedAt()

        The date and time that the Amazon Braket job was started.

        Returns:
        The date and time that the Amazon Braket job was started.

      • stoppingCondition

        public final JobStoppingCondition stoppingCondition()

        The user-defined criteria that specifies when to stop a job running.

        Returns:
        The user-defined criteria that specifies when to stop a job running.

      • 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 the isEmpty() 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

        public final Map<String,​String> tags()

        A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

        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:
        A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object