213 строки
14 KiB
YAML
213 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cognitiveservices.models.Usage"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage"
|
|
name: "Usage"
|
|
nameWithType: "Usage"
|
|
summary: "The usage data for a usage request."
|
|
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 final class **Usage**"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.Usage()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.Usage()"
|
|
name: "Usage()"
|
|
nameWithType: "Usage.Usage()"
|
|
summary: "Creates an instance of Usage class."
|
|
syntax: "public Usage()"
|
|
desc: "Creates an instance of Usage class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.currentValue()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.currentValue()"
|
|
name: "currentValue()"
|
|
nameWithType: "Usage.currentValue()"
|
|
summary: "Get the current<wbr>Value property: Current value for this metric."
|
|
syntax: "public Double currentValue()"
|
|
desc: "Get the currentValue property: Current value for this metric."
|
|
returns:
|
|
description: "the currentValue value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.limit()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.limit()"
|
|
name: "limit()"
|
|
nameWithType: "Usage.limit()"
|
|
summary: "Get the limit property: Maximum value for this metric."
|
|
syntax: "public Double limit()"
|
|
desc: "Get the limit property: Maximum value for this metric."
|
|
returns:
|
|
description: "the limit value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.name()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.name()"
|
|
name: "name()"
|
|
nameWithType: "Usage.name()"
|
|
summary: "Get the name property: The name information for the metric."
|
|
syntax: "public MetricName name()"
|
|
desc: "Get the name property: The name information for the metric."
|
|
returns:
|
|
description: "the name value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.MetricName?alt=com.azure.resourcemanager.cognitiveservices.models.MetricName&text=MetricName\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.nextResetTime()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.nextResetTime()"
|
|
name: "nextResetTime()"
|
|
nameWithType: "Usage.nextResetTime()"
|
|
summary: "Get the next<wbr>Reset<wbr>Time property: Next reset time for current quota."
|
|
syntax: "public String nextResetTime()"
|
|
desc: "Get the nextResetTime property: Next reset time for current quota."
|
|
returns:
|
|
description: "the nextResetTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.quotaPeriod()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.quotaPeriod()"
|
|
name: "quotaPeriod()"
|
|
nameWithType: "Usage.quotaPeriod()"
|
|
summary: "Get the quota<wbr>Period property: The quota period used to summarize the usage values."
|
|
syntax: "public String quotaPeriod()"
|
|
desc: "Get the quotaPeriod property: The quota period used to summarize the usage values."
|
|
returns:
|
|
description: "the quotaPeriod value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.status()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.status()"
|
|
name: "status()"
|
|
nameWithType: "Usage.status()"
|
|
summary: "Get the status property: Cognitive Services account quota usage status."
|
|
syntax: "public QuotaUsageStatus status()"
|
|
desc: "Get the status property: Cognitive Services account quota usage status."
|
|
returns:
|
|
description: "the status value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.QuotaUsageStatus?alt=com.azure.resourcemanager.cognitiveservices.models.QuotaUsageStatus&text=QuotaUsageStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.unit()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.unit()"
|
|
name: "unit()"
|
|
nameWithType: "Usage.unit()"
|
|
summary: "Get the unit property: The unit of the metric."
|
|
syntax: "public UnitType unit()"
|
|
desc: "Get the unit property: The unit of the metric."
|
|
returns:
|
|
description: "the unit value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.UnitType?alt=com.azure.resourcemanager.cognitiveservices.models.UnitType&text=UnitType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.validate()"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.validate()"
|
|
name: "validate()"
|
|
nameWithType: "Usage.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.withCurrentValue(java.lang.Double)"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.withCurrentValue(Double currentValue)"
|
|
name: "withCurrentValue(Double currentValue)"
|
|
nameWithType: "Usage.withCurrentValue(Double currentValue)"
|
|
summary: "Set the current<wbr>Value property: Current value for this metric."
|
|
parameters:
|
|
- description: "the currentValue value to set."
|
|
name: "currentValue"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
|
syntax: "public Usage withCurrentValue(Double currentValue)"
|
|
desc: "Set the currentValue property: Current value for this metric."
|
|
returns:
|
|
description: "the Usage object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.Usage?alt=com.azure.resourcemanager.cognitiveservices.models.Usage&text=Usage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.withLimit(java.lang.Double)"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.withLimit(Double limit)"
|
|
name: "withLimit(Double limit)"
|
|
nameWithType: "Usage.withLimit(Double limit)"
|
|
summary: "Set the limit property: Maximum value for this metric."
|
|
parameters:
|
|
- description: "the limit value to set."
|
|
name: "limit"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
|
syntax: "public Usage withLimit(Double limit)"
|
|
desc: "Set the limit property: Maximum value for this metric."
|
|
returns:
|
|
description: "the Usage object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.Usage?alt=com.azure.resourcemanager.cognitiveservices.models.Usage&text=Usage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.withName(com.azure.resourcemanager.cognitiveservices.models.MetricName)"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.withName(MetricName name)"
|
|
name: "withName(MetricName name)"
|
|
nameWithType: "Usage.withName(MetricName name)"
|
|
summary: "Set the name property: The name information for the metric."
|
|
parameters:
|
|
- description: "the name value to set."
|
|
name: "name"
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.MetricName?alt=com.azure.resourcemanager.cognitiveservices.models.MetricName&text=MetricName\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Usage withName(MetricName name)"
|
|
desc: "Set the name property: The name information for the metric."
|
|
returns:
|
|
description: "the Usage object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.Usage?alt=com.azure.resourcemanager.cognitiveservices.models.Usage&text=Usage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.withNextResetTime(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.withNextResetTime(String nextResetTime)"
|
|
name: "withNextResetTime(String nextResetTime)"
|
|
nameWithType: "Usage.withNextResetTime(String nextResetTime)"
|
|
summary: "Set the next<wbr>Reset<wbr>Time property: Next reset time for current quota."
|
|
parameters:
|
|
- description: "the nextResetTime value to set."
|
|
name: "nextResetTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Usage withNextResetTime(String nextResetTime)"
|
|
desc: "Set the nextResetTime property: Next reset time for current quota."
|
|
returns:
|
|
description: "the Usage object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.Usage?alt=com.azure.resourcemanager.cognitiveservices.models.Usage&text=Usage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.withQuotaPeriod(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.withQuotaPeriod(String quotaPeriod)"
|
|
name: "withQuotaPeriod(String quotaPeriod)"
|
|
nameWithType: "Usage.withQuotaPeriod(String quotaPeriod)"
|
|
summary: "Set the quota<wbr>Period property: The quota period used to summarize the usage values."
|
|
parameters:
|
|
- description: "the quotaPeriod value to set."
|
|
name: "quotaPeriod"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Usage withQuotaPeriod(String quotaPeriod)"
|
|
desc: "Set the quotaPeriod property: The quota period used to summarize the usage values."
|
|
returns:
|
|
description: "the Usage object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.Usage?alt=com.azure.resourcemanager.cognitiveservices.models.Usage&text=Usage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.withStatus(com.azure.resourcemanager.cognitiveservices.models.QuotaUsageStatus)"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.withStatus(QuotaUsageStatus status)"
|
|
name: "withStatus(QuotaUsageStatus status)"
|
|
nameWithType: "Usage.withStatus(QuotaUsageStatus status)"
|
|
summary: "Set the status property: Cognitive Services account quota usage status."
|
|
parameters:
|
|
- description: "the status value to set."
|
|
name: "status"
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.QuotaUsageStatus?alt=com.azure.resourcemanager.cognitiveservices.models.QuotaUsageStatus&text=QuotaUsageStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Usage withStatus(QuotaUsageStatus status)"
|
|
desc: "Set the status property: Cognitive Services account quota usage status."
|
|
returns:
|
|
description: "the Usage object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.Usage?alt=com.azure.resourcemanager.cognitiveservices.models.Usage&text=Usage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cognitiveservices.models.Usage.withUnit(com.azure.resourcemanager.cognitiveservices.models.UnitType)"
|
|
fullName: "com.azure.resourcemanager.cognitiveservices.models.Usage.withUnit(UnitType unit)"
|
|
name: "withUnit(UnitType unit)"
|
|
nameWithType: "Usage.withUnit(UnitType unit)"
|
|
summary: "Set the unit property: The unit of the metric."
|
|
parameters:
|
|
- description: "the unit value to set."
|
|
name: "unit"
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.UnitType?alt=com.azure.resourcemanager.cognitiveservices.models.UnitType&text=UnitType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Usage withUnit(UnitType unit)"
|
|
desc: "Set the unit property: The unit of the metric."
|
|
returns:
|
|
description: "the Usage object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cognitiveservices.models.Usage?alt=com.azure.resourcemanager.cognitiveservices.models.Usage&text=Usage\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The usage data for a usage request."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cognitiveservices.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cognitiveservices:1.0.0
|