Class Key (2.6.1)

Version 2.6.1

• 3.50.0 (latest)
• 3.49.0
• 3.48.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.12
• 2.6.1
• 2.5.0
• 2.4.10
• 2.3.1

public final class Key extends GeneratedMessageV3 implements KeyOrBuilder

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Protobuf type google.cloud.recaptchaenterprise.v1.Key

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Key

Implements

KeyOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANDROID_SETTINGS_FIELD_NUMBER

public static final int ANDROID_SETTINGS_FIELD_NUMBER

Field Value

Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value

Type	Description
int

IOS_SETTINGS_FIELD_NUMBER

public static final int IOS_SETTINGS_FIELD_NUMBER

Field Value

Type	Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

TESTING_OPTIONS_FIELD_NUMBER

public static final int TESTING_OPTIONS_FIELD_NUMBER

Field Value

Type	Description
int

WEB_SETTINGS_FIELD_NUMBER

public static final int WEB_SETTINGS_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Key getDefaultInstance()

Returns

Type	Description
Key

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Key.Builder newBuilder()

Returns

Type	Description
Key.Builder

newBuilder(Key prototype)

public static Key.Builder newBuilder(Key prototype)

Parameter

Name	Description
prototype	Key

Returns

Type	Description
Key.Builder

parseDelimitedFrom(InputStream input)

public static Key parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Key

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Key parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Key

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Key parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Key

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Key parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Key

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Key parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Key

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Key parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Key

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Key parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Key

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Key parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Key

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Key parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Key

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Key parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Key

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Key parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Key

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Key parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Key

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Key> parser()

Returns

Type	Description
Parser<Key>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">; Creating and managing labels</a>.

map<string, string> labels = 6;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAndroidSettings()

public AndroidKeySettings getAndroidSettings()

Settings for keys that can be used by Android apps.

.google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;

Returns

Type	Description
AndroidKeySettings	The androidSettings.

getAndroidSettingsOrBuilder()

public AndroidKeySettingsOrBuilder getAndroidSettingsOrBuilder()

Settings for keys that can be used by Android apps.

.google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;

Returns

Type	Description
AndroidKeySettingsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

The timestamp corresponding to the creation of this Key.

.google.protobuf.Timestamp create_time = 7;

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The timestamp corresponding to the creation of this Key.

.google.protobuf.Timestamp create_time = 7;

Returns

Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Key getDefaultInstanceForType()

Returns

Type	Description
Key

getDisplayName()

public String getDisplayName()

Human-readable display name of this key. Modifiable by user.

string display_name = 2;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Human-readable display name of this key. Modifiable by user.

string display_name = 2;

Returns

Type	Description
ByteString	The bytes for displayName.

getIosSettings()

public IOSKeySettings getIosSettings()

Settings for keys that can be used by iOS apps.

.google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;

Returns

Type	Description
IOSKeySettings	The iosSettings.

getIosSettingsOrBuilder()

public IOSKeySettingsOrBuilder getIosSettingsOrBuilder()

Settings for keys that can be used by iOS apps.

.google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;

Returns

Type	Description
IOSKeySettingsOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">; Creating and managing labels</a>.

map<string, string> labels = 6;

Returns

Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">; Creating and managing labels</a>.

map<string, string> labels = 6;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">; Creating and managing labels</a>.

map<string, string> labels = 6;

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">; Creating and managing labels</a>.

map<string, string> labels = 6;

Parameter

Name	Description
key	String

Returns

Type	Description
String

getName()

public String getName()

The resource name for the Key in the format "projects/{project}/keys/{key}".

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name for the Key in the format "projects/{project}/keys/{key}".

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Key> getParserForType()

Returns

Type	Description
Parser<Key>

Overrides

GeneratedMessageV3.getParserForType()

getPlatformSettingsCase()

public Key.PlatformSettingsCase getPlatformSettingsCase()

Returns

Type	Description
Key.PlatformSettingsCase

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTestingOptions()

public TestingOptions getTestingOptions()

Options for user acceptance testing.

.google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9;

Returns

Type	Description
TestingOptions	The testingOptions.

getTestingOptionsOrBuilder()

public TestingOptionsOrBuilder getTestingOptionsOrBuilder()

Options for user acceptance testing.

.google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9;

Returns

Type	Description
TestingOptionsOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getWebSettings()

public WebKeySettings getWebSettings()

Settings for keys that can be used by websites.

.google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;

Returns

Type	Description
WebKeySettings	The webSettings.

getWebSettingsOrBuilder()

public WebKeySettingsOrBuilder getWebSettingsOrBuilder()

Settings for keys that can be used by websites.

.google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;

Returns

Type	Description
WebKeySettingsOrBuilder

hasAndroidSettings()

public boolean hasAndroidSettings()

Settings for keys that can be used by Android apps.

.google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;

Returns

Type	Description
boolean	Whether the androidSettings field is set.

hasCreateTime()

public boolean hasCreateTime()

The timestamp corresponding to the creation of this Key.

.google.protobuf.Timestamp create_time = 7;

Returns

Type	Description
boolean	Whether the createTime field is set.

hasIosSettings()

public boolean hasIosSettings()

Settings for keys that can be used by iOS apps.

.google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;

Returns

Type	Description
boolean	Whether the iosSettings field is set.

hasTestingOptions()

public boolean hasTestingOptions()

Options for user acceptance testing.

.google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9;

Returns

Type	Description
boolean	Whether the testingOptions field is set.

hasWebSettings()

public boolean hasWebSettings()

Settings for keys that can be used by websites.

.google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;

Returns

Type	Description
boolean	Whether the webSettings field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Key.Builder newBuilderForType()

Returns

Type	Description
Key.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Key.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Key.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Key.Builder toBuilder()

Returns

Type	Description
Key.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException