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:

  • Method Details

    • 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://amzn-s3-demo-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://amzn-s3-demo-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://amzn-s3-demo-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://amzn-s3-demo-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:

    • 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:

    • toBuilder

      public UploadConfiguration.Builder 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 interface ToCopyableBuilder<UploadConfiguration.Builder,UploadConfiguration>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.