ApiCallAttemptMonitoringEvent (AWS SDK for Java

java.lang.Object
- com.amazonaws.monitoring.ApiMonitoringEvent
- - com.amazonaws.monitoring.ApiCallAttemptMonitoringEvent

All Implemented Interfaces:

MonitoringEvent
```
public class ApiCallAttemptMonitoringEvent
extends ApiMonitoringEvent
```
A Monitoring Event that described the results of an Api Call Attempt.

Field Summary

Fields
Modifier and Type Field and Description

static String API_CALL_ATTEMPT_MONITORING_EVENT_TYPE

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

Constructor Summary

Constructors
Constructor and Description

ApiCallAttemptMonitoringEvent()

Constructors
Constructor and Description
`ApiCallAttemptMonitoringEvent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccessKey()`
`Long`	`getAttemptLatency()`
`String`	`getAwsException()`
`String`	`getAwsExceptionMessage()`
`String`	`getFqdn()`
`Integer`	`getHttpStatusCode()`
`Long`	`getRequestLatency()`
`String`	`getSdkException()`
`String`	`getSdkExceptionMessage()`
`String`	`getSessionToken()`
`String`	`getType()`
`String`	`getxAmzId2()`
`String`	`getxAmznRequestId()`
`String`	`getxAmzRequestId()`
`ApiCallAttemptMonitoringEvent`	`withAccessKey(String accessKey)` Sets the accessKey
`ApiCallAttemptMonitoringEvent`	`withApi(String api)` Sets the api
`ApiCallAttemptMonitoringEvent`	`withAttemptLatency(Long attemptLatency)` Sets the latency
`ApiCallAttemptMonitoringEvent`	`withAwsException(String awsException)` Sets the awsException
`ApiCallAttemptMonitoringEvent`	`withAwsExceptionMessage(String awsExceptionMessage)` Sets the awsExceptionMessage
`ApiCallAttemptMonitoringEvent`	`withClientId(String clientId)` Sets the clientId
`ApiCallAttemptMonitoringEvent`	`withFqdn(String fqdn)` Sets the fqdn
`ApiCallAttemptMonitoringEvent`	`withHttpStatusCode(Integer httpStatusCode)` Sets the httpStatusCode
`ApiCallAttemptMonitoringEvent`	`withRegion(String region)` Sets the region
`ApiCallAttemptMonitoringEvent`	`withRequestLatency(Long requestLatency)` Sets the requestLatency
`ApiCallAttemptMonitoringEvent`	`withSdkException(String sdkException)` Sets the sdkException
`ApiCallAttemptMonitoringEvent`	`withSdkExceptionMessage(String sdkExceptionMessage)` Sets the sdkExceptionMessage
`ApiCallAttemptMonitoringEvent`	`withService(String service)` Sets the service against which the call is being made.
`ApiCallAttemptMonitoringEvent`	`withSessionToken(String sessionToken)` Sets the sessionToken
`ApiCallAttemptMonitoringEvent`	`withTimestamp(Long timestamp)` Sets the timestamp, in milliseconds, since January 1st, 1970, for the time point at which the event.
`ApiCallAttemptMonitoringEvent`	`withUserAgent(String userAgent)` Sets the userAgent
`ApiCallAttemptMonitoringEvent`	`withVersion(Integer version)` Sets the version.
`ApiCallAttemptMonitoringEvent`	`withXAmzId2(String xAmzId2)` Sets the value of x-amz-id-2 in response header
`ApiCallAttemptMonitoringEvent`	`withXAmznRequestId(String xAmznRequestId)` Sets the value of x-amzn-RequestId in response header
`ApiCallAttemptMonitoringEvent`	`withXAmzRequestId(String xAmzRequestId)` Sets the value of x-amz-request-id in response header

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

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

- Field Detail
  - API_CALL_ATTEMPT_MONITORING_EVENT_TYPE
```
public static final String API_CALL_ATTEMPT_MONITORING_EVENT_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ApiCallAttemptMonitoringEvent
```
public ApiCallAttemptMonitoringEvent()
```
- Method Detail
  - withApi
```
public ApiCallAttemptMonitoringEvent 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 ApiCallAttemptMonitoringEvent 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 ApiCallAttemptMonitoringEvent 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.
  - withService
```
public ApiCallAttemptMonitoringEvent 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 ApiCallAttemptMonitoringEvent 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 ApiCallAttemptMonitoringEvent 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 attempt is passed to the http client.
    
    Specified by:
    
    withTimestamp in class ApiMonitoringEvent
    
    Parameters:
    
    timestamp - The new timestamp value.
    
    Returns:
    
    This object for method chaining.
  - getFqdn
```
public String getFqdn()
```
    Returns:
    
    the fully-qualified domain name of the endpoint that the request attempt was submitted to.
  - withFqdn
```
public ApiCallAttemptMonitoringEvent withFqdn(String fqdn)
```
    Sets the fqdn
    
    Parameters:
    
    fqdn - The new fqdn value.
    
    Returns:
    
    This object for method chaining.
  - withRegion
```
public ApiCallAttemptMonitoringEvent withRegion(String region)
```
    Sets the region
    
    Specified by:
    
    withRegion in class ApiMonitoringEvent
    
    Parameters:
    
    region - The new region value.
    
    Returns:
    
    This object for method chaining.
  - getAccessKey
```
public String getAccessKey()
```
    Returns:
    
    Contains the aws_access_key value that was used to sign the http request.
  - withAccessKey
```
public ApiCallAttemptMonitoringEvent withAccessKey(String accessKey)
```
    Sets the accessKey
    
    Parameters:
    
    accessKey - The new accessKey value.
    
    Returns:
    
    This object for method chaining.
  - getSessionToken
```
public String getSessionToken()
```
    Returns:
    
    Contains the session token passed in the x-amz-security-token header.
  - withSessionToken
```
public ApiCallAttemptMonitoringEvent withSessionToken(String sessionToken)
```
    Sets the sessionToken
    
    Parameters:
    
    sessionToken - The new sessionToken value.
    
    Returns:
    
    This object for method chaining.
  - getHttpStatusCode
```
public Integer getHttpStatusCode()
```
    Returns:
    
    the attempt's response status code, as returned by the http client.
  - withHttpStatusCode
```
public ApiCallAttemptMonitoringEvent withHttpStatusCode(Integer httpStatusCode)
```
    Sets the httpStatusCode
    
    Parameters:
    
    httpStatusCode - The new httpStatusCode value.
    
    Returns:
    
    This object for method chaining.
  - getxAmznRequestId
```
public String getxAmznRequestId()
```
    Returns:
    
    the value of x-amzn-RequestId in response header
  - withXAmznRequestId
```
public ApiCallAttemptMonitoringEvent withXAmznRequestId(String xAmznRequestId)
```
    Sets the value of x-amzn-RequestId in response header
    
    Parameters:
    
    xAmznRequestId - The new value.
    
    Returns:
    
    This object for method chaining.
  - getxAmzRequestId
```
public String getxAmzRequestId()
```
    Returns:
    
    the value of x-amz-request-id in response header
  - withXAmzRequestId
```
public ApiCallAttemptMonitoringEvent withXAmzRequestId(String xAmzRequestId)
```
    Sets the value of x-amz-request-id in response header
    
    Parameters:
    
    xAmzRequestId - The new value.
    
    Returns:
    
    This object for method chaining.
  - getxAmzId2
```
public String getxAmzId2()
```
    Returns:
    
    the value of x-amz-id-2 in response header
  - withXAmzId2
```
public ApiCallAttemptMonitoringEvent withXAmzId2(String xAmzId2)
```
    Sets the value of x-amz-id-2 in response header
    
    Parameters:
    
    xAmzId2 - the new value.
    
    Returns:
    
    This object for method chaining.
  - getAwsException
```
public String getAwsException()
```
    Returns:
    
    the Aws exception code
  - withAwsException
```
public ApiCallAttemptMonitoringEvent withAwsException(String awsException)
```
    Sets the awsException
    
    Parameters:
    
    awsException - The new awsException value.
    
    Returns:
    
    This object for method chaining.
  - getAwsExceptionMessage
```
public String getAwsExceptionMessage()
```
    Returns:
    
    the exception message
  - withAwsExceptionMessage
```
public ApiCallAttemptMonitoringEvent withAwsExceptionMessage(String awsExceptionMessage)
```
    Sets the awsExceptionMessage
    
    Parameters:
    
    awsExceptionMessage - The new awsExceptionMessage value.
    
    Returns:
    
    This object for method chaining.
  - getSdkException
```
public String getSdkException()
```
    Returns:
    
    the exception class name
  - withSdkException
```
public ApiCallAttemptMonitoringEvent withSdkException(String sdkException)
```
    Sets the sdkException
    
    Parameters:
    
    sdkException - The new sdkException value.
    
    Returns:
    
    This object for method chaining.
  - getSdkExceptionMessage
```
public String getSdkExceptionMessage()
```
    Returns:
    
    Contains the full text for any attempt-level failure that is due to something other than an Aws exception.
  - withSdkExceptionMessage
```
public ApiCallAttemptMonitoringEvent withSdkExceptionMessage(String sdkExceptionMessage)
```
    Sets the sdkExceptionMessage
    
    Parameters:
    
    sdkExceptionMessage - The new sdkExceptionMessage value.
    
    Returns:
    
    This object for method chaining.
  - getAttemptLatency
```
public Long getAttemptLatency()
```
    Returns:
    
    the elapsed time, in milliseconds, between the construction of the http request and the point in time where the http response has been parsed or the attempt has definitively failed
  - withAttemptLatency
```
public ApiCallAttemptMonitoringEvent withAttemptLatency(Long attemptLatency)
```
    Sets the latency
    
    Parameters:
    
    attemptLatency - The new latency value.
    
    Returns:
    
    This object for method chaining.
  - getRequestLatency
```
public Long getRequestLatency()
```
    Returns:
    
    the time interval (in milliseconds) between when the request begins transmission to the service and when the response has been parsed, excluding streaming payloads.
  - withRequestLatency
```
public ApiCallAttemptMonitoringEvent withRequestLatency(Long requestLatency)
```
    Sets the requestLatency
    
    Parameters:
    
    requestLatency - The new requestLatency value.
    
    Returns:
    
    This object for method chaining.
  - getType
```
public String getType()
```
    Specified by:
    
    getType in class ApiMonitoringEvent
    
    Returns:
    
    the type of the event

Did this page help you?

Class ApiCallAttemptMonitoringEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.monitoring.ApiMonitoringEvent

Methods inherited from class java.lang.Object

Field Detail

API_CALL_ATTEMPT_MONITORING_EVENT_TYPE

Constructor Detail

ApiCallAttemptMonitoringEvent

Method Detail

withApi

withVersion

withUserAgent

withService

withClientId

withTimestamp

getFqdn

withFqdn

withRegion

getAccessKey

withAccessKey

getSessionToken

withSessionToken

getHttpStatusCode

withHttpStatusCode

getxAmznRequestId

withXAmznRequestId

getxAmzRequestId

withXAmzRequestId

getxAmzId2

withXAmzId2

getAwsException

withAwsException

getAwsExceptionMessage

withAwsExceptionMessage

getSdkException

withSdkException

getSdkExceptionMessage

withSdkExceptionMessage

getAttemptLatency

withAttemptLatency

getRequestLatency

withRequestLatency

getType