Class BatchTaskEnvironment

A batch task environment resource defines the software that is used to execute tasks. It mainly contains a URL to a container image along with other configurations that are needed by the image.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance

object

BatchTaskEnvironment

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.BatchService.Models

Assembly: OCI.DotNetSDK.Batch.dll

Syntax

public class BatchTaskEnvironment

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

DefinedTags

Declaration

[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The batch task environment description.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string

FreeformTags

Declaration

[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the batch task environment.

Remarks

Required

ImageUrl

Declaration

[Required(ErrorMessage = "ImageUrl is required.")]
[JsonProperty(PropertyName = "imageUrl")]
public string ImageUrl { get; set; }

Property Value

Type	Description
string	The URL of the ocir image.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public BatchTaskEnvironment.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
BatchTaskEnvironment.LifecycleStateEnum?	The current state of the batch task environment.

Remarks

Required

SecurityContext

Declaration

[JsonProperty(PropertyName = "securityContext")]
public SecurityContext SecurityContext { get; set; }

Property Value

Type	Description
SecurityContext

SystemTags

Declaration

[Required(ErrorMessage = "SystemTags is required.")]
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Volumes

Declaration

[Required(ErrorMessage = "Volumes is required.")]
[JsonProperty(PropertyName = "volumes")]
public List<BatchTaskEnvironmentVolume> Volumes { get; set; }

Property Value

Type	Description
List<BatchTaskEnvironmentVolume>	List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.

Remarks

Required

WorkingDirectory

Declaration

[JsonProperty(PropertyName = "workingDirectory")]
public string WorkingDirectory { get; set; }

Property Value

Type	Description
string	Container's working directory.