Class CheckResponse.CheckInfo.Builder (1.46.0)

public static final class CheckResponse.CheckInfo.Builder extends GeneratedMessageV3.Builder<CheckResponse.CheckInfo.Builder> implements CheckResponse.CheckInfoOrBuilder

Contains additional information about the check operation.

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

Static Methods

getDescriptor()

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

Methods

addAllUnusedArguments(Iterable<String> values)

public CheckResponse.CheckInfo.Builder addAllUnusedArguments(Iterable<String> values)

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
values Iterable<String>

The unusedArguments to add.

Returns
Type Description
CheckResponse.CheckInfo.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CheckResponse.CheckInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

addUnusedArguments(String value)

public CheckResponse.CheckInfo.Builder addUnusedArguments(String value)

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
value String

The unusedArguments to add.

Returns
Type Description
CheckResponse.CheckInfo.Builder

This builder for chaining.

addUnusedArgumentsBytes(ByteString value)

public CheckResponse.CheckInfo.Builder addUnusedArgumentsBytes(ByteString value)

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
value ByteString

The bytes of the unusedArguments to add.

Returns
Type Description
CheckResponse.CheckInfo.Builder

This builder for chaining.

build()

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

buildPartial()

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

clear()

public CheckResponse.CheckInfo.Builder clear()
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

clearApiKeyUid()

public CheckResponse.CheckInfo.Builder clearApiKeyUid()

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
CheckResponse.CheckInfo.Builder

This builder for chaining.

clearConsumerInfo()

public CheckResponse.CheckInfo.Builder clearConsumerInfo()

Consumer info of this check.

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

Returns
Type Description
CheckResponse.CheckInfo.Builder

clearField(Descriptors.FieldDescriptor field)

public CheckResponse.CheckInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CheckResponse.CheckInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

clearUnusedArguments()

public CheckResponse.CheckInfo.Builder clearUnusedArguments()

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
CheckResponse.CheckInfo.Builder

This builder for chaining.

clone()

public CheckResponse.CheckInfo.Builder clone()
Returns
Type Description
CheckResponse.CheckInfo.Builder
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.

getConsumerInfoBuilder()

public CheckResponse.ConsumerInfo.Builder getConsumerInfoBuilder()

Consumer info of this check.

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

Returns
Type Description
CheckResponse.ConsumerInfo.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConsumerInfo(CheckResponse.ConsumerInfo value)

public CheckResponse.CheckInfo.Builder mergeConsumerInfo(CheckResponse.ConsumerInfo value)

Consumer info of this check.

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

Parameter
Name Description
value CheckResponse.ConsumerInfo
Returns
Type Description
CheckResponse.CheckInfo.Builder

mergeFrom(CheckResponse.CheckInfo other)

public CheckResponse.CheckInfo.Builder mergeFrom(CheckResponse.CheckInfo other)
Parameter
Name Description
other CheckResponse.CheckInfo
Returns
Type Description
CheckResponse.CheckInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CheckResponse.CheckInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CheckResponse.CheckInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CheckResponse.CheckInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

setApiKeyUid(String value)

public CheckResponse.CheckInfo.Builder setApiKeyUid(String value)

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;

Parameter
Name Description
value String

The apiKeyUid to set.

Returns
Type Description
CheckResponse.CheckInfo.Builder

This builder for chaining.

setApiKeyUidBytes(ByteString value)

public CheckResponse.CheckInfo.Builder setApiKeyUidBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for apiKeyUid to set.

Returns
Type Description
CheckResponse.CheckInfo.Builder

This builder for chaining.

setConsumerInfo(CheckResponse.ConsumerInfo value)

public CheckResponse.CheckInfo.Builder setConsumerInfo(CheckResponse.ConsumerInfo value)

Consumer info of this check.

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

Parameter
Name Description
value CheckResponse.ConsumerInfo
Returns
Type Description
CheckResponse.CheckInfo.Builder

setConsumerInfo(CheckResponse.ConsumerInfo.Builder builderForValue)

public CheckResponse.CheckInfo.Builder setConsumerInfo(CheckResponse.ConsumerInfo.Builder builderForValue)

Consumer info of this check.

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

Parameter
Name Description
builderForValue CheckResponse.ConsumerInfo.Builder
Returns
Type Description
CheckResponse.CheckInfo.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CheckResponse.CheckInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CheckResponse.CheckInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CheckResponse.CheckInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CheckResponse.CheckInfo.Builder
Overrides

setUnusedArguments(int index, String value)

public CheckResponse.CheckInfo.Builder setUnusedArguments(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The unusedArguments to set.

Returns
Type Description
CheckResponse.CheckInfo.Builder

This builder for chaining.