Class UploadConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UploadConfiguration.Builder,
UploadConfiguration>
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UploadConfiguration.Builder
builder()
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) final int
hashCode()
final String
name()
A prefix that specifies where files will be uploaded in Amazon S3.final String
path()
Specifies the path of the file(s) to upload.static Class
<? extends UploadConfiguration.Builder> 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.final UploadBehavior
Specifies when to upload the files:final String
Specifies when to upload the files:Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 isrobot-test
, your files will be uploaded tos3://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 isrobot-test
, your files will be uploaded tos3://my-bucket/<simid>/<runid>/robot-test
.
-
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
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 returnUploadBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuploadBehaviorAsString()
.- 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:
-
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 returnUploadBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuploadBehaviorAsString()
.- 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:
-
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<UploadConfiguration.Builder,
UploadConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
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. -
getValueForField
-
sdkFields
-