com.google.api.control.model

Class ReportRequestInfo

java.lang.Object

com.google.api.control.model.OperationInfo

com.google.api.control.model.ReportRequestInfo

public class ReportRequestInfo
extends OperationInfo

Holds information about a ReportRequest to be obtained from the HTTP layer. Also provides methods for converting that info into protocol buffer messages used in the caching and transport layers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportRequestInfo.ErrorCause Enumerates the reported causes of errors.
static class	ReportRequestInfo.ReportedPlatforms ReportedPlatform enumerates the platforms that may be reported.
static class	ReportRequestInfo.ReportedProtocols ReportedProtocols enumerates the protocols that may be reported.

Field Summary

Fields inherited from class com.google.api.control.model.OperationInfo

SCC_CALLER_IP, SCC_REFERER, SCC_SERVICE_AGENT, SCC_USER_AGENT

Constructor Summary

Constructors

Constructor and Description
ReportRequestInfo() Default constructor, Does not initialize the fields of the base OperationInfo.
ReportRequestInfo(OperationInfo o) A copy constructor that initializes the OperationInfo fields from a base instance.

Method Summary

Modifier and Type	Method and Description
com.google.api.servicecontrol.v1.LogEntry.Builder	asLogEntry(java.lang.String name, long timestampMillis) Make a LogEntry from the instance.
com.google.api.servicecontrol.v1.ReportRequest	asReportRequest(ReportingRule rules, com.google.api.client.util.Clock clock) Make a LogEntry from the instance.
java.lang.String	getApiMethod()
java.lang.String	getApiName()
java.lang.String	getApiVersion()
java.lang.String	getAuthAudience()
java.lang.String	getAuthIssuer()
long	getBackendTimeMillis()
ReportRequestInfo.ErrorCause	getErrorCause()
java.lang.String	getLocation()
java.lang.String	getLogMessage()
java.lang.String	getMethod()
long	getOverheadTimeMillis()
ReportRequestInfo.ReportedPlatforms	getPlatform()
java.lang.String	getProducerProjectId()
ReportRequestInfo.ReportedProtocols	getProtocol()
long	getRequestSize()
long	getRequestTimeMillis()
int	getResponseCode()
long	getResponseSize()
java.lang.String	getUrl()
ReportRequestInfo	setApiMethod(java.lang.String apiMethod)
ReportRequestInfo	setApiName(java.lang.String apiName)
ReportRequestInfo	setApiVersion(java.lang.String apiVersion)
ReportRequestInfo	setAuthAudience(java.lang.String authAudience)
ReportRequestInfo	setAuthIssuer(java.lang.String authIssuer)
ReportRequestInfo	setBackendTimeMillis(long backendTimeMillis)
ReportRequestInfo	setErrorCause(ReportRequestInfo.ErrorCause errorCause)
ReportRequestInfo	setLocation(java.lang.String location)
ReportRequestInfo	setLogMessage(java.lang.String logMessage)
ReportRequestInfo	setMethod(java.lang.String method)
ReportRequestInfo	setOverheadTimeMillis(long overheadTimeMillis)
ReportRequestInfo	setPlatform(ReportRequestInfo.ReportedPlatforms platform)
ReportRequestInfo	setProducerProjectId(java.lang.String producerProjectId)
ReportRequestInfo	setProtocol(ReportRequestInfo.ReportedProtocols protocol)
ReportRequestInfo	setRequestSize(long requestSize)
ReportRequestInfo	setRequestTimeMillis(long requestTimeMillis)
ReportRequestInfo	setResponseCode(int responseCode)
ReportRequestInfo	setResponseSize(long responseSize)
ReportRequestInfo	setUrl(java.lang.String url)

Methods inherited from class com.google.api.control.model.OperationInfo

asOperation, getApiKey, getConsumerProjectId, getOperationConsumerId, getOperationId, getOperationName, getReferer, getServiceName, getSystemLabels, isApiKeyValid, setApiKey, setApiKeyValid, setConsumerProjectId, setOperationId, setOperationName, setReferer, setServiceName

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportRequestInfo

public ReportRequestInfo()

Default constructor, Does not initialize the fields of the base OperationInfo.

ReportRequestInfo

public ReportRequestInfo(OperationInfo o)

A copy constructor that initializes the OperationInfo fields from a base instance.

Parameters:

o - an {code OperationInfo}

Method Detail

asReportRequest

