Class IOSKeySettings (3.79.0) 

public final class IOSKeySettings extends GeneratedMessageV3 implements IOSKeySettingsOrBuilder

Settings specific to keys that can be used by iOS apps.

Protobuf type google.cloud.recaptchaenterprise.v1.IOSKeySettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > IOSKeySettings

Static Fields

ALLOWED_BUNDLE_IDS_FIELD_NUMBER

public static final int ALLOWED_BUNDLE_IDS_FIELD_NUMBER
Field Value
Type Description
int

ALLOW_ALL_BUNDLE_IDS_FIELD_NUMBER

public static final int ALLOW_ALL_BUNDLE_IDS_FIELD_NUMBER
Field Value
Type Description
int

APPLE_DEVELOPER_ID_FIELD_NUMBER

public static final int APPLE_DEVELOPER_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IOSKeySettings getDefaultInstance()
Returns
Type Description
IOSKeySettings

getDescriptor()

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

newBuilder()

public static IOSKeySettings.Builder newBuilder()
Returns
Type Description
IOSKeySettings.Builder

newBuilder(IOSKeySettings prototype)

public static IOSKeySettings.Builder newBuilder(IOSKeySettings prototype)
Parameter
Name Description
prototype IOSKeySettings
Returns
Type Description
IOSKeySettings.Builder

parseDelimitedFrom(InputStream input)

public static IOSKeySettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IOSKeySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IOSKeySettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IOSKeySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IOSKeySettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IOSKeySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IOSKeySettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IOSKeySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IOSKeySettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IOSKeySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IOSKeySettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IOSKeySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IOSKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IOSKeySettings> parser()
Returns
Type Description
Parser<IOSKeySettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowAllBundleIds()

public boolean getAllowAllBundleIds()

Optional. If set to true, allowed_bundle_ids are not enforced.

bool allow_all_bundle_ids = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The allowAllBundleIds.

getAllowedBundleIds(int index)

public String getAllowedBundleIds(int index)

Optional. iOS bundle IDs of apps allowed to use the key. Example: 'com.companyname.productname.appname' Each key supports a maximum of 250 bundle IDs. To use a key on more apps, set allow_all_bundle_ids to true. When this is set, you are responsible for validating the bundle id by checking the token_properties.ios_bundle_id field in each assessment response against your list of allowed bundle IDs.

repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The allowedBundleIds at the given index.

getAllowedBundleIdsBytes(int index)

public ByteString getAllowedBundleIdsBytes(int index)

Optional. iOS bundle IDs of apps allowed to use the key. Example: 'com.companyname.productname.appname' Each key supports a maximum of 250 bundle IDs. To use a key on more apps, set allow_all_bundle_ids to true. When this is set, you are responsible for validating the bundle id by checking the token_properties.ios_bundle_id field in each assessment response against your list of allowed bundle IDs.

repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the allowedBundleIds at the given index.

getAllowedBundleIdsCount()

public int getAllowedBundleIdsCount()

Optional. iOS bundle IDs of apps allowed to use the key. Example: 'com.companyname.productname.appname' Each key supports a maximum of 250 bundle IDs. To use a key on more apps, set allow_all_bundle_ids to true. When this is set, you are responsible for validating the bundle id by checking the token_properties.ios_bundle_id field in each assessment response against your list of allowed bundle IDs.

repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of allowedBundleIds.

getAllowedBundleIdsList()

public ProtocolStringList getAllowedBundleIdsList()

Optional. iOS bundle IDs of apps allowed to use the key. Example: 'com.companyname.productname.appname' Each key supports a maximum of 250 bundle IDs. To use a key on more apps, set allow_all_bundle_ids to true. When this is set, you are responsible for validating the bundle id by checking the token_properties.ios_bundle_id field in each assessment response against your list of allowed bundle IDs.

repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the allowedBundleIds.

getAppleDeveloperId()

public AppleDeveloperId getAppleDeveloperId()

Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.

.google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AppleDeveloperId

The appleDeveloperId.

getAppleDeveloperIdOrBuilder()

public AppleDeveloperIdOrBuilder getAppleDeveloperIdOrBuilder()

Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.

.google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AppleDeveloperIdOrBuilder

getDefaultInstanceForType()

public IOSKeySettings getDefaultInstanceForType()
Returns
Type Description
IOSKeySettings

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAppleDeveloperId()

public boolean hasAppleDeveloperId()

Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.

.google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the appleDeveloperId field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IOSKeySettings.Builder newBuilderForType()
Returns
Type Description
IOSKeySettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IOSKeySettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IOSKeySettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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