com.google.api.control.model

Class CheckRequestInfo

java.lang.Object

com.google.api.control.model.OperationInfo

com.google.api.control.model.CheckRequestInfo

public class CheckRequestInfo
extends OperationInfo

Holds information about a CheckRequest to be obtained from the HTTP layer.

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
CheckRequestInfo()
CheckRequestInfo(OperationInfo o)

Method Summary

Modifier and Type	Method and Description
com.google.api.servicecontrol.v1.CheckRequest	asCheckRequest(com.google.api.client.util.Clock clock) Returns the CheckRequest instance corresponding to this instance.
java.lang.String	getClientIp()
protected java.util.Map<java.lang.String,java.lang.String>	getSystemLabels()
CheckRequestInfo	setClientIp(java.lang.String clientIp)

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

asOperation, getApiKey, getConsumerProjectId, getOperationConsumerId, getOperationId, getOperationName, getReferer, getServiceName, 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

CheckRequestInfo

public CheckRequestInfo()

CheckRequestInfo

public CheckRequestInfo(OperationInfo o)

Method Detail

getClientIp

public java.lang.String getClientIp()

Returns:

the client IP address

setClientIp

public CheckRequestInfo setClientIp(java.lang.String clientIp)

asCheckRequest

public com.google.api.servicecontrol.v1.CheckRequest asCheckRequest(com.google.api.client.util.Clock clock)

Returns the CheckRequest instance corresponding to this instance.

The service name, operation ID and operation Name must all be set

Parameters:

clock - is used to determine the current timestamp

Returns:

a CheckRequest

Throws:

java.lang.IllegalStateException - if any required values are not set when this is called.

getSystemLabels

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

Overrides:

getSystemLabels in class OperationInfo