All Implemented Interfaces:

MonitoringEvent

Direct Known Subclasses:

ApiCallAttemptMonitoringEvent, ApiCallMonitoringEvent

public abstract class ApiMonitoringEvent
extends Object
implements MonitoringEvent 

• Constructor Summary

  Constructors

  Constructor and Description
  ApiMonitoringEvent ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  String	getApi ()
  String	getClientId ()
  String	getRegion ()
  String	getService ()
  Long	getTimestamp ()
  abstract String	getType ()
  String	getUserAgent ()
  Integer	getVersion ()
  abstract ApiMonitoringEvent	withApi (String api) Sets the api
  abstract ApiMonitoringEvent	withClientId (String clientId) Sets the clientId
  abstract ApiMonitoringEvent	withRegion (String region) Sets the region
  abstract ApiMonitoringEvent	withService (String service) Sets the service against which the call is being made.
  abstract ApiMonitoringEvent	withTimestamp (Long timestamp) Sets the timestamp, in milliseconds, since January 1st, 1970, for the time point at which the event.
  abstract ApiMonitoringEvent	withUserAgent (String userAgent) Sets the userAgent
  abstract ApiMonitoringEvent	withVersion (Integer version) Sets the version.

  • Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Detail

  • ApiMonitoringEvent

    public ApiMonitoringEvent()

• Method Detail

  • getApi

    public String getApi()

    Returns:

    the operation name for the api call being made.

  • getService

    public String getService()

    Returns:

    The service against which the call is being made.

  • withService

    public abstract ApiMonitoringEvent withService(String service)

    Sets the service against which the call is being made.

    Parameters:

    service - The new service value.

    Returns:

    This object for method chaining.

  • getClientId

    public String getClientId()

    Returns:

    The "ClientId" configuration value as obtained from an application configuration provider chain

  • withClientId

    public abstract ApiMonitoringEvent withClientId(String clientId)

    Sets the clientId

    Parameters:

    clientId - The new clientId value.

    Returns:

    This object for method chaining.

  • getTimestamp

    public Long getTimestamp()

    Returns:

    Contains the elapsed time, in milliseconds, since January 1st, 1970, for the time point at which the event occurred.

  • withTimestamp

    public abstract ApiMonitoringEvent withTimestamp(Long timestamp)

    Sets the timestamp, in milliseconds, since January 1st, 1970, for the time point at which the event.

    Parameters:

    timestamp - The new timestamp value.

    Returns:

    This object for method chaining.

  • withApi

    public abstract ApiMonitoringEvent withApi(String api)

    Sets the api

    Parameters:

    api - The new api value.

    Returns:

    This object for method chaining.

  • getVersion

    public Integer getVersion()

    Returns:

    the version.

  • withVersion

    public abstract ApiMonitoringEvent withVersion(Integer version)

    Sets the version.

    Parameters:

    version - the new version value.

    Returns:

    This object for method chaining.

  • getRegion

    public String getRegion()

    Returns:

    the signing region used by the service client to perform the request's attempt(s). For requests that end up making attempts to more than one region due to redirection, the region used on the final attempt must be used as the Region value for the overall Api Call event.

  • withRegion

    public abstract ApiMonitoringEvent withRegion(String region)

    Sets the region

    Parameters:

    region - The new region value.

    Returns:

    This object for method chaining.

  • getUserAgent

    public String getUserAgent()

    Returns:

    The full value of the SDK's default user agent header for http requests.

  • withUserAgent

    public abstract ApiMonitoringEvent withUserAgent(String userAgent)

    Sets the userAgent

    Parameters:

    userAgent - The new userAgent value.

    Returns:

    This object for method chaining.

  • getType

    public abstract String getType()

    Returns:

    the type of the event