Package software.amazon.awssdk.services.robomaker.model

Class UploadConfiguration

java.lang.Object

software.amazon.awssdk.services.robomaker.model.UploadConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UploadConfiguration.Builder,UploadConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class UploadConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UploadConfiguration.Builder,UploadConfiguration>

Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UploadConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static UploadConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	A prefix that specifies where files will be uploaded in Amazon S3.
String	path()	Specifies the path of the file(s) to upload.
List<SdkField<?>>	sdkFields()
static Class<? extends UploadConfiguration.Builder>	serializableBuilderClass()
UploadConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UploadBehavior	uploadBehavior()	Specifies when to upload the files:
String	uploadBehaviorAsString()	Specifies when to upload the files:

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

Returns:

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

path

public final String path()

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

Returns:

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

uploadBehavior

public final UploadBehavior uploadBehavior()

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

If the service returns an enum value that is not available in the current SDK version, uploadBehavior will return UploadBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uploadBehaviorAsString().

Returns:

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

See Also:

UploadBehavior

uploadBehaviorAsString

public final String uploadBehaviorAsString()

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

If the service returns an enum value that is not available in the current SDK version, uploadBehavior will return UploadBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uploadBehaviorAsString().

Returns:

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

See Also:

UploadBehavior

toBuilder

public UploadConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UploadConfiguration.Builder,UploadConfiguration>

builder

public static UploadConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends UploadConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo