Interface CheckResponse.CheckInfoOrBuilder (1.42.0)

public static interface CheckResponse.CheckInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiKeyUid()

public abstract String getApiKeyUid()

The unique id of the api key in the format of "apikey:<UID>". This field will be populated when the consumer passed to Service Control is an API key and all the API key related validations are successful.

string api_key_uid = 5;

Returns
Type Description
String

The apiKeyUid.

getApiKeyUidBytes()

public abstract ByteString getApiKeyUidBytes()

The unique id of the api key in the format of "apikey:<UID>". This field will be populated when the consumer passed to Service Control is an API key and all the API key related validations are successful.

string api_key_uid = 5;

Returns
Type Description
ByteString

The bytes for apiKeyUid.

getConsumerInfo()

public abstract CheckResponse.ConsumerInfo getConsumerInfo()

Consumer info of this check.

.google.api.servicecontrol.v1.CheckResponse.ConsumerInfo consumer_info = 2;

Returns
Type Description
CheckResponse.ConsumerInfo

The consumerInfo.

getConsumerInfoOrBuilder()

public abstract CheckResponse.ConsumerInfoOrBuilder getConsumerInfoOrBuilder()

Consumer info of this check.

.google.api.servicecontrol.v1.CheckResponse.ConsumerInfo consumer_info = 2;

Returns
Type Description
CheckResponse.ConsumerInfoOrBuilder

getUnusedArguments(int index)

public abstract String getUnusedArguments(int index)

A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation.

repeated string unused_arguments = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The unusedArguments at the given index.

getUnusedArgumentsBytes(int index)

public abstract ByteString getUnusedArgumentsBytes(int index)

A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation.

repeated string unused_arguments = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the unusedArguments at the given index.

getUnusedArgumentsCount()

public abstract int getUnusedArgumentsCount()

A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation.

repeated string unused_arguments = 1;

Returns
Type Description
int

The count of unusedArguments.

getUnusedArgumentsList()

public abstract List<String> getUnusedArgumentsList()

A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation.

repeated string unused_arguments = 1;

Returns
Type Description
List<String>

A list containing the unusedArguments.

hasConsumerInfo()

public abstract boolean hasConsumerInfo()

Consumer info of this check.

.google.api.servicecontrol.v1.CheckResponse.ConsumerInfo consumer_info = 2;

Returns
Type Description
boolean

Whether the consumerInfo field is set.