Package com.azure.resourcemanager.apimanagement.models

Interface ReportRecordContract

public interface ReportRecordContract
An immutable client-side representation of ReportRecordContract.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    apiId()
    Gets the apiId property: API identifier path.
    String
    apiRegion()
    Gets the apiRegion property: API region identifier.
    Double
    apiTimeAvg()
    Gets the apiTimeAvg property: Average time it took to process request.
    Double
    apiTimeMax()
    Gets the apiTimeMax property: Maximum time it took to process request.
    Double
    apiTimeMin()
    Gets the apiTimeMin property: Minimum time it took to process request.
    Long
    bandwidth()
    Gets the bandwidth property: Bandwidth consumed.
    Integer
    cacheHitCount()
    Gets the cacheHitCount property: Number of times when content was served from cache policy.
    Integer
    cacheMissCount()
    Gets the cacheMissCount property: Number of times content was fetched from backend.
    Integer
    callCountBlocked()
    Gets the callCountBlocked property: Number of calls blocked due to invalid credentials.
    Integer
    callCountFailed()
    Gets the callCountFailed property: Number of calls failed due to gateway or backend errors.
    Integer
    callCountOther()
    Gets the callCountOther property: Number of other calls.
    Integer
    callCountSuccess()
    Gets the callCountSuccess property: Number of successful calls.
    Integer
    callCountTotal()
    Gets the callCountTotal property: Total number of calls.
    String
    country()
    Gets the country property: Country to which this record data is related.
    ReportRecordContractInner
    innerModel()
    Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ReportRecordContractInner object.
    String
    interval()
    Gets the interval property: Length of aggregation period.
    String
    name()
    Gets the name property: Name depending on report endpoint specifies product, API, operation or developer name.
    String
    operationId()
    Gets the operationId property: Operation identifier path.
    String
    productId()
    Gets the productId property: Product identifier path.
    String
    region()
    Gets the region property: Country region to which this record data is related.
    Double
    serviceTimeAvg()
    Gets the serviceTimeAvg property: Average time it took to process request on backend.
    Double
    serviceTimeMax()
    Gets the serviceTimeMax property: Maximum time it took to process request on backend.
    Double
    serviceTimeMin()
    Gets the serviceTimeMin property: Minimum time it took to process request on backend.
    String
    subscriptionId()
    Gets the subscriptionId property: Subscription identifier path.
    OffsetDateTime
    timestamp()
    Gets the timestamp property: Start of aggregation period.
    String
    userId()
    Gets the userId property: User identifier path.
    String
    zip()
    Gets the zip property: Zip code to which this record data is related.

  • Method Details

    • name

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

    • timestamp

      OffsetDateTime timestamp()
      Gets 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.

    • interval

      String interval()
      Gets 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.

    • country

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

    • region

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

    • zip

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

    • userId

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

    • productId

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

    • apiId

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

    • operationId

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

    • apiRegion

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

    • subscriptionId

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

    • callCountSuccess

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

    • callCountBlocked

      Integer callCountBlocked()
      Gets 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.

    • callCountFailed

      Integer callCountFailed()
      Gets 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.

    • callCountOther

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

    • callCountTotal

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

    • bandwidth

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

    • cacheHitCount

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

    • cacheMissCount

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

    • apiTimeAvg

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

    • apiTimeMin

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

    • apiTimeMax

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

    • serviceTimeAvg

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

    • serviceTimeMin

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

    • serviceTimeMax

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

    • innerModel

      ReportRecordContractInner innerModel()
      Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ReportRecordContractInner object.
      Returns:
      the inner object.