Class Key.Builder (2.3.1)

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.v1beta1.Key

Inheritance

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

Implements

KeyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAndroidSettings()

public Key.Builder clearAndroidSettings()

Settings for keys that can be used by Android apps.

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

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIosSettings()

public Key.Builder clearIosSettings()

Settings for keys that can be used by iOS apps.

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

Returns

Type	Description
Key.Builder

clearName()

public Key.Builder clearName()

The resource name for the Key in the format "projects/{project_number}/keys/{key_id}".

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPlatformSettings()

public Key.Builder clearPlatformSettings()

Returns

Type	Description
Key.Builder

clearWebSettings()

public Key.Builder clearWebSettings()

Settings for keys that can be used by websites.

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

Returns

Type	Description
Key.Builder

clone()

public Key.Builder clone()

Returns

Type	Description
Key.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAndroidSettings()

public AndroidKeySettings getAndroidSettings()

Settings for keys that can be used by Android apps.

.google.cloud.recaptchaenterprise.v1beta1.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.v1beta1.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.v1beta1.AndroidKeySettings android_settings = 4;

Returns

Type	Description
AndroidKeySettingsOrBuilder

getDefaultInstanceForType()

public Key getDefaultInstanceForType()

Returns

Type	Description
Key

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.v1beta1.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.v1beta1.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.v1beta1.IOSKeySettings ios_settings = 5;

Returns

Type	Description
IOSKeySettingsOrBuilder

getName()

public String getName()

The resource name for the Key in the format "projects/{project_number}/keys/{key_id}".

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name for the Key in the format "projects/{project_number}/keys/{key_id}".

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getPlatformSettingsCase()

public Key.PlatformSettingsCase getPlatformSettingsCase()

Returns

Type	Description
Key.PlatformSettingsCase

getWebSettings()

public WebKeySettings getWebSettings()

Settings for keys that can be used by websites.

.google.cloud.recaptchaenterprise.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.AndroidKeySettings android_settings = 4;

Returns

Type	Description
boolean	Whether the androidSettings field is set.

hasIosSettings()

public boolean hasIosSettings()

Settings for keys that can be used by iOS apps.

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

Returns

Type	Description
boolean	Whether the iosSettings field is set.

hasWebSettings()

public boolean hasWebSettings()

Settings for keys that can be used by websites.

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

Returns

Type	Description
boolean	Whether the webSettings field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAndroidSettings(AndroidKeySettings value)

public Key.Builder mergeAndroidSettings(AndroidKeySettings value)

Settings for keys that can be used by Android apps.

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

Parameter

Name	Description
value	`AndroidKeySettings`

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Key.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
Key.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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.v1beta1.IOSKeySettings ios_settings = 5;

Parameter

Name	Description
value	`IOSKeySettings`

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeWebSettings(WebKeySettings value)

public Key.Builder mergeWebSettings(WebKeySettings value)

Settings for keys that can be used by websites.

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

Parameter

Name	Description
value	`WebKeySettings`

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.v1beta1.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.v1beta1.AndroidKeySettings android_settings = 4;

Parameter

Name	Description
builderForValue	`AndroidKeySettings.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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIosSettings(IOSKeySettings value)

public Key.Builder setIosSettings(IOSKeySettings value)

Settings for keys that can be used by iOS apps.

.google.cloud.recaptchaenterprise.v1beta1.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.v1beta1.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_number}/keys/{key_id}".

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_number}/keys/{key_id}".

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Key.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Key.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setWebSettings(WebKeySettings value)

public Key.Builder setWebSettings(WebKeySettings value)

Settings for keys that can be used by websites.

.google.cloud.recaptchaenterprise.v1beta1.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.v1beta1.WebKeySettings web_settings = 3;

Parameter

Name	Description
builderForValue	`WebKeySettings.Builder`

Returns

Type	Description
Key.Builder