PoolListUsageMetricsOptions Constructors

Definition

Namespace:

Microsoft.Azure.Batch.Protocol.Models

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Overloads

PoolListUsageMetricsOptions()	Initializes a new instance of the PoolListUsageMetricsOptions class.
PoolListUsageMetricsOptions(Nullable<DateTime>, Nullable<DateTime>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Guid>, Nullable<Boolean>, Nullable<DateTime>)	Initializes a new instance of the PoolListUsageMetricsOptions class.

PoolListUsageMetricsOptions()

Source:

PoolListUsageMetricsOptions.cs

Initializes a new instance of the PoolListUsageMetricsOptions class.

public PoolListUsageMetricsOptions ();

Public Sub New ()

PoolListUsageMetricsOptions(Nullable<DateTime>, Nullable<DateTime>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Guid>, Nullable<Boolean>, Nullable<DateTime>)

Source:

PoolListUsageMetricsOptions.cs

Initializes a new instance of the PoolListUsageMetricsOptions class.

public PoolListUsageMetricsOptions (DateTime? startTime = default, DateTime? endTime = default, string filter = default, int? maxResults = default, int? timeout = default, Guid? clientRequestId = default, bool? returnClientRequestId = default, DateTime? ocpDate = default);

new Microsoft.Azure.Batch.Protocol.Models.PoolListUsageMetricsOptions : Nullable<DateTime> * Nullable<DateTime> * string * Nullable<int> * Nullable<int> * Nullable<Guid> * Nullable<bool> * Nullable<DateTime> -> Microsoft.Azure.Batch.Protocol.Models.PoolListUsageMetricsOptions

Public Sub New (Optional startTime As Nullable(Of DateTime) = Nothing, Optional endTime As Nullable(Of DateTime) = Nothing, Optional filter As String = Nothing, Optional maxResults As Nullable(Of Integer) = Nothing, Optional timeout As Nullable(Of Integer) = Nothing, Optional clientRequestId As Nullable(Of Guid) = Nothing, Optional returnClientRequestId As Nullable(Of Boolean) = Nothing, Optional ocpDate As Nullable(Of DateTime) = Nothing)

Parameters

startTime

Nullable<DateTime>

The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.

endTime

Nullable<DateTime>

The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.

filter

String

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.

maxResults

Nullable<Int32>

The maximum number of items to return in the response. A maximum of 1000 results will be returned.

timeout

Nullable<Int32>

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.

clientRequestId

Nullable<Guid>

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.

returnClientRequestId

Nullable<Boolean>

Whether the server should return the client-request-id in the response.

ocpDate

Nullable<DateTime>

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.