Class DataSourceConfig

java.lang.Object
software.amazon.awssdk.services.robomaker.model.DataSourceConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataSourceConfig.Builder,DataSourceConfig>
@Generated("software.amazon.awssdk:codegen") public final class DataSourceConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataSourceConfig.Builder,DataSourceConfig>

Information about a data source.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the data source.

      Returns:
      The name of the data source.

    • s3Bucket

      public final String s3Bucket()

      The S3 bucket where the data files are located.

      Returns:
      The S3 bucket where the data files are located.

    • hasS3Keys

      public final boolean hasS3Keys()
      For responses, this returns true if the service returned a value for the S3Keys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • s3Keys

      public final List<String> s3Keys()

      The list of S3 keys identifying the data source files.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasS3Keys() method.

      Returns:
      The list of S3 keys identifying the data source files.

    • type

      public final DataSourceType type()

      The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

      If you don't specify a field, the default value is File.

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

      Returns:
      The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

      If you don't specify a field, the default value is File.

      See Also:

    • typeAsString

      public final String typeAsString()

      The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

      If you don't specify a field, the default value is File.

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

      Returns:
      The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

      If you don't specify a field, the default value is File.

      See Also:

    • destination

      public final String destination()

      The location where your files are mounted in the container image.

      If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

      If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

      If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

      Returns:
      The location where your files are mounted in the container image.

      If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

      If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

      If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

    • toBuilder

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

    • builder

      public static DataSourceConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DataSourceConfig.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.