-
Notifications
You must be signed in to change notification settings - Fork 262
/
JobOutputStorage.xml
236 lines (236 loc) · 18.1 KB
/
JobOutputStorage.xml
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<Type Name="JobOutputStorage" FullName="Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage">
<TypeSignature Language="C#" Value="public class JobOutputStorage" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JobOutputStorage extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage" />
<TypeSignature Language="VB.NET" Value="Public Class JobOutputStorage" />
<TypeSignature Language="F#" Value="type JobOutputStorage = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>3.5.1.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents persistent storage for the outputs of an Azure Batch job.
</summary>
<remarks>
Job outputs refer to output data logically associated with the entire job, rather than
a particular task. For example, in a movie rendering job, if a task combined all the frames
into a movie, that would logically be a job output. The purpose of categorising an
output as a 'job' output is to save the client from having to know which task produced it.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobOutputStorage (Uri jobOutputContainerUri);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri jobOutputContainerUri) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage.#ctor(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (jobOutputContainerUri As Uri)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage : Uri -> Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage" Usage="new Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage jobOutputContainerUri" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="jobOutputContainerUri" Type="System.Uri" />
</Parameters>
<Docs>
<param name="jobOutputContainerUri">The URL in Azure storage of the blob container to
use for job outputs. This URL must contain a SAS (Shared Access Signature) granting
access to the container, or the container must be public.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage" /> class from a URL representing
the job output container.
</summary>
<remarks>The container must already exist; the JobOutputStorage class does not create
it for you.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobOutputStorage (Azure.Storage.Blobs.BlobServiceClient blobClient, string jobId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Storage.Blobs.BlobServiceClient blobClient, string jobId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage.#ctor(Azure.Storage.Blobs.BlobServiceClient,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (blobClient As BlobServiceClient, jobId As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage : Azure.Storage.Blobs.BlobServiceClient * string -> Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage" Usage="new Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage (blobClient, jobId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="blobClient" Type="Azure.Storage.Blobs.BlobServiceClient" />
<Parameter Name="jobId" Type="System.String" />
</Parameters>
<Docs>
<param name="blobClient">The blob service client linked to the Azure Batch Storage Account.</param>
<param name="jobId">The id of the Azure Batch job.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage" /> class from a storage account
and job id.
</summary>
<remarks>The job output container must already exist; the JobOutputStorage class does not create
it for you.</remarks>
</Docs>
</Member>
<Member MemberName="GetOutput">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Conventions.Files.OutputFileReference GetOutput (Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind, string filePath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.Conventions.Files.OutputFileReference GetOutput(class Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind, string filePath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage.GetOutput(Microsoft.Azure.Batch.Conventions.Files.JobOutputKind,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOutput (kind As JobOutputKind, filePath As String) As OutputFileReference" />
<MemberSignature Language="F#" Value="member this.GetOutput : Microsoft.Azure.Batch.Conventions.Files.JobOutputKind * string -> Microsoft.Azure.Batch.Conventions.Files.OutputFileReference" Usage="jobOutputStorage.GetOutput (kind, filePath)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Conventions.Files.OutputFileReference</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="kind" Type="Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" />
<Parameter Name="filePath" Type="System.String" />
</Parameters>
<Docs>
<param name="kind">A <see cref="T:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" /> representing the category of the output to
retrieve, for example <see cref="F:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind.JobOutput" /> or <see cref="F:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind.JobPreview" />.</param>
<param name="filePath">The path under which the output was persisted in blob storage.</param>
<summary>
Retrieves a job output from Azure blob storage by kind and path.
</summary>
<returns>A reference to the requested file in Azure blob storage.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetOutputStoragePath">
<MemberSignature Language="C#" Value="public string GetOutputStoragePath (Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetOutputStoragePath(class Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage.GetOutputStoragePath(Microsoft.Azure.Batch.Conventions.Files.JobOutputKind)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOutputStoragePath (kind As JobOutputKind) As String" />
<MemberSignature Language="F#" Value="member this.GetOutputStoragePath : Microsoft.Azure.Batch.Conventions.Files.JobOutputKind -> string" Usage="jobOutputStorage.GetOutputStoragePath kind" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="kind" Type="Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" />
</Parameters>
<Docs>
<param name="kind">The output kind.</param>
<summary>
Gets the Blob name prefix/folder where files of the given kind are stored
</summary>
<returns>The Blob name prefix/folder where files of the given kind are stored.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListOutputs">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.Conventions.Files.OutputFileReference> ListOutputs (Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.Conventions.Files.OutputFileReference> ListOutputs(class Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage.ListOutputs(Microsoft.Azure.Batch.Conventions.Files.JobOutputKind)" />
<MemberSignature Language="VB.NET" Value="Public Function ListOutputs (kind As JobOutputKind) As IEnumerable(Of OutputFileReference)" />
<MemberSignature Language="F#" Value="member this.ListOutputs : Microsoft.Azure.Batch.Conventions.Files.JobOutputKind -> seq<Microsoft.Azure.Batch.Conventions.Files.OutputFileReference>" Usage="jobOutputStorage.ListOutputs kind" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.Conventions.Files.OutputFileReference></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="kind" Type="Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" />
</Parameters>
<Docs>
<param name="kind">A <see cref="T:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" /> representing the category of outputs to
list, for example <see cref="F:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind.JobOutput" /> or <see cref="F:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind.JobPreview" />.</param>
<summary>
Lists the job outputs of the specified kind.
</summary>
<returns>A list of persisted job outputs of the specified kind.</returns>
<remarks>The list is retrieved lazily from Azure blob storage when it is enumerated.</remarks>
</Docs>
</Member>
<Member MemberName="SaveAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SaveAsync (Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind, string relativePath, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task SaveAsync(class Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind, string relativePath, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage.SaveAsync(Microsoft.Azure.Batch.Conventions.Files.JobOutputKind,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SaveAsync (kind As JobOutputKind, relativePath As String, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="member this.SaveAsync : Microsoft.Azure.Batch.Conventions.Files.JobOutputKind * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="jobOutputStorage.SaveAsync (kind, relativePath, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="kind" Type="Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" />
<Parameter Name="relativePath" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="kind">A <see cref="T:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" /> representing the category under which to
store this file, for example <see cref="F:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind.JobOutput" /> or <see cref="F:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind.JobPreview" />.</param>
<param name="relativePath">The path of the file to save, relative to the current directory.
If the file is in a subdirectory of the current directory, the relative path will be preserved
in blob storage.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param>
<summary>
Saves the specified file to persistent storage.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns>
<remarks>If the file is outside the current directory, traversals up the directory tree are removed.
For example, a <paramref name="relativePath" /> of "..\ProcessEnv.cmd" would be treated as "ProcessEnv.cmd"
for the purposes of creating a blob name.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="kind" /> or <paramref name="relativePath" /> argument is null.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="relativePath" /> argument is an absolute path, or is empty.</exception>
</Docs>
</Member>
<Member MemberName="SaveAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SaveAsync (Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind, string sourcePath, string destinationRelativePath, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task SaveAsync(class Microsoft.Azure.Batch.Conventions.Files.JobOutputKind kind, string sourcePath, string destinationRelativePath, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Conventions.Files.JobOutputStorage.SaveAsync(Microsoft.Azure.Batch.Conventions.Files.JobOutputKind,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SaveAsync (kind As JobOutputKind, sourcePath As String, destinationRelativePath As String, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="member this.SaveAsync : Microsoft.Azure.Batch.Conventions.Files.JobOutputKind * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="jobOutputStorage.SaveAsync (kind, sourcePath, destinationRelativePath, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="kind" Type="Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" />
<Parameter Name="sourcePath" Type="System.String" />
<Parameter Name="destinationRelativePath" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="kind">A <see cref="T:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind" /> representing the category under which to
store this file, for example <see cref="F:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind.JobOutput" /> or <see cref="F:Microsoft.Azure.Batch.Conventions.Files.JobOutputKind.JobPreview" />.</param>
<param name="sourcePath">The path of the file to save.</param>
<param name="destinationRelativePath">The blob name under which to save the file. This may include a
relative component, such as "pointclouds/pointcloud_0001.txt".</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param>
<summary>
Saves the specified file to persistent storage.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="kind" />, <paramref name="sourcePath" />, or <paramref name="destinationRelativePath" /> argument is null.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="sourcePath" /> or <paramref name="destinationRelativePath" /> argument is empty.</exception>
</Docs>
</Member>
</Members>
</Type>