AWSRequestMetrics.Field (IBM COS SDK for Java 2.14.0 API)

java.lang.Object
- java.lang.Enum<AWSRequestMetrics.Field>
- - com.ibm.cloud.objectstorage.util.AWSRequestMetrics.Field

All Implemented Interfaces:

MetricType, RequestMetricType, Serializable, Comparable<AWSRequestMetrics.Field>

Enclosing class:

AWSRequestMetrics
```
public static enum AWSRequestMetrics.Field
extends Enum<AWSRequestMetrics.Field>
implements RequestMetricType
```
Predefined AWS SDK metric types general across all AWS clients. Client specific predefined metrics like S3 or DynamoDB are defined in the client specific packages.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AWSErrorCode`
`AWSRequestID`
`BytesProcessed`
`ClientExecuteTime` Total number of milliseconds taken for a request/response including the time taken to execute the request handlers, round trip to AWS, and the time taken to execute the response handlers.
`CredentialsRequestTime`
`Exception`
`HttpClientPoolAvailableCount` The number of idle persistent connections.
`HttpClientPoolLeasedCount` The number of persistent connections tracked by the connection manager currently being used to execute requests.
`HttpClientPoolPendingCount` The number of connection requests being blocked awaiting a free connection.
`HttpClientReceiveResponseTime` Number of milliseconds taken to receive the response status and headers from the underlying socket that is connected to AWS.
`HttpClientRetryCount` Number of retries of the underlying http client library in sending a request to AWS.
`HttpClientSendRequestTime` Number of milliseconds taken to write the request headers and payload to the underlying socket that is connected to AWS.
`HttpRequestTime` Number of milliseconds taken to acquire a connection from the connection pool (or create a new connection), send the request (including reading the user's input stream for streaming uploads), and receive the response status and headers.
`HttpSocketReadTime` Number of milliseconds taken to read response payload data off of the underlying socket that is connected to AWS.
`RedirectLocation`
`RequestCount` Number of requests to AWS.
`RequestMarshallTime`
`RequestSigningTime` Number of milliseconds taken to sign a request.
`RequestType` The specific request subtype, such as PutItemRequest, PutObjectRequest, etc.
`ResponseProcessingTime` Number of milliseconds taken to execute the response handler for a response from AWS.
`RetryCapacityConsumed` Snapshot of currently consumed retry capacity.
`RetryCount` Number of retries of AWS SDK sending a request to AWS.
`RetryPauseTime`
`ServiceEndpoint`
`ServiceName`
`StatusCode`
`ThrottledRetryCount` Number of retries that were not attempted due to retry throttling.
`ThrottleException` Used to count and preserve the throttle related exceptions.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSRequestMetrics.Field`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AWSRequestMetrics.Field[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

Methods inherited from interface com.ibm.cloud.objectstorage.metrics.MetricType
name

- Enum Constant Detail
  - AWSErrorCode
```
public static final AWSRequestMetrics.Field AWSErrorCode
```
  - AWSRequestID
```
public static final AWSRequestMetrics.Field AWSRequestID
```
  - RequestType
```
public static final AWSRequestMetrics.Field RequestType
```
    The specific request subtype, such as PutItemRequest, PutObjectRequest, etc.
  - BytesProcessed
```
public static final AWSRequestMetrics.Field BytesProcessed
```
  - ClientExecuteTime
```
public static final AWSRequestMetrics.Field ClientExecuteTime
```
    Total number of milliseconds taken for a request/response including the time taken to execute the request handlers, round trip to AWS, and the time taken to execute the response handlers.
  - CredentialsRequestTime
```
public static final AWSRequestMetrics.Field CredentialsRequestTime
```
  - Exception
```
public static final AWSRequestMetrics.Field Exception
```
  - ThrottleException
```
public static final AWSRequestMetrics.Field ThrottleException
```
    Used to count and preserve the throttle related exceptions.
  - HttpRequestTime
```
public static final AWSRequestMetrics.Field HttpRequestTime
```
    Number of milliseconds taken to acquire a connection from the connection pool (or create a new connection), send the request (including reading the user's input stream for streaming uploads), and receive the response status and headers. This does not include the time needed to download the response payload from the AWS service.
  - RedirectLocation
```
public static final AWSRequestMetrics.Field RedirectLocation
```
  - RequestMarshallTime
```
public static final AWSRequestMetrics.Field RequestMarshallTime
```
  - RequestSigningTime
```
public static final AWSRequestMetrics.Field RequestSigningTime
```
    Number of milliseconds taken to sign a request.
  - ResponseProcessingTime
```
public static final AWSRequestMetrics.Field ResponseProcessingTime
```
    Number of milliseconds taken to execute the response handler for a response from AWS.
  - RequestCount
```
public static final AWSRequestMetrics.Field RequestCount
```
    Number of requests to AWS.
  - RetryCount
```
public static final AWSRequestMetrics.Field RetryCount
```
    Number of retries of AWS SDK sending a request to AWS.
  - RetryCapacityConsumed
```
public static final AWSRequestMetrics.Field RetryCapacityConsumed
```
    Snapshot of currently consumed retry capacity.
  - ThrottledRetryCount
```
public static final AWSRequestMetrics.Field ThrottledRetryCount
```
    Number of retries that were not attempted due to retry throttling.
  - HttpClientRetryCount
```
public static final AWSRequestMetrics.Field HttpClientRetryCount
```
    Number of retries of the underlying http client library in sending a request to AWS.
  - HttpClientSendRequestTime
```
public static final AWSRequestMetrics.Field HttpClientSendRequestTime
```
    Number of milliseconds taken to write the request headers and payload to the underlying socket that is connected to AWS. This does not include any time spent acquiring a connection from the connection pool (or creating a new connection).
  - HttpClientReceiveResponseTime
```
public static final AWSRequestMetrics.Field HttpClientReceiveResponseTime
```
    Number of milliseconds taken to receive the response status and headers from the underlying socket that is connected to AWS. This does not include any time spent reading the response payload.
  - HttpSocketReadTime
```
public static final AWSRequestMetrics.Field HttpSocketReadTime
```
    Number of milliseconds taken to read response payload data off of the underlying socket that is connected to AWS. This does not include any time spent processing the response payload data, or time spent reading the response status/headers.
  - HttpClientPoolAvailableCount
```
public static final AWSRequestMetrics.Field HttpClientPoolAvailableCount
```
    The number of idle persistent connections.
    Reference: https://hc.apache .org/httpcomponents-core-ga/httpcore/apidocs/org/apache /http/pool/PoolStats.html
  - HttpClientPoolLeasedCount
```
public static final AWSRequestMetrics.Field HttpClientPoolLeasedCount
```
    The number of persistent connections tracked by the connection manager currently being used to execute requests.
    Reference: https://hc .apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache /http/pool/PoolStats.html
  - HttpClientPoolPendingCount
```
public static final AWSRequestMetrics.Field HttpClientPoolPendingCount
```
    The number of connection requests being blocked awaiting a free connection.
    Reference: https://hc.apache.org/httpcomponents-core-ga/httpcore /apidocs/org/apache/http/pool/PoolStats.html
  - RetryPauseTime
```
public static final AWSRequestMetrics.Field RetryPauseTime
```
  - ServiceEndpoint
```
public static final AWSRequestMetrics.Field ServiceEndpoint
```
  - ServiceName
```
public static final AWSRequestMetrics.Field ServiceName
```
  - StatusCode
```
public static final AWSRequestMetrics.Field StatusCode
```
- Method Detail
  - values
```
public static AWSRequestMetrics.Field[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AWSRequestMetrics.Field c : AWSRequestMetrics.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AWSRequestMetrics.Field valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum AWSRequestMetrics.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.cloud.objectstorage.metrics.MetricType

Enum Constant Detail

AWSErrorCode

AWSRequestID

RequestType

BytesProcessed

ClientExecuteTime

CredentialsRequestTime

Exception

ThrottleException

HttpRequestTime

RedirectLocation

RequestMarshallTime

RequestSigningTime

ResponseProcessingTime

RequestCount

RetryCount

RetryCapacityConsumed

ThrottledRetryCount

HttpClientRetryCount

HttpClientSendRequestTime

HttpClientReceiveResponseTime

HttpSocketReadTime

HttpClientPoolAvailableCount

HttpClientPoolLeasedCount

HttpClientPoolPendingCount

RetryPauseTime

ServiceEndpoint

ServiceName

StatusCode

Method Detail

values

valueOf