Class CodegenJob
- java.lang.Object
-
- software.amazon.awssdk.services.amplifyuibuilder.model.CodegenJob
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CodegenJob.Builder,CodegenJob>
@Generated("software.amazon.awssdk:codegen") public final class CodegenJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CodegenJob.Builder,CodegenJob>
Describes the configuration for a code generation job that is associated with an Amplify app.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCodegenJob.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringappId()The ID of the Amplify app associated with the code generation job.CodegenJobAssetasset()TheCodegenJobAssetto use for the code generation job.BooleanautoGenerateForms()Specifies whether to autogenerate forms in the code generation job.static CodegenJob.Builderbuilder()InstantcreatedAt()The time that the code generation job was created.List<CodegenDependency>dependencies()Lists the dependency packages that may be required for the project code to run.StringenvironmentName()The name of the backend environment associated with the code generation job.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)CodegenFeatureFlagsfeatures()Returns the value of the Features property for this object.CodegenJobGenericDataSchemagenericDataSchema()Returns the value of the GenericDataSchema property for this object.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDependencies()For responses, this returns true if the service returned a value for the Dependencies property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringid()The unique ID for the code generation job.InstantmodifiedAt()The time that the code generation job was modified.CodegenJobRenderConfigrenderConfig()Returns the value of the RenderConfig property for this object.List<SdkField<?>>sdkFields()static Class<? extends CodegenJob.Builder>serializableBuilderClass()CodegenJobStatusstatus()The status of the code generation job.StringstatusAsString()The status of the code generation job.StringstatusMessage()The customized status message for the code generation job.Map<String,String>tags()One or more key-value pairs to use when tagging the code generation job.CodegenJob.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
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.
-
status
public final CodegenJobStatus status()
The status of the code generation job.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnCodegenJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the code generation job.
- See Also:
CodegenJobStatus
-
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,
statuswill returnCodegenJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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
CodegenJobAssetto use for the code generation job.- Returns:
- The
CodegenJobAssetto 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 theisEmpty()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 theisEmpty()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.
-
toBuilder
public CodegenJob.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CodegenJob.Builder,CodegenJob>
-
builder
public static CodegenJob.Builder builder()
-
serializableBuilderClass
public static Class<? extends CodegenJob.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-