com.amazonaws.services.braket.model

Class JobCheckpointConfig

java.lang.Object

com.amazonaws.services.braket.model.JobCheckpointConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobCheckpointConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains information about the output locations for job checkpoint data.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobCheckpointConfig()

Method Summary

Modifier and Type	Method and Description
JobCheckpointConfig	clone()
boolean	equals(Object obj)
String	getLocalPath() (Optional) The local directory where checkpoints are written.
String	getS3Uri() Identifies the S3 path where you want Amazon Braket to store checkpoints.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setLocalPath(String localPath) (Optional) The local directory where checkpoints are written.
void	setS3Uri(String s3Uri) Identifies the S3 path where you want Amazon Braket to store checkpoints.
String	toString() Returns a string representation of this object.
JobCheckpointConfig	withLocalPath(String localPath) (Optional) The local directory where checkpoints are written.
JobCheckpointConfig	withS3Uri(String s3Uri) Identifies the S3 path where you want Amazon Braket to store checkpoints.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobCheckpointConfig

public JobCheckpointConfig()

Method Detail

setLocalPath

public void setLocalPath(String localPath)

(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

Parameters:

localPath - (Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

getLocalPath

public String getLocalPath()

(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

Returns:

(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

withLocalPath

public JobCheckpointConfig withLocalPath(String localPath)

(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

Parameters:

localPath - (Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3Uri

public void setS3Uri(String s3Uri)

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

Parameters:

s3Uri - Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

getS3Uri

public String getS3Uri()

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

Returns:

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

withS3Uri

public JobCheckpointConfig withS3Uri(String s3Uri)

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

Parameters:

s3Uri - Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public JobCheckpointConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.