Class ServerKeyRestrictions (0.45.0)

public final class ServerKeyRestrictions extends GeneratedMessageV3 implements ServerKeyRestrictionsOrBuilder

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

Protobuf type google.api.apikeys.v2.ServerKeyRestrictions

Static Fields

ALLOWED_IPS_FIELD_NUMBER

public static final int ALLOWED_IPS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ServerKeyRestrictions getDefaultInstance()
Returns
Type Description
ServerKeyRestrictions

getDescriptor()

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

newBuilder()

public static ServerKeyRestrictions.Builder newBuilder()
Returns
Type Description
ServerKeyRestrictions.Builder

newBuilder(ServerKeyRestrictions prototype)

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

parseDelimitedFrom(InputStream input)

public static ServerKeyRestrictions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ServerKeyRestrictions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ServerKeyRestrictions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ServerKeyRestrictions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ServerKeyRestrictions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ServerKeyRestrictions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ServerKeyRestrictions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ServerKeyRestrictions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ServerKeyRestrictions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ServerKeyRestrictions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ServerKeyRestrictions> parser()
Returns
Type Description
Parser<ServerKeyRestrictions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

getParserForType()

public Parser<ServerKeyRestrictions> getParserForType()
Returns
Type Description
Parser<ServerKeyRestrictions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 ServerKeyRestrictions.Builder newBuilderForType()
Returns
Type Description
ServerKeyRestrictions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ServerKeyRestrictions.Builder toBuilder()
Returns
Type Description
ServerKeyRestrictions.Builder

writeTo(CodedOutputStream output)

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