com.google.recaptchaenterprise.v1

Class Key

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.recaptchaenterprise.v1.Key

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, KeyOrBuilder, Serializable

public final class Key
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Key.Builder A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
static class	Key.PlatformSettingsCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANDROID_SETTINGS_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	IOS_SETTINGS_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	WEB_SETTINGS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
boolean	equals(Object obj)
AndroidKeySettings	getAndroidSettings() Settings for keys that can be used by Android apps.
AndroidKeySettingsOrBuilder	getAndroidSettingsOrBuilder() Settings for keys that can be used by Android apps.
com.google.protobuf.Timestamp	getCreateTime() The timestamp corresponding to the creation of this Key.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The timestamp corresponding to the creation of this Key.
static Key	getDefaultInstance()
Key	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Human-readable display name of this key.
com.google.protobuf.ByteString	getDisplayNameBytes() Human-readable display name of this key.
IOSKeySettings	getIosSettings() Settings for keys that can be used by iOS apps.
IOSKeySettingsOrBuilder	getIosSettingsOrBuilder() Settings for keys that can be used by iOS apps.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() The resource name for the Key in the format "projects/{project}/keys/{key}".
com.google.protobuf.ByteString	getNameBytes() The resource name for the Key in the format "projects/{project}/keys/{key}".
com.google.protobuf.Parser<Key>	getParserForType()
Key.PlatformSettingsCase	getPlatformSettingsCase()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
WebKeySettings	getWebSettings() Settings for keys that can be used by websites.
WebKeySettingsOrBuilder	getWebSettingsOrBuilder() Settings for keys that can be used by websites.
boolean	hasAndroidSettings() Settings for keys that can be used by Android apps.
boolean	hasCreateTime() The timestamp corresponding to the creation of this Key.
int	hashCode()
boolean	hasIosSettings() Settings for keys that can be used by iOS apps.
boolean	hasWebSettings() Settings for keys that can be used by websites.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Key.Builder	newBuilder()
static Key.Builder	newBuilder(Key prototype)
Key.Builder	newBuilderForType()
protected Key.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Key	parseDelimitedFrom(InputStream input)
static Key	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Key	parseFrom(byte[] data)
static Key	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Key	parseFrom(ByteBuffer data)
static Key	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Key	parseFrom(com.google.protobuf.ByteString data)
static Key	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Key	parseFrom(com.google.protobuf.CodedInputStream input)
static Key	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Key	parseFrom(InputStream input)
static Key	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Key>	parser()
Key.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

WEB_SETTINGS_FIELD_NUMBER

public static final int WEB_SETTINGS_FIELD_NUMBER

See Also:

Constant Field Values

ANDROID_SETTINGS_FIELD_NUMBER

public static final int ANDROID_SETTINGS_FIELD_NUMBER

See Also:

Constant Field Values

IOS_SETTINGS_FIELD_NUMBER

public static final int IOS_SETTINGS_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPlatformSettingsCase

public Key.PlatformSettingsCase getPlatformSettingsCase()

Specified by:

getPlatformSettingsCase in interface KeyOrBuilder

getName

public String getName()

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

string name = 1;

Specified by:

getName in interface KeyOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

string name = 1;

Specified by:

getNameBytes in interface KeyOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

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

string display_name = 2;

Specified by:

getDisplayName in interface KeyOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

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

string display_name = 2;

Specified by:

getDisplayNameBytes in interface KeyOrBuilder

Returns:

The bytes for displayName.

hasWebSettings

public boolean hasWebSettings()

 Settings for keys that can be used by websites.
 

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

Specified by:

hasWebSettings in interface KeyOrBuilder

Returns:

Whether the webSettings field is set.

getWebSettings

public WebKeySettings getWebSettings()

 Settings for keys that can be used by websites.
 

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

Specified by:

getWebSettings in interface KeyOrBuilder

Returns:

The webSettings.

getWebSettingsOrBuilder

public WebKeySettingsOrBuilder getWebSettingsOrBuilder()

 Settings for keys that can be used by websites.
 

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

Specified by:

getWebSettingsOrBuilder in interface KeyOrBuilder

hasAndroidSettings

public boolean hasAndroidSettings()

 Settings for keys that can be used by Android apps.
 

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

Specified by:

hasAndroidSettings in interface KeyOrBuilder

Returns:

Whether the androidSettings field is set.

getAndroidSettings

public AndroidKeySettings getAndroidSettings()

 Settings for keys that can be used by Android apps.
 

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

Specified by:

getAndroidSettings in interface KeyOrBuilder

Returns:

The androidSettings.

getAndroidSettingsOrBuilder

public AndroidKeySettingsOrBuilder getAndroidSettingsOrBuilder()

 Settings for keys that can be used by Android apps.
 

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

Specified by:

getAndroidSettingsOrBuilder in interface KeyOrBuilder

hasIosSettings

public boolean hasIosSettings()

 Settings for keys that can be used by iOS apps.
 

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

Specified by:

hasIosSettings in interface KeyOrBuilder

Returns:

Whether the iosSettings field is set.

getIosSettings

public IOSKeySettings getIosSettings()

 Settings for keys that can be used by iOS apps.
 

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

Specified by:

getIosSettings in interface KeyOrBuilder

Returns:

The iosSettings.

getIosSettingsOrBuilder

public IOSKeySettingsOrBuilder getIosSettingsOrBuilder()

 Settings for keys that can be used by iOS apps.
 

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

Specified by:

getIosSettingsOrBuilder in interface KeyOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: KeyOrBuilder

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

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLabelsCount in interface KeyOrBuilder

containsLabels

public boolean containsLabels(String key)

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

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

containsLabels in interface KeyOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface KeyOrBuilder

getLabelsMap

public Map<String,String> getLabelsMap()

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

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLabelsMap in interface KeyOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

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

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLabelsOrDefault in interface KeyOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

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

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLabelsOrThrow in interface KeyOrBuilder

hasCreateTime

public boolean hasCreateTime()

 The timestamp corresponding to the creation of this Key.
 

.google.protobuf.Timestamp create_time = 7;

Specified by:

hasCreateTime in interface KeyOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 The timestamp corresponding to the creation of this Key.
 

.google.protobuf.Timestamp create_time = 7;

Specified by:

getCreateTime in interface KeyOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The timestamp corresponding to the creation of this Key.
 

.google.protobuf.Timestamp create_time = 7;

Specified by:

getCreateTimeOrBuilder in interface KeyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Key parseFrom(ByteBuffer data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Key parseFrom(ByteBuffer data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Key parseFrom(com.google.protobuf.ByteString data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Key parseFrom(com.google.protobuf.ByteString data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Key parseFrom(byte[] data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Key parseFrom(byte[] data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Key parseFrom(InputStream input)
                     throws IOException

Throws:

IOException

parseFrom

public static Key parseFrom(InputStream input,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Key parseDelimitedFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Key parseDelimitedFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseFrom

public static Key parseFrom(com.google.protobuf.CodedInputStream input)
                     throws IOException

Throws:

IOException

parseFrom

public static Key parseFrom(com.google.protobuf.CodedInputStream input,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws IOException

Throws:

IOException

newBuilderForType

public Key.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Key.Builder newBuilder()

newBuilder

public static Key.Builder newBuilder(Key prototype)

toBuilder

public Key.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Key.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Key getDefaultInstance()

parser

public static com.google.protobuf.Parser<Key> parser()

getParserForType

public com.google.protobuf.Parser<Key> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Key getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder