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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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 |
|
EXPRESS_SETTINGS_FIELD_NUMBER
public static final int EXPRESS_SETTINGS_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()
newBuilder()
public static Key.Builder newBuilder()
newBuilder(Key prototype)
public static Key.Builder newBuilder(Key prototype)
| Parameter |
| Name |
Description |
prototype |
Key
|
public static Key parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Key |
|
public static Key parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Key |
|
parseFrom(byte[] data)
public static Key parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Key |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Key |
|
parseFrom(ByteString data)
public static Key parseFrom(ByteString data)
| Returns |
| Type |
Description |
Key |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Key |
|
public static Key parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Key |
|
public static Key parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Key |
|
public static Key parseFrom(InputStream input)
| Returns |
| Type |
Description |
Key |
|
public static Key parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Key |
|
parseFrom(ByteBuffer data)
public static Key parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Key |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Key |
|
parser()
public static Parser<Key> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAndroidSettings()
public AndroidKeySettings getAndroidSettings()
Settings for keys that can be used by Android apps.
.google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;
getAndroidSettingsOrBuilder()
public AndroidKeySettingsOrBuilder getAndroidSettingsOrBuilder()
Settings for keys that can be used by Android apps.
.google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;
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];
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.
|
getExpressSettings()
public ExpressKeySettings getExpressSettings()
Settings specific to keys that can be used for reCAPTCHA Express.
.google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11;
getExpressSettingsOrBuilder()
public ExpressKeySettingsOrBuilder getExpressSettingsOrBuilder()
Settings specific to keys that can be used for reCAPTCHA Express.
.google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11;
getIosSettings()
public IOSKeySettings getIosSettings()
Settings for keys that can be used by iOS apps.
.google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;
getIosSettingsOrBuilder()
public IOSKeySettingsOrBuilder getIosSettingsOrBuilder()
Settings for keys that can be used by iOS apps.
.google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
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()
Overrides
public Key.PlatformSettingsCase getPlatformSettingsCase()
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];
getTestingOptionsOrBuilder()
public TestingOptionsOrBuilder getTestingOptionsOrBuilder()
Optional. Options for user acceptance testing.
.google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];
getWafSettings()
public WafSettings getWafSettings()
Optional. Settings for WAF
.google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];
getWafSettingsOrBuilder()
public WafSettingsOrBuilder getWafSettingsOrBuilder()
Optional. Settings for WAF
.google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];
getWebSettings()
public WebKeySettings getWebSettings()
Settings for keys that can be used by websites.
.google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;
getWebSettingsOrBuilder()
public WebKeySettingsOrBuilder getWebSettingsOrBuilder()
Settings for keys that can be used by websites.
.google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;
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.
|
hasExpressSettings()
public boolean hasExpressSettings()
Settings specific to keys that can be used for reCAPTCHA Express.
.google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11;
| Returns |
| Type |
Description |
boolean |
Whether the expressSettings 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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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()
Overrides
newBuilderForType()
public Key.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Key.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Key.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
