-
Notifications
You must be signed in to change notification settings - Fork 244
/
com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.yml
137 lines (137 loc) · 9.3 KB
/
com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
### YamlMime:JavaType
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails"
name: "OperationDetails"
nameWithType: "OperationDetails"
summary: "The Operation<wbr>Details model."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **OperationDetails**"
constructors:
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.OperationDetails()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.OperationDetails()"
name: "OperationDetails()"
nameWithType: "OperationDetails.OperationDetails()"
summary: "Creates an instance of Operation<wbr>Details."
syntax: "public OperationDetails()"
desc: "Creates an instance of OperationDetails."
methods:
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getCreatedOn()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getCreatedOn()"
name: "getCreatedOn()"
nameWithType: "OperationDetails.getCreatedOn()"
summary: "Get the Date and time (UTC) when the analyze operation was submitted."
syntax: "public OffsetDateTime getCreatedOn()"
desc: "Get the Date and time (UTC) when the analyze operation was submitted."
returns:
description: "the createdDateTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getError()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getError()"
name: "getError()"
nameWithType: "OperationDetails.getError()"
summary: "Get the error property: Encountered error."
syntax: "public ResponseError getError()"
desc: "Get the error property: Encountered error."
returns:
description: "the error value."
type: "<xref href=\"com.azure.core.models.ResponseError?alt=com.azure.core.models.ResponseError&text=ResponseError\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getKind()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getKind()"
name: "getKind()"
nameWithType: "OperationDetails.getKind()"
summary: "Get the kind property: Type of operation."
syntax: "public OperationKind getKind()"
desc: "Get the kind property: Type of operation."
returns:
description: "the kind value."
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationKind&text=OperationKind\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getLastUpdatedOn()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getLastUpdatedOn()"
name: "getLastUpdatedOn()"
nameWithType: "OperationDetails.getLastUpdatedOn()"
summary: "Get the last<wbr>Updated<wbr>Date<wbr>Time property: Date and time (UTC) when the status was last updated."
syntax: "public OffsetDateTime getLastUpdatedOn()"
desc: "Get the lastUpdatedDateTime property: Date and time (UTC) when the status was last updated."
returns:
description: "the lastUpdatedDateTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getOperationId()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getOperationId()"
name: "getOperationId()"
nameWithType: "OperationDetails.getOperationId()"
summary: "Get the operation<wbr>Id property: Operation ID."
syntax: "public String getOperationId()"
desc: "Get the operationId property: Operation ID."
returns:
description: "the operationId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getPercentCompleted()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getPercentCompleted()"
name: "getPercentCompleted()"
nameWithType: "OperationDetails.getPercentCompleted()"
summary: "Get the percent<wbr>Completed property: Operation progress (0-100)."
syntax: "public Integer getPercentCompleted()"
desc: "Get the percentCompleted property: Operation progress (0-100)."
returns:
description: "the percentCompleted value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getResourceLocation()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getResourceLocation()"
name: "getResourceLocation()"
nameWithType: "OperationDetails.getResourceLocation()"
summary: "Get the resource<wbr>Location property: URL of the resource targeted by this operation."
syntax: "public String getResourceLocation()"
desc: "Get the resourceLocation property: URL of the resource targeted by this operation."
returns:
description: "the resourceLocation value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion()"
name: "getServiceVersion()"
nameWithType: "OperationDetails.getServiceVersion()"
summary: "Get the Service version used to create this document classifier."
syntax: "public String getServiceVersion()"
desc: "Get the Service version used to create this document classifier."
returns:
description: "the serviceVersion value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus()"
name: "getStatus()"
nameWithType: "OperationDetails.getStatus()"
summary: "Get the status property: Operation status."
syntax: "public OperationStatus getStatus()"
desc: "Get the status property: Operation status."
returns:
description: "the status value."
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationStatus?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationStatus&text=OperationStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getTags()"
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getTags()"
name: "getTags()"
nameWithType: "OperationDetails.getTags()"
summary: "Get the list of key-value tag attributes associated with the document model."
syntax: "public Map<String,String> getTags()"
desc: "Get the list of key-value tag attributes associated with the document model."
returns:
description: "the tags value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
type: "class"
desc: "The OperationDetails model."
metadata: {}
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
artifact: com.azure:azure-ai-formrecognizer:4.1.9