Class DocumentJob

The job details for a batch document analysis.

Inheritance

object

DocumentJob

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.AivisionService.Models

Assembly: OCI.DotNetSDK.Aivision.dll

Syntax

public class DocumentJob

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 that starts the job.

Remarks

Required

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The document job display name.

DocumentType

Declaration

[JsonProperty(PropertyName = "documentType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DocumentType? DocumentType { get; set; }

Property Value

Type	Description
DocumentType?	The type of document.

Features

Declaration

[Required(ErrorMessage = "Features is required.")]
[JsonProperty(PropertyName = "features")]
public List<DocumentFeature> Features { get; set; }

Property Value

Type	Description
List<DocumentFeature>	The list of requested document analysis types.

Remarks

Required

Id

Declaration

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

Property Value

Type	Description
string	The job id.

Remarks

Required

InputLocation

Declaration

[JsonProperty(PropertyName = "inputLocation")]
public InputLocation InputLocation { get; set; }

Property Value

Type	Description
InputLocation

IsZipOutputEnabled

Declaration

[JsonProperty(PropertyName = "isZipOutputEnabled")]
public bool? IsZipOutputEnabled { get; set; }

Property Value

Type	Description
bool?	Whether or not to generate a ZIP file containing the results.

Language

Declaration

[JsonProperty(PropertyName = "language")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DocumentLanguage? Language { get; set; }

Property Value

Type	Description
DocumentLanguage?	The document language, abbreviated according to ISO 639-2.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DocumentJob.LifecycleDetailsEnum? LifecycleDetails { get; set; }

Property Value

Type	Description
DocumentJob.LifecycleDetailsEnum?	The detailed status of FAILED state.

LifecycleState

Declaration

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

Property Value

Type	Description
DocumentJob.LifecycleStateEnum?	The current state of the batch document job.

Remarks

Required

OutputLocation

Declaration

[Required(ErrorMessage = "OutputLocation is required.")]
[JsonProperty(PropertyName = "outputLocation")]
public OutputLocation OutputLocation { get; set; }

Property Value

Type	Description
OutputLocation

Remarks

Required

PercentComplete

Declaration

[JsonProperty(PropertyName = "percentComplete")]
public float? PercentComplete { get; set; }

Property Value

Type	Description
float?	How much progress the operation has made, compared to the total amount of work to be performed.

TimeAccepted

Declaration

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

Property Value

Type	Description
DateTime?	The job acceptance time.

Remarks

Required

TimeFinished

Declaration

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

Property Value

Type	Description
DateTime?	The job finish time.

TimeStarted

Declaration

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

Property Value

Type	Description
DateTime?	The job start time.