Interface UploadConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<UploadConfiguration.Builder,
,UploadConfiguration> SdkBuilder<UploadConfiguration.Builder,
,UploadConfiguration> SdkPojo
- Enclosing class:
UploadConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionA prefix that specifies where files will be uploaded in Amazon S3.Specifies the path of the file(s) to upload.uploadBehavior
(String uploadBehavior) Specifies when to upload the files:uploadBehavior
(UploadBehavior uploadBehavior) Specifies when to upload the files:Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
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://amzn-s3-demo-bucket
and your upload configuration name isrobot-test
, your files will be uploaded tos3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test
.- Parameters:
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://amzn-s3-demo-bucket
and your upload configuration name isrobot-test
, your files will be uploaded tos3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-