Class Key (3.33.0) 

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

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

WAF_SETTINGS_FIELD_NUMBER

public static final int WAF_SETTINGS_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)

Optional. See Creating and managing labels.

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

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

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()

Output only. The timestamp corresponding to the creation of this key.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp corresponding to the creation of this key.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Key getDefaultInstanceForType()
Returns
Type Description
Key

getDisplayName()

public String getDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

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() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. See Creating and managing labels.

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

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. See Creating and managing labels.

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. See Creating and managing labels.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. See Creating and managing labels.

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

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPlatformSettingsCase()

public Key.PlatformSettingsCase getPlatformSettingsCase()
Returns
Type Description
Key.PlatformSettingsCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTestingOptions()

public TestingOptions getTestingOptions()

Optional. Options for user acceptance testing.

.google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TestingOptions

The testingOptions.

getTestingOptionsOrBuilder()

public TestingOptionsOrBuilder getTestingOptionsOrBuilder()

Optional. Options for user acceptance testing.

.google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TestingOptionsOrBuilder

getWafSettings()

public WafSettings getWafSettings()

Optional. Settings for WAF

.google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WafSettings

The wafSettings.

getWafSettingsOrBuilder()

public WafSettingsOrBuilder getWafSettingsOrBuilder()

Optional. Settings for WAF

.google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WafSettingsOrBuilder

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()

Output only. The timestamp corresponding to the creation of this key.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

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()

Optional. Options for user acceptance testing.

.google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the testingOptions field is set.

hasWafSettings()

public boolean hasWafSettings()

Optional. Settings for WAF

.google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the wafSettings 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

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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