Package com.azure.resourcemanager.apimanagement.fluent.models

Class ReportRecordContractInner

java.lang.Object
com.azure.resourcemanager.apimanagement.fluent.models.ReportRecordContractInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<ReportRecordContractInner>
public final class ReportRecordContractInner extends Object implements com.azure.json.JsonSerializable<ReportRecordContractInner>
Report data.

  • Constructor Details

    • ReportRecordContractInner

      public ReportRecordContractInner()
      Creates an instance of ReportRecordContractInner class.

  • Method Details

    • name

      public String name()
      Get the name property: Name depending on report endpoint specifies product, API, operation or developer name.
      Returns:
      the name value.

    • withName

      public ReportRecordContractInner withName(String name)
      Set the name property: Name depending on report endpoint specifies product, API, operation or developer name.
      Parameters:
      name - the name value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • timestamp

      public OffsetDateTime timestamp()
      Get the timestamp property: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
      Returns:
      the timestamp value.

    • withTimestamp

      public ReportRecordContractInner withTimestamp(OffsetDateTime timestamp)
      Set the timestamp property: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
      Parameters:
      timestamp - the timestamp value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • interval

      public String interval()
      Get the interval property: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
      Returns:
      the interval value.

    • withInterval

      public ReportRecordContractInner withInterval(String interval)
      Set the interval property: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
      Parameters:
      interval - the interval value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • country

      public String country()
      Get the country property: Country to which this record data is related.
      Returns:
      the country value.

    • withCountry

      public ReportRecordContractInner withCountry(String country)
      Set the country property: Country to which this record data is related.
      Parameters:
      country - the country value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • region

      public String region()
      Get the region property: Country region to which this record data is related.
      Returns:
      the region value.

    • withRegion

      public ReportRecordContractInner withRegion(String region)
      Set the region property: Country region to which this record data is related.
      Parameters:
      region - the region value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • zip

      public String zip()
      Get the zip property: Zip code to which this record data is related.
      Returns:
      the zip value.

    • withZip

      public ReportRecordContractInner withZip(String zip)
      Set the zip property: Zip code to which this record data is related.
      Parameters:
      zip - the zip value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • userId

      public String userId()
      Get the userId property: User identifier path. /users/{userId}.
      Returns:
      the userId value.

    • productId

      public String productId()
      Get the productId property: Product identifier path. /products/{productId}.
      Returns:
      the productId value.

    • apiId

      public String apiId()
      Get the apiId property: API identifier path. /apis/{apiId}.
      Returns:
      the apiId value.

    • withApiId

      public ReportRecordContractInner withApiId(String apiId)
      Set the apiId property: API identifier path. /apis/{apiId}.
      Parameters:
      apiId - the apiId value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • operationId

      public String operationId()
      Get the operationId property: Operation identifier path. /apis/{apiId}/operations/{operationId}.
      Returns:
      the operationId value.

    • withOperationId

      public ReportRecordContractInner withOperationId(String operationId)
      Set the operationId property: Operation identifier path. /apis/{apiId}/operations/{operationId}.
      Parameters:
      operationId - the operationId value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • apiRegion

      public String apiRegion()
      Get the apiRegion property: API region identifier.
      Returns:
      the apiRegion value.

    • withApiRegion

      public ReportRecordContractInner withApiRegion(String apiRegion)
      Set the apiRegion property: API region identifier.
      Parameters:
      apiRegion - the apiRegion value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • subscriptionId

      public String subscriptionId()
      Get the subscriptionId property: Subscription identifier path. /subscriptions/{subscriptionId}.
      Returns:
      the subscriptionId value.

    • withSubscriptionId

      public ReportRecordContractInner withSubscriptionId(String subscriptionId)
      Set the subscriptionId property: Subscription identifier path. /subscriptions/{subscriptionId}.
      Parameters:
      subscriptionId - the subscriptionId value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • callCountSuccess

      public Integer callCountSuccess()
      Get the callCountSuccess property: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect.
      Returns:
      the callCountSuccess value.

    • withCallCountSuccess

      public ReportRecordContractInner withCallCountSuccess(Integer callCountSuccess)
      Set the callCountSuccess property: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect.
      Parameters:
      callCountSuccess - the callCountSuccess value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • callCountBlocked

      public Integer callCountBlocked()
      Get the callCountBlocked property: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests.
      Returns:
      the callCountBlocked value.

    • withCallCountBlocked

      public ReportRecordContractInner withCallCountBlocked(Integer callCountBlocked)
      Set the callCountBlocked property: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests.
      Parameters:
      callCountBlocked - the callCountBlocked value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • callCountFailed

      public Integer callCountFailed()
      Get the callCountFailed property: Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600.
      Returns:
      the callCountFailed value.

    • withCallCountFailed

      public ReportRecordContractInner withCallCountFailed(Integer callCountFailed)
      Set the callCountFailed property: Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600.
      Parameters:
      callCountFailed - the callCountFailed value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • callCountOther

      public Integer callCountOther()
      Get the callCountOther property: Number of other calls.
      Returns:
      the callCountOther value.

    • withCallCountOther

      public ReportRecordContractInner withCallCountOther(Integer callCountOther)
      Set the callCountOther property: Number of other calls.
      Parameters:
      callCountOther - the callCountOther value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • callCountTotal

      public Integer callCountTotal()
      Get the callCountTotal property: Total number of calls.
      Returns:
      the callCountTotal value.

    • withCallCountTotal

      public ReportRecordContractInner withCallCountTotal(Integer callCountTotal)
      Set the callCountTotal property: Total number of calls.
      Parameters:
      callCountTotal - the callCountTotal value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • bandwidth

      public Long bandwidth()
      Get the bandwidth property: Bandwidth consumed.
      Returns:
      the bandwidth value.

    • withBandwidth

      public ReportRecordContractInner withBandwidth(Long bandwidth)
      Set the bandwidth property: Bandwidth consumed.
      Parameters:
      bandwidth - the bandwidth value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • cacheHitCount

      public Integer cacheHitCount()
      Get the cacheHitCount property: Number of times when content was served from cache policy.
      Returns:
      the cacheHitCount value.

    • withCacheHitCount

      public ReportRecordContractInner withCacheHitCount(Integer cacheHitCount)
      Set the cacheHitCount property: Number of times when content was served from cache policy.
      Parameters:
      cacheHitCount - the cacheHitCount value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • cacheMissCount

      public Integer cacheMissCount()
      Get the cacheMissCount property: Number of times content was fetched from backend.
      Returns:
      the cacheMissCount value.

    • withCacheMissCount

      public ReportRecordContractInner withCacheMissCount(Integer cacheMissCount)
      Set the cacheMissCount property: Number of times content was fetched from backend.
      Parameters:
      cacheMissCount - the cacheMissCount value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • apiTimeAvg

      public Double apiTimeAvg()
      Get the apiTimeAvg property: Average time it took to process request.
      Returns:
      the apiTimeAvg value.

    • withApiTimeAvg

      public ReportRecordContractInner withApiTimeAvg(Double apiTimeAvg)
      Set the apiTimeAvg property: Average time it took to process request.
      Parameters:
      apiTimeAvg - the apiTimeAvg value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • apiTimeMin

      public Double apiTimeMin()
      Get the apiTimeMin property: Minimum time it took to process request.
      Returns:
      the apiTimeMin value.

    • withApiTimeMin

      public ReportRecordContractInner withApiTimeMin(Double apiTimeMin)
      Set the apiTimeMin property: Minimum time it took to process request.
      Parameters:
      apiTimeMin - the apiTimeMin value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • apiTimeMax

      public Double apiTimeMax()
      Get the apiTimeMax property: Maximum time it took to process request.
      Returns:
      the apiTimeMax value.

    • withApiTimeMax

      public ReportRecordContractInner withApiTimeMax(Double apiTimeMax)
      Set the apiTimeMax property: Maximum time it took to process request.
      Parameters:
      apiTimeMax - the apiTimeMax value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • serviceTimeAvg

      public Double serviceTimeAvg()
      Get the serviceTimeAvg property: Average time it took to process request on backend.
      Returns:
      the serviceTimeAvg value.

    • withServiceTimeAvg

      public ReportRecordContractInner withServiceTimeAvg(Double serviceTimeAvg)
      Set the serviceTimeAvg property: Average time it took to process request on backend.
      Parameters:
      serviceTimeAvg - the serviceTimeAvg value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • serviceTimeMin

      public Double serviceTimeMin()
      Get the serviceTimeMin property: Minimum time it took to process request on backend.
      Returns:
      the serviceTimeMin value.

    • withServiceTimeMin

      public ReportRecordContractInner withServiceTimeMin(Double serviceTimeMin)
      Set the serviceTimeMin property: Minimum time it took to process request on backend.
      Parameters:
      serviceTimeMin - the serviceTimeMin value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • serviceTimeMax

      public Double serviceTimeMax()
      Get the serviceTimeMax property: Maximum time it took to process request on backend.
      Returns:
      the serviceTimeMax value.

    • withServiceTimeMax

      public ReportRecordContractInner withServiceTimeMax(Double serviceTimeMax)
      Set the serviceTimeMax property: Maximum time it took to process request on backend.
      Parameters:
      serviceTimeMax - the serviceTimeMax value to set.
      Returns:
      the ReportRecordContractInner object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ReportRecordContractInner>
      Throws:
      IOException

    • fromJson

      public static ReportRecordContractInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ReportRecordContractInner from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ReportRecordContractInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ReportRecordContractInner.