156 строки
13 KiB
YAML
156 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.ExitConditions"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions"
|
|
name: "ExitConditions"
|
|
nameWithType: "ExitConditions"
|
|
summary: "Specifies how the Batch service should respond when the Task completes."
|
|
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 **ExitConditions**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.ExitConditions()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.ExitConditions()"
|
|
name: "ExitConditions()"
|
|
nameWithType: "ExitConditions.ExitConditions()"
|
|
syntax: "public ExitConditions()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.defaultProperty()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.defaultProperty()"
|
|
name: "defaultProperty()"
|
|
nameWithType: "ExitConditions.defaultProperty()"
|
|
summary: "Get this value is used if the Task exits with any nonzero exit code not listed in the exit<wbr>Codes or exit<wbr>Code<wbr>Ranges collection, with a pre-processing error if the pre<wbr>Processing<wbr>Error property is not present, or with a file upload error if the file<wbr>Upload<wbr>Error property is not present."
|
|
syntax: "public ExitOptions defaultProperty()"
|
|
desc: "Get this value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection."
|
|
returns:
|
|
description: "the defaultProperty value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitOptions?alt=com.microsoft.azure.batch.protocol.models.ExitOptions&text=ExitOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.exitCodeRanges()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.exitCodeRanges()"
|
|
name: "exitCodeRanges()"
|
|
nameWithType: "ExitConditions.exitCodeRanges()"
|
|
summary: "Get the exit<wbr>Code<wbr>Ranges value."
|
|
syntax: "public List<ExitCodeRangeMapping> exitCodeRanges()"
|
|
desc: "Get the exitCodeRanges value."
|
|
returns:
|
|
description: "the exitCodeRanges value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.ExitCodeRangeMapping?alt=com.microsoft.azure.batch.protocol.models.ExitCodeRangeMapping&text=ExitCodeRangeMapping\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.exitCodes()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.exitCodes()"
|
|
name: "exitCodes()"
|
|
nameWithType: "ExitConditions.exitCodes()"
|
|
summary: "Get the exit<wbr>Codes value."
|
|
syntax: "public List<ExitCodeMapping> exitCodes()"
|
|
desc: "Get the exitCodes value."
|
|
returns:
|
|
description: "the exitCodes value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.ExitCodeMapping?alt=com.microsoft.azure.batch.protocol.models.ExitCodeMapping&text=ExitCodeMapping\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.fileUploadError()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.fileUploadError()"
|
|
name: "fileUploadError()"
|
|
nameWithType: "ExitConditions.fileUploadError()"
|
|
summary: "Get if the Task exited with an exit code that was specified via exit<wbr>Codes or exit<wbr>Code<wbr>Ranges, and then encountered a file upload error, then the action specified by the exit code takes precedence."
|
|
syntax: "public ExitOptions fileUploadError()"
|
|
desc: "Get if the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence."
|
|
returns:
|
|
description: "the fileUploadError value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitOptions?alt=com.microsoft.azure.batch.protocol.models.ExitOptions&text=ExitOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.preProcessingError()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.preProcessingError()"
|
|
name: "preProcessingError()"
|
|
nameWithType: "ExitConditions.preProcessingError()"
|
|
summary: "Get the pre<wbr>Processing<wbr>Error value."
|
|
syntax: "public ExitOptions preProcessingError()"
|
|
desc: "Get the preProcessingError value."
|
|
returns:
|
|
description: "the preProcessingError value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitOptions?alt=com.microsoft.azure.batch.protocol.models.ExitOptions&text=ExitOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.withDefaultProperty(com.microsoft.azure.batch.protocol.models.ExitOptions)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.withDefaultProperty(ExitOptions defaultProperty)"
|
|
name: "withDefaultProperty(ExitOptions defaultProperty)"
|
|
nameWithType: "ExitConditions.withDefaultProperty(ExitOptions defaultProperty)"
|
|
summary: "Set this value is used if the Task exits with any nonzero exit code not listed in the exit<wbr>Codes or exit<wbr>Code<wbr>Ranges collection, with a pre-processing error if the pre<wbr>Processing<wbr>Error property is not present, or with a file upload error if the file<wbr>Upload<wbr>Error property is not present."
|
|
parameters:
|
|
- description: "the defaultProperty value to set"
|
|
name: "defaultProperty"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitOptions?alt=com.microsoft.azure.batch.protocol.models.ExitOptions&text=ExitOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ExitConditions withDefaultProperty(ExitOptions defaultProperty)"
|
|
desc: "Set this value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection."
|
|
returns:
|
|
description: "the ExitConditions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitConditions?alt=com.microsoft.azure.batch.protocol.models.ExitConditions&text=ExitConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.withExitCodeRanges(java.util.List<com.microsoft.azure.batch.protocol.models.ExitCodeRangeMapping>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.withExitCodeRanges(List<ExitCodeRangeMapping> exitCodeRanges)"
|
|
name: "withExitCodeRanges(List<ExitCodeRangeMapping> exitCodeRanges)"
|
|
nameWithType: "ExitConditions.withExitCodeRanges(List<ExitCodeRangeMapping> exitCodeRanges)"
|
|
summary: "Set the exit<wbr>Code<wbr>Ranges value."
|
|
parameters:
|
|
- description: "the exitCodeRanges value to set"
|
|
name: "exitCodeRanges"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.ExitCodeRangeMapping?alt=com.microsoft.azure.batch.protocol.models.ExitCodeRangeMapping&text=ExitCodeRangeMapping\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ExitConditions withExitCodeRanges(List<ExitCodeRangeMapping> exitCodeRanges)"
|
|
desc: "Set the exitCodeRanges value."
|
|
returns:
|
|
description: "the ExitConditions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitConditions?alt=com.microsoft.azure.batch.protocol.models.ExitConditions&text=ExitConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.withExitCodes(java.util.List<com.microsoft.azure.batch.protocol.models.ExitCodeMapping>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.withExitCodes(List<ExitCodeMapping> exitCodes)"
|
|
name: "withExitCodes(List<ExitCodeMapping> exitCodes)"
|
|
nameWithType: "ExitConditions.withExitCodes(List<ExitCodeMapping> exitCodes)"
|
|
summary: "Set the exit<wbr>Codes value."
|
|
parameters:
|
|
- description: "the exitCodes value to set"
|
|
name: "exitCodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.ExitCodeMapping?alt=com.microsoft.azure.batch.protocol.models.ExitCodeMapping&text=ExitCodeMapping\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ExitConditions withExitCodes(List<ExitCodeMapping> exitCodes)"
|
|
desc: "Set the exitCodes value."
|
|
returns:
|
|
description: "the ExitConditions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitConditions?alt=com.microsoft.azure.batch.protocol.models.ExitConditions&text=ExitConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.withFileUploadError(com.microsoft.azure.batch.protocol.models.ExitOptions)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.withFileUploadError(ExitOptions fileUploadError)"
|
|
name: "withFileUploadError(ExitOptions fileUploadError)"
|
|
nameWithType: "ExitConditions.withFileUploadError(ExitOptions fileUploadError)"
|
|
summary: "Set if the Task exited with an exit code that was specified via exit<wbr>Codes or exit<wbr>Code<wbr>Ranges, and then encountered a file upload error, then the action specified by the exit code takes precedence."
|
|
parameters:
|
|
- description: "the fileUploadError value to set"
|
|
name: "fileUploadError"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitOptions?alt=com.microsoft.azure.batch.protocol.models.ExitOptions&text=ExitOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ExitConditions withFileUploadError(ExitOptions fileUploadError)"
|
|
desc: "Set if the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence."
|
|
returns:
|
|
description: "the ExitConditions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitConditions?alt=com.microsoft.azure.batch.protocol.models.ExitConditions&text=ExitConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ExitConditions.withPreProcessingError(com.microsoft.azure.batch.protocol.models.ExitOptions)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ExitConditions.withPreProcessingError(ExitOptions preProcessingError)"
|
|
name: "withPreProcessingError(ExitOptions preProcessingError)"
|
|
nameWithType: "ExitConditions.withPreProcessingError(ExitOptions preProcessingError)"
|
|
summary: "Set the pre<wbr>Processing<wbr>Error value."
|
|
parameters:
|
|
- description: "the preProcessingError value to set"
|
|
name: "preProcessingError"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitOptions?alt=com.microsoft.azure.batch.protocol.models.ExitOptions&text=ExitOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ExitConditions withPreProcessingError(ExitOptions preProcessingError)"
|
|
desc: "Set the preProcessingError value."
|
|
returns:
|
|
description: "the ExitConditions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ExitConditions?alt=com.microsoft.azure.batch.protocol.models.ExitConditions&text=ExitConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Specifies how the Batch service should respond when the Task completes."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|