Class GreengrassConfiguration

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

Configuration information for the AWS IoT Greengrass component created in a model packaging job. For more information, see StartModelPackagingJob.

You can't specify a component with the same ComponentName and Componentversion as an existing component with the same component name and component version.

See Also:

  • Method Details

    • compilerOptions

      public final String compilerOptions()

      Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. If you specify TargetDevice, don't specify CompilerOptions.

      For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.

      Returns:
      Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. If you specify TargetDevice, don't specify CompilerOptions.

      For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.

    • targetDevice

      public final TargetDevice targetDevice()

      The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform.

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

      Returns:
      The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform.
      See Also:

    • targetDeviceAsString

      public final String targetDeviceAsString()

      The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform.

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

      Returns:
      The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform.
      See Also:

    • targetPlatform

      public final TargetPlatform targetPlatform()

      The target platform for the model. If you specify TargetPlatform, you can't specify TargetDevice.

      Returns:
      The target platform for the model. If you specify TargetPlatform, you can't specify TargetDevice.

    • s3OutputLocation

      public final S3Location s3OutputLocation()

      An S3 location in which Lookout for Vision stores the component artifacts.

      Returns:
      An S3 location in which Lookout for Vision stores the component artifacts.

    • componentName

      public final String componentName()

      A name for the AWS IoT Greengrass component.

      Returns:
      A name for the AWS IoT Greengrass component.

    • componentVersion

      public final String componentVersion()

      A Version for the AWS IoT Greengrass component. If you don't provide a value, a default value of Model Version.0.0 is used.

      Returns:
      A Version for the AWS IoT Greengrass component. If you don't provide a value, a default value of Model Version.0.0 is used.

    • componentDescription

      public final String componentDescription()

      A description for the AWS IoT Greengrass component.

      Returns:
      A description for the AWS IoT Greengrass component.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.

      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 hasTags() method.

      Returns:
      A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.

    • toBuilder

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

    • builder

      public static GreengrassConfiguration.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.