Class JobConfiguration
java.lang.Object
com.azure.resourcemanager.appcontainers.models.JobConfiguration
- All Implemented Interfaces:
com.azure.json.JsonSerializable<JobConfiguration>
public final class JobConfiguration
extends Object
implements com.azure.json.JsonSerializable<JobConfiguration>
Non versioned Container Apps Job configuration properties.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the eventTriggerConfig property: Trigger configuration of an event driven job.static JobConfigurationfromJson(com.azure.json.JsonReader jsonReader) Reads an instance of JobConfiguration from the JsonReader.Get the identitySettings property: Optional settings for Managed Identities that are assigned to the Container App Job.Get the manualTriggerConfig property: Manual trigger configuration for a single execution job.Get the registries property: Collection of private container registry credentials used by a Container apps job.Get the replicaRetryLimit property: Maximum number of retries before failing the job.intGet the replicaTimeout property: Maximum number of seconds a replica is allowed to run.Get the scheduleTriggerConfig property: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs.secrets()Get the secrets property: Collection of secrets used by a Container Apps Job.com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) Get the triggerType property: Trigger type of the job.voidvalidate()Validates the instance.withEventTriggerConfig(JobConfigurationEventTriggerConfig eventTriggerConfig) Set the eventTriggerConfig property: Trigger configuration of an event driven job.withIdentitySettings(List<IdentitySettings> identitySettings) Set the identitySettings property: Optional settings for Managed Identities that are assigned to the Container App Job.withManualTriggerConfig(JobConfigurationManualTriggerConfig manualTriggerConfig) Set the manualTriggerConfig property: Manual trigger configuration for a single execution job.withRegistries(List<RegistryCredentials> registries) Set the registries property: Collection of private container registry credentials used by a Container apps job.withReplicaRetryLimit(Integer replicaRetryLimit) Set the replicaRetryLimit property: Maximum number of retries before failing the job.withReplicaTimeout(int replicaTimeout) Set the replicaTimeout property: Maximum number of seconds a replica is allowed to run.withScheduleTriggerConfig(JobConfigurationScheduleTriggerConfig scheduleTriggerConfig) Set the scheduleTriggerConfig property: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs.withSecrets(List<Secret> secrets) Set the secrets property: Collection of secrets used by a Container Apps Job.withTriggerType(TriggerType triggerType) Set the triggerType property: Trigger type of the job.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
JobConfiguration
public JobConfiguration()Creates an instance of JobConfiguration class.
-
-
Method Details
-
secrets
Get the secrets property: Collection of secrets used by a Container Apps Job.- Returns:
- the secrets value.
-
withSecrets
Set the secrets property: Collection of secrets used by a Container Apps Job.- Parameters:
secrets- the secrets value to set.- Returns:
- the JobConfiguration object itself.
-
triggerType
Get the triggerType property: Trigger type of the job.- Returns:
- the triggerType value.
-
withTriggerType
Set the triggerType property: Trigger type of the job.- Parameters:
triggerType- the triggerType value to set.- Returns:
- the JobConfiguration object itself.
-
replicaTimeout
public int replicaTimeout()Get the replicaTimeout property: Maximum number of seconds a replica is allowed to run.- Returns:
- the replicaTimeout value.
-
withReplicaTimeout
Set the replicaTimeout property: Maximum number of seconds a replica is allowed to run.- Parameters:
replicaTimeout- the replicaTimeout value to set.- Returns:
- the JobConfiguration object itself.
-
replicaRetryLimit
Get the replicaRetryLimit property: Maximum number of retries before failing the job.- Returns:
- the replicaRetryLimit value.
-
withReplicaRetryLimit
Set the replicaRetryLimit property: Maximum number of retries before failing the job.- Parameters:
replicaRetryLimit- the replicaRetryLimit value to set.- Returns:
- the JobConfiguration object itself.
-
manualTriggerConfig
Get the manualTriggerConfig property: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default.- Returns:
- the manualTriggerConfig value.
-
withManualTriggerConfig
public JobConfiguration withManualTriggerConfig(JobConfigurationManualTriggerConfig manualTriggerConfig) Set the manualTriggerConfig property: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default.- Parameters:
manualTriggerConfig- the manualTriggerConfig value to set.- Returns:
- the JobConfiguration object itself.
-
scheduleTriggerConfig
Get the scheduleTriggerConfig property: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default.- Returns:
- the scheduleTriggerConfig value.
-
withScheduleTriggerConfig
public JobConfiguration withScheduleTriggerConfig(JobConfigurationScheduleTriggerConfig scheduleTriggerConfig) Set the scheduleTriggerConfig property: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default.- Parameters:
scheduleTriggerConfig- the scheduleTriggerConfig value to set.- Returns:
- the JobConfiguration object itself.
-
eventTriggerConfig
Get the eventTriggerConfig property: Trigger configuration of an event driven job.- Returns:
- the eventTriggerConfig value.
-
withEventTriggerConfig
public JobConfiguration withEventTriggerConfig(JobConfigurationEventTriggerConfig eventTriggerConfig) Set the eventTriggerConfig property: Trigger configuration of an event driven job.- Parameters:
eventTriggerConfig- the eventTriggerConfig value to set.- Returns:
- the JobConfiguration object itself.
-
registries
Get the registries property: Collection of private container registry credentials used by a Container apps job.- Returns:
- the registries value.
-
withRegistries
Set the registries property: Collection of private container registry credentials used by a Container apps job.- Parameters:
registries- the registries value to set.- Returns:
- the JobConfiguration object itself.
-
identitySettings
Get the identitySettings property: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used.- Returns:
- the identitySettings value.
-
withIdentitySettings
Set the identitySettings property: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used.- Parameters:
identitySettings- the identitySettings value to set.- Returns:
- the JobConfiguration object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
toJson
- Specified by:
toJsonin interfacecom.azure.json.JsonSerializable<JobConfiguration>- Throws:
IOException
-
fromJson
Reads an instance of JobConfiguration from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of JobConfiguration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IllegalStateException- If the deserialized JSON object was missing any required properties.IOException- If an error occurs while reading the JobConfiguration.
-