ReportRecordContractInner Class

Package:

com.azure.resourcemanager.apimanagement.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

• java.lang.Object
• • com.azure.resourcemanager.apimanagement.fluent.models.ReportRecordContractInner

public final class ReportRecordContractInner

Report data.

Constructor Summary

Constructor	Description
ReportRecordContractInner()	Creates an instance of ReportRecordContractInner class.

Method Summary

Modifier and Type	Method and Description
String	apiId() Get the apiId property: API identifier path.
String	apiRegion() Get the apiRegion property: API region identifier.
Double	apiTimeAvg() Get the apiTimeAvg property: Average time it took to process request.
Double	apiTimeMax() Get the apiTimeMax property: Maximum time it took to process request.
Double	apiTimeMin() Get the apiTimeMin property: Minimum time it took to process request.
Long	bandwidth() Get the bandwidth property: Bandwidth consumed.
Integer	cacheHitCount() Get the cacheHitCount property: Number of times when content was served from cache policy.
Integer	cacheMissCount() Get the cacheMissCount property: Number of times content was fetched from backend.
Integer	callCountBlocked() Get the callCountBlocked property: Number of calls blocked due to invalid credentials.
Integer	callCountFailed() Get the callCountFailed property: Number of calls failed due to gateway or backend errors.
Integer	callCountOther() Get the callCountOther property: Number of other calls.
Integer	callCountSuccess() Get the callCountSuccess property: Number of successful calls.
Integer	callCountTotal() Get the callCountTotal property: Total number of calls.
String	country() Get the country property: Country to which this record data is related.
String	interval() Get the interval property: Length of aggregation period.
String	name() Get the name property: Name depending on report endpoint specifies product, API, operation or developer name.
String	operationId() Get the operationId property: Operation identifier path.
String	productId() Get the productId property: Product identifier path.
String	region() Get the region property: Country region to which this record data is related.
Double	serviceTimeAvg() Get the serviceTimeAvg property: Average time it took to process request on backend.
Double	serviceTimeMax() Get the serviceTimeMax property: Maximum time it took to process request on backend.
Double	serviceTimeMin() Get the serviceTimeMin property: Minimum time it took to process request on backend.
String	subscriptionId() Get the subscriptionId property: Subscription identifier path.
OffsetDateTime	timestamp() Get the timestamp property: Start of aggregation period.
String	userId() Get the userId property: User identifier path.
void	validate() Validates the instance.
ReportRecordContractInner	withApiId(String apiId) Set the apiId property: API identifier path.
ReportRecordContractInner	withApiRegion(String apiRegion) Set the apiRegion property: API region identifier.
ReportRecordContractInner	withApiTimeAvg(Double apiTimeAvg) Set the apiTimeAvg property: Average time it took to process request.
ReportRecordContractInner	withApiTimeMax(Double apiTimeMax) Set the apiTimeMax property: Maximum time it took to process request.
ReportRecordContractInner	withApiTimeMin(Double apiTimeMin) Set the apiTimeMin property: Minimum time it took to process request.
ReportRecordContractInner	withBandwidth(Long bandwidth) Set the bandwidth property: Bandwidth consumed.
ReportRecordContractInner	withCacheHitCount(Integer cacheHitCount) Set the cacheHitCount property: Number of times when content was served from cache policy.
ReportRecordContractInner	withCacheMissCount(Integer cacheMissCount) Set the cacheMissCount property: Number of times content was fetched from backend.
ReportRecordContractInner	withCallCountBlocked(Integer callCountBlocked) Set the callCountBlocked property: Number of calls blocked due to invalid credentials.
ReportRecordContractInner	withCallCountFailed(Integer callCountFailed) Set the callCountFailed property: Number of calls failed due to gateway or backend errors.
ReportRecordContractInner	withCallCountOther(Integer callCountOther) Set the callCountOther property: Number of other calls.
ReportRecordContractInner	withCallCountSuccess(Integer callCountSuccess) Set the callCountSuccess property: Number of successful calls.
ReportRecordContractInner	withCallCountTotal(Integer callCountTotal) Set the callCountTotal property: Total number of calls.
ReportRecordContractInner	withCountry(String country) Set the country property: Country to which this record data is related.
ReportRecordContractInner	withInterval(String interval) Set the interval property: Length of aggregation period.
ReportRecordContractInner	withName(String name) Set the name property: Name depending on report endpoint specifies product, API, operation or developer name.
ReportRecordContractInner	withOperationId(String operationId) Set the operationId property: Operation identifier path.
ReportRecordContractInner	withRegion(String region) Set the region property: Country region to which this record data is related.
ReportRecordContractInner	withServiceTimeAvg(Double serviceTimeAvg) Set the serviceTimeAvg property: Average time it took to process request on backend.
ReportRecordContractInner	withServiceTimeMax(Double serviceTimeMax) Set the serviceTimeMax property: Maximum time it took to process request on backend.
ReportRecordContractInner	withServiceTimeMin(Double serviceTimeMin) Set the serviceTimeMin property: Minimum time it took to process request on backend.
ReportRecordContractInner	withSubscriptionId(String subscriptionId) Set the subscriptionId property: Subscription identifier path.
ReportRecordContractInner	withTimestamp(OffsetDateTime timestamp) Set the timestamp property: Start of aggregation period.
ReportRecordContractInner	withZip(String zip) Set the zip property: Zip code to which this record data is related.
String	zip() Get the zip property: Zip code to which this record data is related.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ReportRecordContractInner