public com.google.api.servicecontrol.v1.ReportRequest asReportRequest(ReportingRule rules,
                                                                      com.google.api.client.util.Clock clock)

Make a LogEntry from the instance.

Parameters:

rules - ReportingRules

clock - Clock

Returns:

the corresponding ReportRequest

asLogEntry

public com.google.api.servicecontrol.v1.LogEntry.Builder asLogEntry(java.lang.String name,
                                                                    long timestampMillis)

Make a LogEntry from the instance.

Parameters:

name - the name of log

timestampMillis - the timestamp of the log in milliseconds

Returns:

the corresponding LogEntry.Builder

getApiName

public java.lang.String getApiName()

Returns:

the api name of the reported operation

setApiName

public ReportRequestInfo setApiName(java.lang.String apiName)

getApiMethod

public java.lang.String getApiMethod()

Returns:

the api method of the reported operation

setApiMethod

public ReportRequestInfo setApiMethod(java.lang.String apiMethod)

getApiVersion

public java.lang.String getApiVersion()

Returns:

the api version of the reported operation

setApiVersion

public ReportRequestInfo setApiVersion(java.lang.String apiVersion)

getAuthIssuer

public java.lang.String getAuthIssuer()

Returns:

the authentication issuer of the reported operation

setAuthIssuer

public ReportRequestInfo setAuthIssuer(java.lang.String authIssuer)

getAuthAudience

public java.lang.String getAuthAudience()

Returns:

the authentication audience of the reported operation

setAuthAudience

public ReportRequestInfo setAuthAudience(java.lang.String authAudience)

getBackendTimeMillis

public long getBackendTimeMillis()

Returns:

the time in milliseconds spent in the Backend during the reported operation

setBackendTimeMillis

public ReportRequestInfo setBackendTimeMillis(long backendTimeMillis)

getErrorCause

public ReportRequestInfo.ErrorCause getErrorCause()

Returns:

the cause of any error that occurs while making the reported operation

setErrorCause

public ReportRequestInfo setErrorCause(ReportRequestInfo.ErrorCause errorCause)

getLocation

public java.lang.String getLocation()

Returns:

the compute location for of the reported operation

setLocation

public ReportRequestInfo setLocation(java.lang.String location)

getLogMessage

public java.lang.String getLogMessage()

Returns:

the message to log for the reported operation

setLogMessage

public ReportRequestInfo setLogMessage(java.lang.String logMessage)

getMethod

public java.lang.String getMethod()

Returns:

the HTTP method of the reported operation

setMethod

public ReportRequestInfo setMethod(java.lang.String method)

getOverheadTimeMillis

public long getOverheadTimeMillis()

Returns:

the time in milliseconds spent in the library during the reported operation

setOverheadTimeMillis

public ReportRequestInfo setOverheadTimeMillis(long overheadTimeMillis)

getPlatform

public ReportRequestInfo.ReportedPlatforms getPlatform()

Returns:

the platform on which the reported operation was made

setPlatform

public ReportRequestInfo setPlatform(ReportRequestInfo.ReportedPlatforms platform)

getProducerProjectId

public java.lang.String getProducerProjectId()

Returns:

the producer project ID for the reported operation

setProducerProjectId

public ReportRequestInfo setProducerProjectId(java.lang.String producerProjectId)

getProtocol

public ReportRequestInfo.ReportedProtocols getProtocol()

Returns:

the protocol used to make the reported operation

setProtocol

public ReportRequestInfo setProtocol(ReportRequestInfo.ReportedProtocols protocol)

getRequestSize

public long getRequestSize()

Returns:

the size of the reported operation's request

setRequestSize

public ReportRequestInfo setRequestSize(long requestSize)

getRequestTimeMillis

public long getRequestTimeMillis()

Returns:

the full latency in milliseconds of the reported operation

setRequestTimeMillis

public ReportRequestInfo setRequestTimeMillis(long requestTimeMillis)

getResponseCode

public int getResponseCode()

Returns:

the HTTP response code of the reported operation

setResponseCode

public ReportRequestInfo setResponseCode(int responseCode)

getResponseSize

public long getResponseSize()

Returns:

the size of the response of the reported operation

setResponseSize

public ReportRequestInfo setResponseSize(long responseSize)

getUrl

public java.lang.String getUrl()

Returns:

the url of the reported operation

setUrl

public ReportRequestInfo setUrl(java.lang.String url)