Share via

OutputFile Class

Package:
com.azure.compute.batch.models
Maven Artifact:
com.azure:azure-compute-batch:1.0.0-beta.5
  • java.lang.Object
    • com.azure.compute.batch.models.OutputFile

Implements

JsonSerializable<OutputFile>

public final class OutputFile
implements JsonSerializable<OutputFile>

On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure.

Constructor Summary

Constructor Description
OutputFile(String filePattern, OutputFileDestination destination, OutputFileUploadConfig uploadOptions)

Creates an instance of OutputFile class.

Method Summary

Modifier and Type Method and Description
static OutputFile fromJson(JsonReader jsonReader)

Reads an instance of OutputFile from the JsonReader.
OutputFileDestination getDestination()

Get the destination property: The destination for the output file(s).
String getFilePattern()

Get the filePattern property: A pattern indicating which file(s) to upload.
OutputFileUploadConfig getUploadOptions()

Get the uploadOptions property: Additional options for the upload operation, including under what conditions to perform the upload.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

OutputFile

public OutputFile(String filePattern, OutputFileDestination destination, OutputFileUploadConfig uploadOptions)

Creates an instance of OutputFile class.

Parameters:

filePattern - the filePattern value to set.
destination - the destination value to set.
uploadOptions - the uploadOptions value to set.

Method Details

fromJson

public static OutputFile fromJson(JsonReader jsonReader)

Reads an instance of OutputFile from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OutputFile if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getDestination

public OutputFileDestination getDestination()

Get the destination property: The destination for the output file(s).

Returns:

the destination value.

getFilePattern

public String getFilePattern()

Get the filePattern property: A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with "." it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\*.txt matches any file that does not start in '.' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied.

Returns:

the filePattern value.

getUploadOptions

public OutputFileUploadConfig getUploadOptions()

Get the uploadOptions property: Additional options for the upload operation, including under what conditions to perform the upload.

Returns:

the uploadOptions value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to