Class CheckResponse.CheckInfo (1.42.0)

public static final class CheckResponse.CheckInfo extends GeneratedMessageV3 implements CheckResponse.CheckInfoOrBuilder

Contains additional information about the check operation.

Protobuf type google.api.servicecontrol.v1.CheckResponse.CheckInfo

Static Fields

API_KEY_UID_FIELD_NUMBER

public static final int API_KEY_UID_FIELD_NUMBER
Field Value
Type Description
int

CONSUMER_INFO_FIELD_NUMBER

public static final int CONSUMER_INFO_FIELD_NUMBER
Field Value
Type Description
int

UNUSED_ARGUMENTS_FIELD_NUMBER

public static final int UNUSED_ARGUMENTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CheckResponse.CheckInfo getDefaultInstance()
Returns
Type Description
CheckResponse.CheckInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CheckResponse.CheckInfo.Builder newBuilder()
Returns
Type Description
CheckResponse.CheckInfo.Builder

newBuilder(CheckResponse.CheckInfo prototype)

public static CheckResponse.CheckInfo.Builder newBuilder(CheckResponse.CheckInfo prototype)
Parameter
Name Description
prototype CheckResponse.CheckInfo
Returns
Type Description
CheckResponse.CheckInfo.Builder

parseDelimitedFrom(InputStream input)

public static CheckResponse.CheckInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckResponse.CheckInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CheckResponse.CheckInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CheckResponse.CheckInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CheckResponse.CheckInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CheckResponse.CheckInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CheckResponse.CheckInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckResponse.CheckInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CheckResponse.CheckInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckResponse.CheckInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CheckResponse.CheckInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CheckResponse.CheckInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckResponse.CheckInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CheckResponse.CheckInfo> parser()
Returns
Type Description
Parser<CheckInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApiKeyUid()

public 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 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 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 CheckResponse.ConsumerInfoOrBuilder getConsumerInfoOrBuilder()

Consumer info of this check.

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

Returns
Type Description
CheckResponse.ConsumerInfoOrBuilder

getDefaultInstanceForType()

public CheckResponse.CheckInfo getDefaultInstanceForType()
Returns
Type Description
CheckResponse.CheckInfo

getParserForType()

public Parser<CheckResponse.CheckInfo> getParserForType()
Returns
Type Description
Parser<CheckInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnusedArguments(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the unusedArguments.

hasConsumerInfo()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CheckResponse.CheckInfo.Builder newBuilderForType()
Returns
Type Description
CheckResponse.CheckInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CheckResponse.CheckInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CheckResponse.CheckInfo.Builder toBuilder()
Returns
Type Description
CheckResponse.CheckInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException