ApiCallMonitoringEvent (IBM COS SDK for Java 2.14.1 API)

java.lang.Object
- com.ibm.cloud.objectstorage.monitoring.ApiMonitoringEvent
- - com.ibm.cloud.objectstorage.monitoring.ApiCallMonitoringEvent

All Implemented Interfaces:

MonitoringEvent
```
public class ApiCallMonitoringEvent
extends ApiMonitoringEvent
```
A Monitoring Event that describes the results of an Api Call.

Field Summary

Fields
Modifier and Type Field and Description

static String API_CALL_MONITORING_EVENT_TYPE
- Fields inherited from class com.ibm.cloud.objectstorage.monitoring.ApiMonitoringEvent
  api, clientId, region, service, timestamp, userAgent, version

Fields
Modifier and Type	Field and Description
`static String`	`API_CALL_MONITORING_EVENT_TYPE`

Constructor Summary

Constructors
Constructor and Description

ApiCallMonitoringEvent()

Constructors
Constructor and Description
`ApiCallMonitoringEvent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getApiCallTimeout()`
`Integer`	`getAttemptCount()`
`String`	`getFinalAwsException()` The `ApiCallAttemptMonitoringEvent.getAwsException()` from the last reported API call attempt.
`String`	`getFinalAwsExceptionMessage()` The `ApiCallAttemptMonitoringEvent.getAwsExceptionMessage()` from the last reported API call attempt.
`Integer`	`getFinalHttpStatusCode()` The last status code returned by the service.
`String`	`getFinalSdkException()` The `ApiCallAttemptMonitoringEvent.getSdkException()` from the last reported API call attempt.
`String`	`getFinalSdkExceptionMessage()` The `ApiCallAttemptMonitoringEvent.getSdkExceptionMessage()` from the last reported API call attempt.
`Long`	`getLatency()`
`int`	`getMaxRetriesExceeded()`
`String`	`getType()`
`ApiCallMonitoringEvent`	`withApi(String api)` Sets the api
`ApiCallMonitoringEvent`	`withApiCallTimeout(int apiCallTimeout)` Sets the api call timeout
`ApiCallMonitoringEvent`	`withAttemptCount(Integer attemptCount)` Sets the attemptCount
`ApiCallMonitoringEvent`	`withClientId(String clientId)` Sets the clientId
`ApiCallMonitoringEvent`	`withFinalAwsException(String finalAwsException)`
`ApiCallMonitoringEvent`	`withFinalAwsExceptionMessage(String finalAwsExceptionMessage)`
`ApiCallMonitoringEvent`	`withFinalHttpStatusCode(Integer finalHttpStatusCode)`
`ApiCallMonitoringEvent`	`withFinalSdkException(String finalSdkException)`
`ApiCallMonitoringEvent`	`withFinalSdkExceptionMessage(String finalSdkExceptionMessage)`
`ApiCallMonitoringEvent`	`withLatency(Long latency)` Sets the latency
`ApiCallMonitoringEvent`	`withMaxRetriesExceeded(int maxRetriesExceeded)` Sets the api call timeout
`ApiCallMonitoringEvent`	`withRegion(String region)` Sets the region
`ApiCallMonitoringEvent`	`withService(String service)` Sets the service against which the call is being made.
`ApiCallMonitoringEvent`	`withTimestamp(Long timestamp)` Sets the timestamp, in milliseconds, since January 1st, 1970, for the time point at which the event.
`ApiCallMonitoringEvent`	`withUserAgent(String userAgent)` Sets the userAgent
`ApiCallMonitoringEvent`	`withVersion(Integer version)` Sets the version.

