Package software.amazon.awssdk.services.amplifyuibuilder.model

Class CodegenJob

    • Method Detail

      • id

        public final String id()

        The unique ID for the code generation job.

        Returns:
        The unique ID for the code generation job.

      • appId

        public final String appId()

        The ID of the Amplify app associated with the code generation job.

        Returns:
        The ID of the Amplify app associated with the code generation job.

      • environmentName

        public final String environmentName()

        The name of the backend environment associated with the code generation job.

        Returns:
        The name of the backend environment associated with the code generation job.

      • renderConfig

        public final CodegenJobRenderConfig renderConfig()
        Returns the value of the RenderConfig property for this object.
        Returns:
        The value of the RenderConfig property for this object.

      • genericDataSchema

        public final CodegenJobGenericDataSchema genericDataSchema()
        Returns the value of the GenericDataSchema property for this object.
        Returns:
        The value of the GenericDataSchema property for this object.

      • autoGenerateForms

        public final Boolean autoGenerateForms()

        Specifies whether to autogenerate forms in the code generation job.

        Returns:
        Specifies whether to autogenerate forms in the code generation job.

      • features

        public final CodegenFeatureFlags features()
        Returns the value of the Features property for this object.
        Returns:
        The value of the Features property for this object.

      • statusAsString

        public final String statusAsString()

        The status of the code generation job.

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

        Returns:
        The status of the code generation job.
        See Also:
        CodegenJobStatus

      • statusMessage

        public final String statusMessage()

        The customized status message for the code generation job.

        Returns:
        The customized status message for the code generation job.

      • asset

        public final CodegenJobAsset asset()

        The CodegenJobAsset to use for the code generation job.

        Returns:
        The CodegenJobAsset to use for the code generation job.

      • 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 Map<String,​String> tags()

        One or more key-value pairs to use when tagging the code generation job.

        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:
        One or more key-value pairs to use when tagging the code generation job.

      • createdAt

        public final Instant createdAt()

        The time that the code generation job was created.

        Returns:
        The time that the code generation job was created.

      • modifiedAt

        public final Instant modifiedAt()

        The time that the code generation job was modified.

        Returns:
        The time that the code generation job was modified.

      • hasDependencies

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

      • dependencies

        public final List<CodegenDependency> dependencies()

        Lists the dependency packages that may be required for the project code to run.

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

        Returns:
        Lists the dependency packages that may be required for the project code to run.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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