228 строки
17 KiB
YAML
228 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions"
|
|
name: "PoolPatchOptions"
|
|
nameWithType: "PoolPatchOptions"
|
|
summary: "Additional parameters for patch 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 **PoolPatchOptions**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.PoolPatchOptions()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.PoolPatchOptions()"
|
|
name: "PoolPatchOptions()"
|
|
nameWithType: "PoolPatchOptions.PoolPatchOptions()"
|
|
syntax: "public PoolPatchOptions()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.clientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.clientRequestId()"
|
|
name: "clientRequestId()"
|
|
nameWithType: "PoolPatchOptions.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.PoolPatchOptions.ifMatch()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.ifMatch()"
|
|
name: "ifMatch()"
|
|
nameWithType: "PoolPatchOptions.ifMatch()"
|
|
summary: "Get an ETag value associated with the version of the resource known to the client."
|
|
syntax: "public String ifMatch()"
|
|
desc: "Get an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client."
|
|
returns:
|
|
description: "the ifMatch 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.PoolPatchOptions.ifModifiedSince()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.ifModifiedSince()"
|
|
name: "ifModifiedSince()"
|
|
nameWithType: "PoolPatchOptions.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.PoolPatchOptions.ifNoneMatch()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.ifNoneMatch()"
|
|
name: "ifNoneMatch()"
|
|
nameWithType: "PoolPatchOptions.ifNoneMatch()"
|
|
summary: "Get an ETag value associated with the version of the resource known to the client."
|
|
syntax: "public String ifNoneMatch()"
|
|
desc: "Get an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client."
|
|
returns:
|
|
description: "the ifNoneMatch 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.PoolPatchOptions.ifUnmodifiedSince()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.ifUnmodifiedSince()"
|
|
name: "ifUnmodifiedSince()"
|
|
nameWithType: "PoolPatchOptions.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.PoolPatchOptions.ocpDate()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.ocpDate()"
|
|
name: "ocpDate()"
|
|
nameWithType: "PoolPatchOptions.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.PoolPatchOptions.returnClientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.returnClientRequestId()"
|
|
name: "returnClientRequestId()"
|
|
nameWithType: "PoolPatchOptions.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.PoolPatchOptions.timeout()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.timeout()"
|
|
name: "timeout()"
|
|
nameWithType: "PoolPatchOptions.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.PoolPatchOptions.withClientRequestId(java.util.UUID)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withClientRequestId(UUID clientRequestId)"
|
|
name: "withClientRequestId(UUID clientRequestId)"
|
|
nameWithType: "PoolPatchOptions.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 PoolPatchOptions 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 PoolPatchOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchOptions?alt=com.microsoft.azure.batch.protocol.models.PoolPatchOptions&text=PoolPatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withIfMatch(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withIfMatch(String ifMatch)"
|
|
name: "withIfMatch(String ifMatch)"
|
|
nameWithType: "PoolPatchOptions.withIfMatch(String ifMatch)"
|
|
summary: "Set an ETag value associated with the version of the resource known to the client."
|
|
parameters:
|
|
- description: "the ifMatch value to set"
|
|
name: "ifMatch"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PoolPatchOptions withIfMatch(String ifMatch)"
|
|
desc: "Set an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client."
|
|
returns:
|
|
description: "the PoolPatchOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchOptions?alt=com.microsoft.azure.batch.protocol.models.PoolPatchOptions&text=PoolPatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withIfModifiedSince(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withIfModifiedSince(DateTime ifModifiedSince)"
|
|
name: "withIfModifiedSince(DateTime ifModifiedSince)"
|
|
nameWithType: "PoolPatchOptions.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 PoolPatchOptions 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 PoolPatchOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchOptions?alt=com.microsoft.azure.batch.protocol.models.PoolPatchOptions&text=PoolPatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withIfNoneMatch(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withIfNoneMatch(String ifNoneMatch)"
|
|
name: "withIfNoneMatch(String ifNoneMatch)"
|
|
nameWithType: "PoolPatchOptions.withIfNoneMatch(String ifNoneMatch)"
|
|
summary: "Set an ETag value associated with the version of the resource known to the client."
|
|
parameters:
|
|
- description: "the ifNoneMatch value to set"
|
|
name: "ifNoneMatch"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PoolPatchOptions withIfNoneMatch(String ifNoneMatch)"
|
|
desc: "Set an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client."
|
|
returns:
|
|
description: "the PoolPatchOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchOptions?alt=com.microsoft.azure.batch.protocol.models.PoolPatchOptions&text=PoolPatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withIfUnmodifiedSince(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withIfUnmodifiedSince(DateTime ifUnmodifiedSince)"
|
|
name: "withIfUnmodifiedSince(DateTime ifUnmodifiedSince)"
|
|
nameWithType: "PoolPatchOptions.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 PoolPatchOptions 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 PoolPatchOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchOptions?alt=com.microsoft.azure.batch.protocol.models.PoolPatchOptions&text=PoolPatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withOcpDate(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withOcpDate(DateTime ocpDate)"
|
|
name: "withOcpDate(DateTime ocpDate)"
|
|
nameWithType: "PoolPatchOptions.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 PoolPatchOptions 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 PoolPatchOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchOptions?alt=com.microsoft.azure.batch.protocol.models.PoolPatchOptions&text=PoolPatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withReturnClientRequestId(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
name: "withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
nameWithType: "PoolPatchOptions.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 PoolPatchOptions withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
desc: "Set whether the server should return the client-request-id in the response."
|
|
returns:
|
|
description: "the PoolPatchOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchOptions?alt=com.microsoft.azure.batch.protocol.models.PoolPatchOptions&text=PoolPatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withTimeout(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolPatchOptions.withTimeout(Integer timeout)"
|
|
name: "withTimeout(Integer timeout)"
|
|
nameWithType: "PoolPatchOptions.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 PoolPatchOptions 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 PoolPatchOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchOptions?alt=com.microsoft.azure.batch.protocol.models.PoolPatchOptions&text=PoolPatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Additional parameters for patch operation."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|