/
com.azure.mixedreality.remoterendering.models.AssetConversion.yml
116 lines (116 loc) · 9.35 KB
/
com.azure.mixedreality.remoterendering.models.AssetConversion.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
### YamlMime:JavaType
uid: "com.azure.mixedreality.remoterendering.models.AssetConversion"
fullName: "com.azure.mixedreality.remoterendering.models.AssetConversion"
name: "AssetConversion"
nameWithType: "AssetConversion"
summary: "Holds properties of a conversion."
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 final class **AssetConversion**"
constructors:
- uid: "com.azure.mixedreality.remoterendering.models.AssetConversion.AssetConversion(java.lang.String,com.azure.mixedreality.remoterendering.models.AssetConversionOptions,java.lang.String,com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError,com.azure.mixedreality.remoterendering.models.AssetConversionStatus,java.time.OffsetDateTime)"
fullName: "com.azure.mixedreality.remoterendering.models.AssetConversion.AssetConversion(String id, AssetConversionOptions options, String outputAssetUrl, RemoteRenderingServiceError error, AssetConversionStatus conversionStatus, OffsetDateTime creationTime)"
name: "AssetConversion(String id, AssetConversionOptions options, String outputAssetUrl, RemoteRenderingServiceError error, AssetConversionStatus conversionStatus, OffsetDateTime creationTime)"
nameWithType: "AssetConversion.AssetConversion(String id, AssetConversionOptions options, String outputAssetUrl, RemoteRenderingServiceError error, AssetConversionStatus conversionStatus, OffsetDateTime creationTime)"
summary: "Constructs a new Asset<wbr>Conversion object."
parameters:
- description: "The id of the conversion supplied when the conversion was created."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Options for where to retrieve input files from and where to write output files."
name: "options"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversionOptions?alt=com.azure.mixedreality.remoterendering.models.AssetConversionOptions&text=AssetConversionOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "URL of the asset generated by the conversion process. Only present when the status of\n the conversion is 'Succeeded'."
name: "outputAssetUrl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The error object containing details about the conversion failure."
name: "error"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError?alt=com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError&text=RemoteRenderingServiceError\" data-throw-if-not-resolved=\"False\" />"
- description: "The status of the conversion. Terminal states are CANCELLED, FAILED, or SUCCEEDED."
name: "conversionStatus"
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversionStatus?alt=com.azure.mixedreality.remoterendering.models.AssetConversionStatus&text=AssetConversionStatus\" data-throw-if-not-resolved=\"False\" />"
- description: "The time when the conversion was created. Date and time in ISO 8601 format."
name: "creationTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public AssetConversion(String id, AssetConversionOptions options, String outputAssetUrl, RemoteRenderingServiceError error, AssetConversionStatus conversionStatus, OffsetDateTime creationTime)"
desc: "Constructs a new AssetConversion object."
methods:
- uid: "com.azure.mixedreality.remoterendering.models.AssetConversion.getCreationTime()"
fullName: "com.azure.mixedreality.remoterendering.models.AssetConversion.getCreationTime()"
name: "getCreationTime()"
nameWithType: "AssetConversion.getCreationTime()"
summary: "Get the creation<wbr>Time property: The time when the conversion was created."
syntax: "public OffsetDateTime getCreationTime()"
desc: "Get the creationTime property: The time when the conversion was created. Date and time in ISO 8601 format."
returns:
description: "the creationTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.mixedreality.remoterendering.models.AssetConversion.getError()"
fullName: "com.azure.mixedreality.remoterendering.models.AssetConversion.getError()"
name: "getError()"
nameWithType: "AssetConversion.getError()"
summary: "Get the error property: The error object containing details about the conversion failure."
syntax: "public RemoteRenderingServiceError getError()"
desc: "Get the error property: The error object containing details about the conversion failure."
returns:
description: "the error value."
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError?alt=com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError&text=RemoteRenderingServiceError\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.models.AssetConversion.getId()"
fullName: "com.azure.mixedreality.remoterendering.models.AssetConversion.getId()"
name: "getId()"
nameWithType: "AssetConversion.getId()"
summary: "Get the id property: The id of the conversion supplied when the conversion was created."
syntax: "public String getId()"
desc: "Get the id property: The id of the conversion supplied when the conversion was created."
returns:
description: "the id value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.mixedreality.remoterendering.models.AssetConversion.getOptions()"
fullName: "com.azure.mixedreality.remoterendering.models.AssetConversion.getOptions()"
name: "getOptions()"
nameWithType: "AssetConversion.getOptions()"
summary: "Get the conversion options: Options for where to retrieve input files from and where to write output files."
syntax: "public AssetConversionOptions getOptions()"
desc: "Get the conversion options: Options for where to retrieve input files from and where to write output files. Supplied when creating the conversion."
returns:
description: "the conversion options value."
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversionOptions?alt=com.azure.mixedreality.remoterendering.models.AssetConversionOptions&text=AssetConversionOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.mixedreality.remoterendering.models.AssetConversion.getOutputAssetUrl()"
fullName: "com.azure.mixedreality.remoterendering.models.AssetConversion.getOutputAssetUrl()"
name: "getOutputAssetUrl()"
nameWithType: "AssetConversion.getOutputAssetUrl()"
summary: "Get the output<wbr>Asset<wbr>Url property: URL of the asset generated by the conversion process."
syntax: "public String getOutputAssetUrl()"
desc: "Get the outputAssetUrl property: URL of the asset generated by the conversion process. Only present when the status of the conversion is 'Succeeded'."
returns:
description: "the outputAssetUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.mixedreality.remoterendering.models.AssetConversion.getStatus()"
fullName: "com.azure.mixedreality.remoterendering.models.AssetConversion.getStatus()"
name: "getStatus()"
nameWithType: "AssetConversion.getStatus()"
summary: "Get the status property: The status of the conversion."
syntax: "public AssetConversionStatus getStatus()"
desc: "Get the status property: The status of the conversion. Terminal states are CANCELLED, FAILED, or SUCCEEDED."
returns:
description: "the status value."
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.AssetConversionStatus?alt=com.azure.mixedreality.remoterendering.models.AssetConversionStatus&text=AssetConversionStatus\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Holds properties of a conversion."
metadata: {}
package: "com.azure.mixedreality.remoterendering.models"
artifact: com.azure:azure-mixedreality-remoterendering:1.1.28