azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.batch.p...

132 строки
10 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions"
name: "PoolUpdatePropertiesOptions"
nameWithType: "PoolUpdatePropertiesOptions"
summary: "Additional parameters for update<wbr>Properties 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 **PoolUpdatePropertiesOptions**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.PoolUpdatePropertiesOptions()"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.PoolUpdatePropertiesOptions()"
name: "PoolUpdatePropertiesOptions()"
nameWithType: "PoolUpdatePropertiesOptions.PoolUpdatePropertiesOptions()"
syntax: "public PoolUpdatePropertiesOptions()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.clientRequestId()"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.clientRequestId()"
name: "clientRequestId()"
nameWithType: "PoolUpdatePropertiesOptions.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.PoolUpdatePropertiesOptions.ocpDate()"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.ocpDate()"
name: "ocpDate()"
nameWithType: "PoolUpdatePropertiesOptions.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.PoolUpdatePropertiesOptions.returnClientRequestId()"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.returnClientRequestId()"
name: "returnClientRequestId()"
nameWithType: "PoolUpdatePropertiesOptions.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.PoolUpdatePropertiesOptions.timeout()"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.timeout()"
name: "timeout()"
nameWithType: "PoolUpdatePropertiesOptions.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.PoolUpdatePropertiesOptions.withClientRequestId(java.util.UUID)"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.withClientRequestId(UUID clientRequestId)"
name: "withClientRequestId(UUID clientRequestId)"
nameWithType: "PoolUpdatePropertiesOptions.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 PoolUpdatePropertiesOptions 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 PoolUpdatePropertiesOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions?alt=com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions&text=PoolUpdatePropertiesOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.withOcpDate(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.withOcpDate(DateTime ocpDate)"
name: "withOcpDate(DateTime ocpDate)"
nameWithType: "PoolUpdatePropertiesOptions.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 PoolUpdatePropertiesOptions 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 PoolUpdatePropertiesOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions?alt=com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions&text=PoolUpdatePropertiesOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.withReturnClientRequestId(java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
name: "withReturnClientRequestId(Boolean returnClientRequestId)"
nameWithType: "PoolUpdatePropertiesOptions.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 PoolUpdatePropertiesOptions withReturnClientRequestId(Boolean returnClientRequestId)"
desc: "Set whether the server should return the client-request-id in the response."
returns:
description: "the PoolUpdatePropertiesOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions?alt=com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions&text=PoolUpdatePropertiesOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.withTimeout(java.lang.Integer)"
fullName: "com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions.withTimeout(Integer timeout)"
name: "withTimeout(Integer timeout)"
nameWithType: "PoolUpdatePropertiesOptions.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 PoolUpdatePropertiesOptions 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 PoolUpdatePropertiesOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions?alt=com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesOptions&text=PoolUpdatePropertiesOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Additional parameters for updateProperties operation."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.2.0