com.google.api.control.model

Class OperationInfo

java.lang.Object

com.google.api.control.model.OperationInfo

Direct Known Subclasses:

CheckRequestInfo, QuotaRequestInfo, ReportRequestInfo

public class OperationInfo
extends java.lang.Object

Holds basic information about an operation to be obtained from the HTTP layer.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCC_CALLER_IP
static java.lang.String	SCC_REFERER
static java.lang.String	SCC_SERVICE_AGENT
static java.lang.String	SCC_USER_AGENT

Constructor Summary

Constructors

Constructor and Description
OperationInfo()

Method Summary

Modifier and Type	Method and Description
com.google.api.servicecontrol.v1.Operation	asOperation(com.google.api.client.util.Clock clock) Returns the Operation instance corresponding to this instance.
java.lang.String	getApiKey()
java.lang.String	getConsumerProjectId()
java.lang.String	getOperationConsumerId()
java.lang.String	getOperationId()
java.lang.String	getOperationName()
java.lang.String	getReferer()
java.lang.String	getServiceName()
protected java.util.Map<java.lang.String,java.lang.String>	getSystemLabels()
boolean	isApiKeyValid()
OperationInfo	setApiKey(java.lang.String apiKey)
OperationInfo	setApiKeyValid(boolean apiKeyValid)
OperationInfo	setConsumerProjectId(java.lang.String consumerProjectId)
OperationInfo	setOperationId(java.lang.String operationId)
OperationInfo	setOperationName(java.lang.String operationName)
OperationInfo	setReferer(java.lang.String referer)
OperationInfo	setServiceName(java.lang.String serviceName)

Methods inherited from class java.lang.Object

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

Field Detail

SCC_CALLER_IP

public static final java.lang.String SCC_CALLER_IP

See Also:

Constant Field Values

SCC_USER_AGENT

public static final java.lang.String SCC_USER_AGENT

See Also:

Constant Field Values

SCC_SERVICE_AGENT

public static final java.lang.String SCC_SERVICE_AGENT

See Also:

Constant Field Values

SCC_REFERER

public static final java.lang.String SCC_REFERER

See Also:

Constant Field Values

Constructor Detail

OperationInfo

public OperationInfo()

Method Detail

asOperation

public com.google.api.servicecontrol.v1.Operation asOperation(com.google.api.client.util.Clock clock)

Returns the Operation instance corresponding to this instance.

Parameters:

clock - is used to determine the current timestamp

Returns:

a Operation

getApiKey

public java.lang.String getApiKey()

Returns:

the API key

setApiKey

public OperationInfo setApiKey(java.lang.String apiKey)

isApiKeyValid

public boolean isApiKeyValid()

Returns:

true if the API key is valid, otherwise false

setApiKeyValid

public OperationInfo setApiKeyValid(boolean apiKeyValid)

getConsumerProjectId

public java.lang.String getConsumerProjectId()

Returns:

the consumer project ID

setConsumerProjectId

public OperationInfo setConsumerProjectId(java.lang.String consumerProjectId)

getOperationId

public java.lang.String getOperationId()

Returns:

the operation ID

setOperationId

public OperationInfo setOperationId(java.lang.String operationId)

getOperationName

public java.lang.String getOperationName()

Returns:

the operation Name

setOperationName

public OperationInfo setOperationName(java.lang.String operationName)

getReferer

public java.lang.String getReferer()

Returns:

the requests' referer header

setReferer

public OperationInfo setReferer(java.lang.String referer)

getServiceName

public java.lang.String getServiceName()

Returns:

the service name

setServiceName

public OperationInfo setServiceName(java.lang.String serviceName)

getOperationConsumerId

public java.lang.String getOperationConsumerId()

Returns:

a consumer id suitable for insertion into an operation

getSystemLabels

protected java.util.Map<java.lang.String,java.lang.String> getSystemLabels()