public ReportRecordContractInner()

Creates an instance of ReportRecordContractInner class.

Method Details

apiId

public String apiId()

Get the apiId property: API identifier path. /apis/{apiId}.

Returns:

the apiId value.

apiRegion

public String apiRegion()

Get the apiRegion property: API region identifier.

Returns:

the apiRegion value.

apiTimeAvg

public Double apiTimeAvg()

Get the apiTimeAvg property: Average time it took to process request.

Returns:

the apiTimeAvg value.

apiTimeMax

public Double apiTimeMax()

Get the apiTimeMax property: Maximum time it took to process request.

Returns:

the apiTimeMax value.

apiTimeMin

public Double apiTimeMin()

Get the apiTimeMin property: Minimum time it took to process request.

Returns:

the apiTimeMin value.

bandwidth

public Long bandwidth()

Get the bandwidth property: Bandwidth consumed.

Returns:

the bandwidth value.

cacheHitCount

public Integer cacheHitCount()

Get the cacheHitCount property: Number of times when content was served from cache policy.

Returns:

the cacheHitCount value.

cacheMissCount

public Integer cacheMissCount()

Get the cacheMissCount property: Number of times content was fetched from backend.

Returns:

the cacheMissCount value.

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.

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.

callCountOther

public Integer callCountOther()

Get the callCountOther property: Number of other calls.

Returns:

the callCountOther value.

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.

callCountTotal

public Integer callCountTotal()

Get the callCountTotal property: Total number of calls.

Returns:

the callCountTotal value.

country

public String country()

Get the country property: Country to which this record data is related.

Returns:

the country value.

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.

name

public String name()

Get the name property: Name depending on report endpoint specifies product, API, operation or developer name.

Returns:

the name value.

operationId

public String operationId()

Get the operationId property: Operation identifier path. /apis/{apiId}/operations/{operationId}.

Returns:

the operationId value.

productId

public String productId()

Get the productId property: Product identifier path. /products/{productId}.

Returns:

the productId value.

region

public String region()

Get the region property: Country region to which this record data is related.

Returns:

the region value.

serviceTimeAvg

public Double serviceTimeAvg()

Get the serviceTimeAvg property: Average time it took to process request on backend.

Returns:

the serviceTimeAvg value.

serviceTimeMax

public Double serviceTimeMax()

Get the serviceTimeMax property: Maximum time it took to process request on backend.

Returns:

the serviceTimeMax value.

serviceTimeMin

public Double serviceTimeMin()

Get the serviceTimeMin property: Minimum time it took to process request on backend.

Returns:

the serviceTimeMin value.

subscriptionId

public String subscriptionId()

Get the subscriptionId property: Subscription identifier path. /subscriptions/{subscriptionId}.

Returns:

the subscriptionId value.

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.

userId

public String userId()

Get the userId property: User identifier path. /users/{userId}.

Returns:

the userId value.

validate

public void validate()

Validates the instance.

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.

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.

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.

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.

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.

withBandwidth

public ReportRecordContractInner withBandwidth(Long bandwidth)

Set the bandwidth property: Bandwidth consumed.

Parameters:

bandwidth - the bandwidth value to set.

Returns:

the ReportRecordContractInner object itself.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

zip

public String zip()

Get the zip property: Zip code to which this record data is related.

Returns:

the zip value.