CodegenJob (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.amplifyuibuilder.model

Class CodegenJob

java.lang.Object
- com.amazonaws.services.amplifyuibuilder.model.CodegenJob

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CodegenJob
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Describes the configuration for a code generation job that is associated with an Amplify app.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CodegenJob ()

Constructors
Constructor and Description
`CodegenJob ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CodegenJob`	`addTagsEntry (String key, String value)` Add a single Tags entry
`CodegenJob`	`clearTagsEntries ()` Removes all the entries added into Tags.
`CodegenJob`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getAppId ()` The ID of the Amplify app associated with the code generation job.
`CodegenJobAsset`	`getAsset ()` The `CodegenJobAsset` to use for the code generation job.
`Boolean`	`getAutoGenerateForms ()` Specifies whether to autogenerate forms in the code generation job.
`Date`	`getCreatedAt ()` The time that the code generation job was created.
`List<CodegenDependency>`	`getDependencies ()` Lists the dependency packages that may be required for the project code to run.
`String`	`getEnvironmentName ()` The name of the backend environment associated with the code generation job.
`CodegenFeatureFlags`	`getFeatures ()`
`CodegenJobGenericDataSchema`	`getGenericDataSchema ()`
`String`	`getId ()` The unique ID for the code generation job.
`Date`	`getModifiedAt ()` The time that the code generation job was modified.
`CodegenJobRenderConfig`	`getRenderConfig ()`
`String`	`getStatus ()` The status of the code generation job.
`String`	`getStatusMessage ()` The customized status message for the code generation job.
`Map<String,String>`	`getTags ()` One or more key-value pairs to use when tagging the code generation job.
`int`	`hashCode ()`
`Boolean`	`isAutoGenerateForms ()` Specifies whether to autogenerate forms in the code generation job.
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAppId (String appId)` The ID of the Amplify app associated with the code generation job.
`void`	`setAsset (CodegenJobAsset asset)` The `CodegenJobAsset` to use for the code generation job.
`void`	`setAutoGenerateForms (Boolean autoGenerateForms)` Specifies whether to autogenerate forms in the code generation job.
`void`	`setCreatedAt (Date createdAt)` The time that the code generation job was created.
`void`	`setDependencies (Collection<CodegenDependency> dependencies)` Lists the dependency packages that may be required for the project code to run.
`void`	`setEnvironmentName (String environmentName)` The name of the backend environment associated with the code generation job.
`void`	`setFeatures (CodegenFeatureFlags features)`
`void`	`setGenericDataSchema (CodegenJobGenericDataSchema genericDataSchema)`
`void`	`setId (String id)` The unique ID for the code generation job.
`void`	`setModifiedAt (Date modifiedAt)` The time that the code generation job was modified.
`void`	`setRenderConfig (CodegenJobRenderConfig renderConfig)`
`void`	`setStatus (String status)` The status of the code generation job.
`void`	`setStatusMessage (String statusMessage)` The customized status message for the code generation job.
`void`	`setTags (Map<String,String> tags)` One or more key-value pairs to use when tagging the code generation job.
`String`	`toString ()` Returns a string representation of this object.
`CodegenJob`	`withAppId (String appId)` The ID of the Amplify app associated with the code generation job.
`CodegenJob`	`withAsset (CodegenJobAsset asset)` The `CodegenJobAsset` to use for the code generation job.
`CodegenJob`	`withAutoGenerateForms (Boolean autoGenerateForms)` Specifies whether to autogenerate forms in the code generation job.
`CodegenJob`	`withCreatedAt (Date createdAt)` The time that the code generation job was created.
`CodegenJob`	`withDependencies (CodegenDependency... dependencies)` Lists the dependency packages that may be required for the project code to run.
`CodegenJob`	`withDependencies (Collection<CodegenDependency> dependencies)` Lists the dependency packages that may be required for the project code to run.
`CodegenJob`	`withEnvironmentName (String environmentName)` The name of the backend environment associated with the code generation job.
`CodegenJob`	`withFeatures (CodegenFeatureFlags features)`
`CodegenJob`	`withGenericDataSchema (CodegenJobGenericDataSchema genericDataSchema)`
`CodegenJob`	`withId (String id)` The unique ID for the code generation job.
`CodegenJob`	`withModifiedAt (Date modifiedAt)` The time that the code generation job was modified.
`CodegenJob`	`withRenderConfig (CodegenJobRenderConfig renderConfig)`
`CodegenJob`	`withStatus (CodegenJobStatus status)` The status of the code generation job.
`CodegenJob`	`withStatus (String status)` The status of the code generation job.
`CodegenJob`	`withStatusMessage (String statusMessage)` The customized status message for the code generation job.
`CodegenJob`	`withTags (Map<String,String> tags)` One or more key-value pairs to use when tagging the code generation job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CodegenJob
```
public CodegenJob()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The unique ID for the code generation job.
    
    Parameters:
    
    id - The unique ID for the code generation job.
  - getId
```
public String getId()
```
    The unique ID for the code generation job.
    
    Returns:
    
    The unique ID for the code generation job.
  - withId
```
public CodegenJob withId(String id)
```
    The unique ID for the code generation job.
    
    Parameters:
    
    id - The unique ID for the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAppId
```
public void setAppId(String appId)
```
    The ID of the Amplify app associated with the code generation job.
    
    Parameters:
    
    appId - The ID of the Amplify app associated with the code generation job.
  - getAppId
```
public String getAppId()
```
    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.
  - withAppId
```
public CodegenJob withAppId(String appId)
```
    The ID of the Amplify app associated with the code generation job.
    
    Parameters:
    
    appId - The ID of the Amplify app associated with the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentName
```
public void setEnvironmentName(String environmentName)
```
    The name of the backend environment associated with the code generation job.
    
    Parameters:
    
    environmentName - The name of the backend environment associated with the code generation job.
  - getEnvironmentName
```
public String getEnvironmentName()
```
    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.
  - withEnvironmentName
```
public CodegenJob withEnvironmentName(String environmentName)
```
    The name of the backend environment associated with the code generation job.
    
    Parameters:
    
    environmentName - The name of the backend environment associated with the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRenderConfig
```
public void setRenderConfig(CodegenJobRenderConfig renderConfig)
```
    Parameters:
    
    renderConfig -
  - getRenderConfig
```
public CodegenJobRenderConfig getRenderConfig()
```
    Returns:
  - withRenderConfig
```
public CodegenJob withRenderConfig(CodegenJobRenderConfig renderConfig)
```
    Parameters:
    
    renderConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGenericDataSchema
```
public void setGenericDataSchema(CodegenJobGenericDataSchema genericDataSchema)
```
    Parameters:
    
    genericDataSchema -
  - getGenericDataSchema
```
public CodegenJobGenericDataSchema getGenericDataSchema()
```
    Returns:
  - withGenericDataSchema
```
public CodegenJob withGenericDataSchema(CodegenJobGenericDataSchema genericDataSchema)
```
    Parameters:
    
    genericDataSchema -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoGenerateForms
```
public void setAutoGenerateForms(Boolean autoGenerateForms)
```
    Specifies whether to autogenerate forms in the code generation job.
    
    Parameters:
    
    autoGenerateForms - Specifies whether to autogenerate forms in the code generation job.
  - getAutoGenerateForms
```
public Boolean getAutoGenerateForms()
```
    Specifies whether to autogenerate forms in the code generation job.
    
    Returns:
    
    Specifies whether to autogenerate forms in the code generation job.
  - withAutoGenerateForms
```
public CodegenJob withAutoGenerateForms(Boolean autoGenerateForms)
```
    Specifies whether to autogenerate forms in the code generation job.
    
    Parameters:
    
    autoGenerateForms - Specifies whether to autogenerate forms in the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutoGenerateForms
```
public Boolean isAutoGenerateForms()
```
    Specifies whether to autogenerate forms in the code generation job.
    
    Returns:
    
    Specifies whether to autogenerate forms in the code generation job.
  - setFeatures
```
public void setFeatures(CodegenFeatureFlags features)
```
    Parameters:
    
    features -
  - getFeatures
```
public CodegenFeatureFlags getFeatures()
```
    Returns:
  - withFeatures
```
public CodegenJob withFeatures(CodegenFeatureFlags features)
```
    Parameters:
    
    features -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the code generation job.
    
    Parameters:
    
    status - The status of the code generation job.
    
    See Also:
    
    CodegenJobStatus
  - getStatus
```
public String getStatus()
```
    The status of the code generation job.
    
    Returns:
    
    The status of the code generation job.
    
    See Also:
    
    CodegenJobStatus
  - withStatus
```
public CodegenJob withStatus(String status)
```
    The status of the code generation job.
    
    Parameters:
    
    status - The status of the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CodegenJobStatus
  - withStatus
```
public CodegenJob withStatus(CodegenJobStatus status)
```
    The status of the code generation job.
    
    Parameters:
    
    status - The status of the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CodegenJobStatus
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    The customized status message for the code generation job.
    
    Parameters:
    
    statusMessage - The customized status message for the code generation job.
  - getStatusMessage
```
public String getStatusMessage()
```
    The customized status message for the code generation job.
    
    Returns:
    
    The customized status message for the code generation job.
  - withStatusMessage
```
public CodegenJob withStatusMessage(String statusMessage)
```
    The customized status message for the code generation job.
    
    Parameters:
    
    statusMessage - The customized status message for the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAsset
```
public void setAsset(CodegenJobAsset asset)
```
    The CodegenJobAsset to use for the code generation job.
    
    Parameters:
    
    asset - The CodegenJobAsset to use for the code generation job.
  - getAsset
```
public CodegenJobAsset getAsset()
```
    The CodegenJobAsset to use for the code generation job.
    
    Returns:
    
    The CodegenJobAsset to use for the code generation job.
  - withAsset
```
public CodegenJob withAsset(CodegenJobAsset asset)
```
    The CodegenJobAsset to use for the code generation job.
    
    Parameters:
    
    asset - The CodegenJobAsset to use for the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    One or more key-value pairs to use when tagging the code generation job.
    
    Returns:
    
    One or more key-value pairs to use when tagging the code generation job.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    One or more key-value pairs to use when tagging the code generation job.
    
    Parameters:
    
    tags - One or more key-value pairs to use when tagging the code generation job.
  - withTags
```
public CodegenJob withTags(Map<String,String> tags)
```
    One or more key-value pairs to use when tagging the code generation job.
    
    Parameters:
    
    tags - One or more key-value pairs to use when tagging the code generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CodegenJob addTagsEntry(String key,
 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CodegenJob clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time that the code generation job was created.
    
    Parameters:
    
    createdAt - The time that the code generation job was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time that the code generation job was created.
    
    Returns:
    
    The time that the code generation job was created.
  - withCreatedAt
```
public CodegenJob withCreatedAt(Date createdAt)
```
    The time that the code generation job was created.
    
    Parameters:
    
    createdAt - The time that the code generation job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModifiedAt
```
public void setModifiedAt(Date modifiedAt)
```
    The time that the code generation job was modified.
    
    Parameters:
    
    modifiedAt - The time that the code generation job was modified.
  - getModifiedAt
```
public Date getModifiedAt()
```
    The time that the code generation job was modified.
    
    Returns:
    
    The time that the code generation job was modified.
  - withModifiedAt
```
public CodegenJob withModifiedAt(Date modifiedAt)
```
    The time that the code generation job was modified.
    
    Parameters:
    
    modifiedAt - The time that the code generation job was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDependencies
```
public List<CodegenDependency> getDependencies()
```
    Lists the dependency packages that may be required for the project code to run.
    
    Returns:
    
    Lists the dependency packages that may be required for the project code to run.
  - setDependencies
```
public void setDependencies(Collection<CodegenDependency> dependencies)
```
    Lists the dependency packages that may be required for the project code to run.
    
    Parameters:
    
    dependencies - Lists the dependency packages that may be required for the project code to run.
  - withDependencies
```
public CodegenJob withDependencies(CodegenDependency... dependencies)
```
    Lists the dependency packages that may be required for the project code to run.
    
    NOTE: This method appends the values to the existing list (if any). Use setDependencies(java.util.Collection) or withDependencies(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dependencies - Lists the dependency packages that may be required for the project code to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDependencies
```
public CodegenJob withDependencies(Collection<CodegenDependency> dependencies)
```
    Lists the dependency packages that may be required for the project code to run.
    
    Parameters:
    
    dependencies - Lists the dependency packages that may be required for the project code to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CodegenJob clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CodegenJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CodegenJob

Method Detail

setId

getId

withId

setAppId

getAppId

withAppId

setEnvironmentName

getEnvironmentName

withEnvironmentName

setRenderConfig

getRenderConfig

withRenderConfig

setGenericDataSchema

getGenericDataSchema

withGenericDataSchema

setAutoGenerateForms

getAutoGenerateForms

withAutoGenerateForms

isAutoGenerateForms

setFeatures

getFeatures

withFeatures

setStatus

getStatus

withStatus

withStatus

setStatusMessage

getStatusMessage

withStatusMessage

setAsset

getAsset

withAsset

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setCreatedAt

getCreatedAt

withCreatedAt

setModifiedAt

getModifiedAt

withModifiedAt

getDependencies

setDependencies

withDependencies

withDependencies

toString

equals

hashCode

clone

marshall