Class Key.Builder (2.5.0) 

public static final class Key.Builder extends GeneratedMessageV3.Builder<Key.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Key.Builder

Implements

KeyOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Key.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Key.Builder
Overrides

build()

public Key build()
Returns
Type Description
Key

buildPartial()

public Key buildPartial()
Returns
Type Description
Key

clear()

public Key.Builder clear()
Returns
Type Description
Key.Builder
Overrides

clearAndroidSettings()

public Key.Builder clearAndroidSettings()

Settings for keys that can be used by Android apps.

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

Returns
Type Description
Key.Builder

clearCreateTime()

public Key.Builder clearCreateTime()

The timestamp corresponding to the creation of this Key.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Key.Builder

clearDisplayName()

public Key.Builder clearDisplayName()

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

string display_name = 2;

Returns
Type Description
Key.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Key.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Key.Builder
Overrides

clearIosSettings()

public Key.Builder clearIosSettings()

Settings for keys that can be used by iOS apps.

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

Returns
Type Description
Key.Builder

clearLabels()

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

clearName()

public Key.Builder clearName()

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

string name = 1;

Returns
Type Description
Key.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Key.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Key.Builder
Overrides

clearPlatformSettings()

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

clearTestingOptions()

public Key.Builder clearTestingOptions()

Options for user acceptance testing.

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

Returns
Type Description
Key.Builder

clearWebSettings()

public Key.Builder clearWebSettings()

Settings for keys that can be used by websites.

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

Returns
Type Description
Key.Builder

clone()

public Key.Builder clone()
Returns
Type Description
Key.Builder
Overrides

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

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.

getAndroidSettingsBuilder()

public AndroidKeySettings.Builder getAndroidSettingsBuilder()

Settings for keys that can be used by Android apps.

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

Returns
Type Description
AndroidKeySettings.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The timestamp corresponding to the creation of this Key.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getIosSettingsBuilder()

public IOSKeySettings.Builder getIosSettingsBuilder()

Settings for keys that can be used by iOS apps.

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

Returns
Type Description
IOSKeySettings.Builder

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

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,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.

getPlatformSettingsCase()

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

getTestingOptions()

public TestingOptions getTestingOptions()

Options for user acceptance testing.

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

Returns
Type Description
TestingOptions

The testingOptions.

getTestingOptionsBuilder()

public TestingOptions.Builder getTestingOptionsBuilder()

Options for user acceptance testing.

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

Returns
Type Description
TestingOptions.Builder

getTestingOptionsOrBuilder()

public TestingOptionsOrBuilder getTestingOptionsOrBuilder()

Options for user acceptance testing.

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

Returns
Type Description
TestingOptionsOrBuilder

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.

getWebSettingsBuilder()

public WebKeySettings.Builder getWebSettingsBuilder()

Settings for keys that can be used by websites.

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

Returns
Type Description
WebKeySettings.Builder

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.

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAndroidSettings(AndroidKeySettings value)

public Key.Builder mergeAndroidSettings(AndroidKeySettings value)

Settings for keys that can be used by Android apps.

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

Parameter
Name Description
value AndroidKeySettings
Returns
Type Description
Key.Builder

mergeCreateTime(Timestamp value)

public Key.Builder mergeCreateTime(Timestamp value)

The timestamp corresponding to the creation of this Key.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
value Timestamp
Returns
Type Description
Key.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Key.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Key.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public Key.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Key.Builder
Overrides

mergeFrom(Key other)

public Key.Builder mergeFrom(Key other)
Parameter
Name Description
other Key
Returns
Type Description
Key.Builder

mergeIosSettings(IOSKeySettings value)

public Key.Builder mergeIosSettings(IOSKeySettings value)

Settings for keys that can be used by iOS apps.

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

Parameter
Name Description
value IOSKeySettings
Returns
Type Description
Key.Builder

mergeTestingOptions(TestingOptions value)

public Key.Builder mergeTestingOptions(TestingOptions value)

Options for user acceptance testing.

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

Parameter
Name Description
value TestingOptions
Returns
Type Description
Key.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Key.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Key.Builder
Overrides

mergeWebSettings(WebKeySettings value)

public Key.Builder mergeWebSettings(WebKeySettings value)

Settings for keys that can be used by websites.

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

Parameter
Name Description
value WebKeySettings
Returns
Type Description
Key.Builder

putAllLabels(Map<String,String> values)

public Key.Builder putAllLabels(Map<String,String> values)

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

map<string, string> labels = 6;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Key.Builder

putLabels(String key, String value)

public Key.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
Key.Builder

removeLabels(String key)

public Key.Builder removeLabels(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
Key.Builder

setAndroidSettings(AndroidKeySettings value)

public Key.Builder setAndroidSettings(AndroidKeySettings value)

Settings for keys that can be used by Android apps.

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

Parameter
Name Description
value AndroidKeySettings
Returns
Type Description
Key.Builder

setAndroidSettings(AndroidKeySettings.Builder builderForValue)

public Key.Builder setAndroidSettings(AndroidKeySettings.Builder builderForValue)

Settings for keys that can be used by Android apps.

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

Parameter
Name Description
builderForValue AndroidKeySettings.Builder
Returns
Type Description
Key.Builder

setCreateTime(Timestamp value)

public Key.Builder setCreateTime(Timestamp value)

The timestamp corresponding to the creation of this Key.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
value Timestamp
Returns
Type Description
Key.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Key.Builder setCreateTime(Timestamp.Builder builderForValue)

The timestamp corresponding to the creation of this Key.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Key.Builder

setDisplayName(String value)

public Key.Builder setDisplayName(String value)

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

string display_name = 2;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Key.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Key.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Key.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Key.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Key.Builder
Overrides

setIosSettings(IOSKeySettings value)

public Key.Builder setIosSettings(IOSKeySettings value)

Settings for keys that can be used by iOS apps.

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

Parameter
Name Description
value IOSKeySettings
Returns
Type Description
Key.Builder

setIosSettings(IOSKeySettings.Builder builderForValue)

public Key.Builder setIosSettings(IOSKeySettings.Builder builderForValue)

Settings for keys that can be used by iOS apps.

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

Parameter
Name Description
builderForValue IOSKeySettings.Builder
Returns
Type Description
Key.Builder

setName(String value)

public Key.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Key.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Key.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Key.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Key.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Key.Builder
Overrides

setTestingOptions(TestingOptions value)

public Key.Builder setTestingOptions(TestingOptions value)

Options for user acceptance testing.

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

Parameter
Name Description
value TestingOptions
Returns
Type Description
Key.Builder

setTestingOptions(TestingOptions.Builder builderForValue)

public Key.Builder setTestingOptions(TestingOptions.Builder builderForValue)

Options for user acceptance testing.

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

Parameter
Name Description
builderForValue TestingOptions.Builder
Returns
Type Description
Key.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Key.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Key.Builder
Overrides

setWebSettings(WebKeySettings value)

public Key.Builder setWebSettings(WebKeySettings value)

Settings for keys that can be used by websites.

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

Parameter
Name Description
value WebKeySettings
Returns
Type Description
Key.Builder

setWebSettings(WebKeySettings.Builder builderForValue)

public Key.Builder setWebSettings(WebKeySettings.Builder builderForValue)

Settings for keys that can be used by websites.

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

Parameter
Name Description
builderForValue WebKeySettings.Builder
Returns
Type Description
Key.Builder