Class ServerKeyRestrictions.Builder (0.42.0)

public static final class ServerKeyRestrictions.Builder extends GeneratedMessageV3.Builder<ServerKeyRestrictions.Builder> implements ServerKeyRestrictionsOrBuilder

The IP addresses of callers that are allowed to use the key.

Protobuf type google.api.apikeys.v2.ServerKeyRestrictions

Static Methods

getDescriptor()

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

Methods

addAllAllowedIps(Iterable<String> values)

public ServerKeyRestrictions.Builder addAllAllowedIps(Iterable<String> values)

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Parameter
Name Description
values Iterable<String>

The allowedIps to add.

Returns
Type Description
ServerKeyRestrictions.Builder

This builder for chaining.

addAllowedIps(String value)

public ServerKeyRestrictions.Builder addAllowedIps(String value)

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Parameter
Name Description
value String

The allowedIps to add.

Returns
Type Description
ServerKeyRestrictions.Builder

This builder for chaining.

addAllowedIpsBytes(ByteString value)

public ServerKeyRestrictions.Builder addAllowedIpsBytes(ByteString value)

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Parameter
Name Description
value ByteString

The bytes of the allowedIps to add.

Returns
Type Description
ServerKeyRestrictions.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ServerKeyRestrictions build()
Returns
Type Description
ServerKeyRestrictions

buildPartial()

public ServerKeyRestrictions buildPartial()
Returns
Type Description
ServerKeyRestrictions

clear()

public ServerKeyRestrictions.Builder clear()
Returns
Type Description
ServerKeyRestrictions.Builder
Overrides

clearAllowedIps()

public ServerKeyRestrictions.Builder clearAllowedIps()

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Returns
Type Description
ServerKeyRestrictions.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public ServerKeyRestrictions.Builder clone()
Returns
Type Description
ServerKeyRestrictions.Builder
Overrides

getAllowedIps(int index)

public String getAllowedIps(int index)

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The allowedIps at the given index.

getAllowedIpsBytes(int index)

public ByteString getAllowedIpsBytes(int index)

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the allowedIps at the given index.

getAllowedIpsCount()

public int getAllowedIpsCount()

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Returns
Type Description
int

The count of allowedIps.

getAllowedIpsList()

public ProtocolStringList getAllowedIpsList()

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Returns
Type Description
ProtocolStringList

A list containing the allowedIps.

getDefaultInstanceForType()

public ServerKeyRestrictions getDefaultInstanceForType()
Returns
Type Description
ServerKeyRestrictions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ServerKeyRestrictions other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAllowedIps(int index, String value)

public ServerKeyRestrictions.Builder setAllowedIps(int index, String value)

A list of the caller IP addresses that are allowed to make API calls with this key.

repeated string allowed_ips = 1;

Parameters
Name Description
index int

The index to set the value at.

value String

The allowedIps to set.

Returns
Type Description
ServerKeyRestrictions.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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