204 строки
16 KiB
YAML
204 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions"
|
|
name: "FileGetFromComputeNodeOptions"
|
|
nameWithType: "FileGetFromComputeNodeOptions"
|
|
summary: "Additional parameters for get<wbr>From<wbr>Compute<wbr>Node operation."
|
|
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 **FileGetFromComputeNodeOptions**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.FileGetFromComputeNodeOptions()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.FileGetFromComputeNodeOptions()"
|
|
name: "FileGetFromComputeNodeOptions()"
|
|
nameWithType: "FileGetFromComputeNodeOptions.FileGetFromComputeNodeOptions()"
|
|
syntax: "public FileGetFromComputeNodeOptions()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.clientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.clientRequestId()"
|
|
name: "clientRequestId()"
|
|
nameWithType: "FileGetFromComputeNodeOptions.clientRequestId()"
|
|
summary: "Get the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.<wbr>g."
|
|
syntax: "public UUID clientRequestId()"
|
|
desc: "Get the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0."
|
|
returns:
|
|
description: "the clientRequestId value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.ifModifiedSince()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.ifModifiedSince()"
|
|
name: "ifModifiedSince()"
|
|
nameWithType: "FileGetFromComputeNodeOptions.ifModifiedSince()"
|
|
summary: "Get a timestamp indicating the last modified time of the resource known to the client."
|
|
syntax: "public DateTime ifModifiedSince()"
|
|
desc: "Get a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time."
|
|
returns:
|
|
description: "the ifModifiedSince value"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.ifUnmodifiedSince()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.ifUnmodifiedSince()"
|
|
name: "ifUnmodifiedSince()"
|
|
nameWithType: "FileGetFromComputeNodeOptions.ifUnmodifiedSince()"
|
|
summary: "Get a timestamp indicating the last modified time of the resource known to the client."
|
|
syntax: "public DateTime ifUnmodifiedSince()"
|
|
desc: "Get a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time."
|
|
returns:
|
|
description: "the ifUnmodifiedSince value"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.ocpDate()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.ocpDate()"
|
|
name: "ocpDate()"
|
|
nameWithType: "FileGetFromComputeNodeOptions.ocpDate()"
|
|
summary: "Get the time the request was issued."
|
|
syntax: "public DateTime ocpDate()"
|
|
desc: "Get the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly."
|
|
returns:
|
|
description: "the ocpDate value"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.ocpRange()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.ocpRange()"
|
|
name: "ocpRange()"
|
|
nameWithType: "FileGetFromComputeNodeOptions.ocpRange()"
|
|
summary: "Get the byte range to be retrieved."
|
|
syntax: "public String ocpRange()"
|
|
desc: "Get the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange."
|
|
returns:
|
|
description: "the ocpRange value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.returnClientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.returnClientRequestId()"
|
|
name: "returnClientRequestId()"
|
|
nameWithType: "FileGetFromComputeNodeOptions.returnClientRequestId()"
|
|
summary: "Get whether the server should return the client-request-id in the response."
|
|
syntax: "public Boolean returnClientRequestId()"
|
|
desc: "Get whether the server should return the client-request-id in the response."
|
|
returns:
|
|
description: "the returnClientRequestId value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.timeout()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.timeout()"
|
|
name: "timeout()"
|
|
nameWithType: "FileGetFromComputeNodeOptions.timeout()"
|
|
summary: "Get the maximum time that the server can spend processing the request, in seconds."
|
|
syntax: "public Integer timeout()"
|
|
desc: "Get the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead."
|
|
returns:
|
|
description: "the timeout value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withClientRequestId(java.util.UUID)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withClientRequestId(UUID clientRequestId)"
|
|
name: "withClientRequestId(UUID clientRequestId)"
|
|
nameWithType: "FileGetFromComputeNodeOptions.withClientRequestId(UUID clientRequestId)"
|
|
summary: "Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.<wbr>g."
|
|
parameters:
|
|
- description: "the clientRequestId value to set"
|
|
name: "clientRequestId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
|
|
syntax: "public FileGetFromComputeNodeOptions withClientRequestId(UUID clientRequestId)"
|
|
desc: "Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0."
|
|
returns:
|
|
description: "the FileGetFromComputeNodeOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions?alt=com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions&text=FileGetFromComputeNodeOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withIfModifiedSince(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withIfModifiedSince(DateTime ifModifiedSince)"
|
|
name: "withIfModifiedSince(DateTime ifModifiedSince)"
|
|
nameWithType: "FileGetFromComputeNodeOptions.withIfModifiedSince(DateTime ifModifiedSince)"
|
|
summary: "Set a timestamp indicating the last modified time of the resource known to the client."
|
|
parameters:
|
|
- description: "the ifModifiedSince value to set"
|
|
name: "ifModifiedSince"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public FileGetFromComputeNodeOptions withIfModifiedSince(DateTime ifModifiedSince)"
|
|
desc: "Set a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time."
|
|
returns:
|
|
description: "the FileGetFromComputeNodeOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions?alt=com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions&text=FileGetFromComputeNodeOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withIfUnmodifiedSince(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withIfUnmodifiedSince(DateTime ifUnmodifiedSince)"
|
|
name: "withIfUnmodifiedSince(DateTime ifUnmodifiedSince)"
|
|
nameWithType: "FileGetFromComputeNodeOptions.withIfUnmodifiedSince(DateTime ifUnmodifiedSince)"
|
|
summary: "Set a timestamp indicating the last modified time of the resource known to the client."
|
|
parameters:
|
|
- description: "the ifUnmodifiedSince value to set"
|
|
name: "ifUnmodifiedSince"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public FileGetFromComputeNodeOptions withIfUnmodifiedSince(DateTime ifUnmodifiedSince)"
|
|
desc: "Set a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time."
|
|
returns:
|
|
description: "the FileGetFromComputeNodeOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions?alt=com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions&text=FileGetFromComputeNodeOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withOcpDate(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withOcpDate(DateTime ocpDate)"
|
|
name: "withOcpDate(DateTime ocpDate)"
|
|
nameWithType: "FileGetFromComputeNodeOptions.withOcpDate(DateTime ocpDate)"
|
|
summary: "Set the time the request was issued."
|
|
parameters:
|
|
- description: "the ocpDate value to set"
|
|
name: "ocpDate"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public FileGetFromComputeNodeOptions withOcpDate(DateTime ocpDate)"
|
|
desc: "Set the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly."
|
|
returns:
|
|
description: "the FileGetFromComputeNodeOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions?alt=com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions&text=FileGetFromComputeNodeOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withOcpRange(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withOcpRange(String ocpRange)"
|
|
name: "withOcpRange(String ocpRange)"
|
|
nameWithType: "FileGetFromComputeNodeOptions.withOcpRange(String ocpRange)"
|
|
summary: "Set the byte range to be retrieved."
|
|
parameters:
|
|
- description: "the ocpRange value to set"
|
|
name: "ocpRange"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public FileGetFromComputeNodeOptions withOcpRange(String ocpRange)"
|
|
desc: "Set the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange."
|
|
returns:
|
|
description: "the FileGetFromComputeNodeOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions?alt=com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions&text=FileGetFromComputeNodeOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withReturnClientRequestId(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
name: "withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
nameWithType: "FileGetFromComputeNodeOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
summary: "Set whether the server should return the client-request-id in the response."
|
|
parameters:
|
|
- description: "the returnClientRequestId value to set"
|
|
name: "returnClientRequestId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public FileGetFromComputeNodeOptions withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
desc: "Set whether the server should return the client-request-id in the response."
|
|
returns:
|
|
description: "the FileGetFromComputeNodeOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions?alt=com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions&text=FileGetFromComputeNodeOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withTimeout(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions.withTimeout(Integer timeout)"
|
|
name: "withTimeout(Integer timeout)"
|
|
nameWithType: "FileGetFromComputeNodeOptions.withTimeout(Integer timeout)"
|
|
summary: "Set the maximum time that the server can spend processing the request, in seconds."
|
|
parameters:
|
|
- description: "the timeout value to set"
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public FileGetFromComputeNodeOptions withTimeout(Integer timeout)"
|
|
desc: "Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead."
|
|
returns:
|
|
description: "the FileGetFromComputeNodeOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions?alt=com.microsoft.azure.batch.protocol.models.FileGetFromComputeNodeOptions&text=FileGetFromComputeNodeOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Additional parameters for getFromComputeNode operation."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|