Methods inherited from class com.ibm.cloud.objectstorage.monitoring.ApiMonitoringEvent
getApi, getClientId, getRegion, getService, getTimestamp, getUserAgent, getVersion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - API_CALL_MONITORING_EVENT_TYPE
```
public static final String API_CALL_MONITORING_EVENT_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ApiCallMonitoringEvent
```
public ApiCallMonitoringEvent()
```
- Method Detail
  - withApi
```
public ApiCallMonitoringEvent withApi(String api)
```
    Description copied from class: ApiMonitoringEvent
    
    Sets the api
    
    Specified by:
    
    withApi in class ApiMonitoringEvent
    
    Parameters:
    
    api - The new api value.
    
    Returns:
    
    This object for method chaining.
  - withVersion
```
public ApiCallMonitoringEvent withVersion(Integer version)
```
    Description copied from class: ApiMonitoringEvent
    
    Sets the version.
    
    Specified by:
    
    withVersion in class ApiMonitoringEvent
    
    Parameters:
    
    version - the new version value.
    
    Returns:
    
    This object for method chaining.
  - withUserAgent
```
public ApiCallMonitoringEvent withUserAgent(String userAgent)
```
    Description copied from class: ApiMonitoringEvent
    
    Sets the userAgent
    
    Specified by:
    
    withUserAgent in class ApiMonitoringEvent
    
    Parameters:
    
    userAgent - The new userAgent value.
    
    Returns:
    
    This object for method chaining.
  - withRegion
```
public ApiCallMonitoringEvent withRegion(String region)
```
    Description copied from class: ApiMonitoringEvent
    
    Sets the region
    
    Specified by:
    
    withRegion in class ApiMonitoringEvent
    
    Parameters:
    
    region - The new region value.
    
    Returns:
    
    This object for method chaining.
  - withService
```
public ApiCallMonitoringEvent withService(String service)
```
    Description copied from class: ApiMonitoringEvent
    
    Sets the service against which the call is being made.
    
    Specified by:
    
    withService in class ApiMonitoringEvent
    
    Parameters:
    
    service - The new service value.
    
    Returns:
    
    This object for method chaining.
  - withClientId
```
public ApiCallMonitoringEvent withClientId(String clientId)
```
    Description copied from class: ApiMonitoringEvent
    
    Sets the clientId
    
    Specified by:
    
    withClientId in class ApiMonitoringEvent
    
    Parameters:
    
    clientId - The new clientId value.
    
    Returns:
    
    This object for method chaining.
  - withTimestamp
```
public ApiCallMonitoringEvent withTimestamp(Long timestamp)
```
    Sets the timestamp, in milliseconds, since January 1st, 1970, for the time point at which the event.
    This is when the request is first seen by the service client.
    
    Specified by:
    
    withTimestamp in class ApiMonitoringEvent
    
    Parameters:
    
    timestamp - The new timestamp value.
    
    Returns:
    
    This object for method chaining.
  - getAttemptCount
```
public Integer getAttemptCount()
```
    Returns:
    
    The total number of attempts that were made by the service client to fulfill this request before succeeding or failing.
  - withAttemptCount
```
public ApiCallMonitoringEvent withAttemptCount(Integer attemptCount)
```
    Sets the attemptCount
    
    Parameters:
    
    attemptCount - The new attemptCount value.
    
    Returns:
    
    This object for method chaining.
  - getLatency
```
public Long getLatency()
```
    Returns:
    
    The elapsed time, in milliseconds, between when the Api Call was begun and when a final response or error is manifested to the caller.
  - withLatency
```
public ApiCallMonitoringEvent withLatency(Long latency)
```
    Sets the latency
    
    Parameters:
    
    latency - The new latency value.
    
    Returns:
    
    This object for method chaining.
  - getApiCallTimeout
```
public int getApiCallTimeout()
```
    Returns:
    
    a boolean (0/1) value that is 0 unless the Api call failed due to hitting an Api Call time limit.
  - withApiCallTimeout
```
public ApiCallMonitoringEvent withApiCallTimeout(int apiCallTimeout)
```
    Sets the api call timeout
    
    Parameters:
    
    apiCallTimeout - The new apiCallTimeout value.
    
    Returns:
    
    This object for method chaining.
  - getMaxRetriesExceeded
```
public int getMaxRetriesExceeded()
```
    Returns:
    
    a boolean (0/1) value that is 0 unless the Api call failed and the final attempt returned a retryable error.
  - withMaxRetriesExceeded
```
public ApiCallMonitoringEvent withMaxRetriesExceeded(int maxRetriesExceeded)
```
    Sets the api call timeout
    
    Parameters:
    
    maxRetriesExceeded - The new maxRetriesExceeded value.
    
    Returns:
    
    This object for method chaining.
  - getFinalAwsException
```
public String getFinalAwsException()
```
    The ApiCallAttemptMonitoringEvent.getAwsException() from the last reported API call attempt. This does not include any exceptions raised between the completion of last API call attempt and the completion of the API call. Consequently, this may be null even if an AwsException thrown by the client.
  - withFinalAwsException
```
public ApiCallMonitoringEvent withFinalAwsException(String finalAwsException)
```
  - getFinalAwsExceptionMessage
```
public String getFinalAwsExceptionMessage()
```
    The ApiCallAttemptMonitoringEvent.getAwsExceptionMessage() from the last reported API call attempt. This does not include any exceptions raised between the completion of last API call attempt and the completion of the API call. Consequently, this may be null even if an AwsException thrown by the client.
  - withFinalAwsExceptionMessage
```
public ApiCallMonitoringEvent withFinalAwsExceptionMessage(String finalAwsExceptionMessage)
```
  - getFinalSdkException
```
public String getFinalSdkException()
```
    The ApiCallAttemptMonitoringEvent.getSdkException() from the last reported API call attempt. This does not include any exceptions raised between the completion of last API call attempt and the completion of the API call. Consequently, this may be null even if an SdkException thrown by the client.
  - withFinalSdkException
```
public ApiCallMonitoringEvent withFinalSdkException(String finalSdkException)
```
  - getFinalSdkExceptionMessage
```
public String getFinalSdkExceptionMessage()
```
    The ApiCallAttemptMonitoringEvent.getSdkExceptionMessage() from the last reported API call attempt. This does not include any exceptions raised between the completion of last API call attempt and the completion of the API call. Consequently, this may be null even if an SdkException thrown by the client.
  - withFinalSdkExceptionMessage
```
public ApiCallMonitoringEvent withFinalSdkExceptionMessage(String finalSdkExceptionMessage)
```
  - getFinalHttpStatusCode
```
public Integer getFinalHttpStatusCode()
```
    The last status code returned by the service. This may be null if the API call or last API call attempt did not succeed.
  - withFinalHttpStatusCode
```
public ApiCallMonitoringEvent withFinalHttpStatusCode(Integer finalHttpStatusCode)
```
  - getType
```
public String getType()
```
    Specified by:
    
    getType in class ApiMonitoringEvent
    
    Returns:
    
    the type of the event

Class ApiCallMonitoringEvent

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.monitoring.ApiMonitoringEvent

Constructor Summary

Method Summary

Methods inherited from class com.ibm.cloud.objectstorage.monitoring.ApiMonitoringEvent

Methods inherited from class java.lang.Object

Field Detail

API_CALL_MONITORING_EVENT_TYPE

Constructor Detail

ApiCallMonitoringEvent

Method Detail

withApi

withVersion

withUserAgent

withRegion

withService

withClientId

withTimestamp

getAttemptCount

withAttemptCount

getLatency

withLatency

getApiCallTimeout

withApiCallTimeout

getMaxRetriesExceeded

withMaxRetriesExceeded

getFinalAwsException

withFinalAwsException

getFinalAwsExceptionMessage

withFinalAwsExceptionMessage

getFinalSdkException

withFinalSdkException

getFinalSdkExceptionMessage

withFinalSdkExceptionMessage

getFinalHttpStatusCode

withFinalHttpStatusCode

getType