public final class ClientSettings extends GeneratedMessage implements ClientSettingsOrBuilder
Configuration for clients to protect with reCAPTCHA.
Protobuf type google.cloud.recaptchaenterprise.v1.ClientSettings
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
ALLOWED_DOMAINS_FIELD_NUMBER
public static final int ALLOWED_DOMAINS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ALLOW_ALL_DOMAINS_FIELD_NUMBER
public static final int ALLOW_ALL_DOMAINS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROTECTED_ENDPOINT_GROUP_FIELD_NUMBER
public static final int PROTECTED_ENDPOINT_GROUP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ClientSettings getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ClientSettings.Builder newBuilder()
newBuilder(ClientSettings prototype)
public static ClientSettings.Builder newBuilder(ClientSettings prototype)
public static ClientSettings parseDelimitedFrom(InputStream input)
public static ClientSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ClientSettings parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ClientSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ClientSettings parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ClientSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ClientSettings parseFrom(CodedInputStream input)
public static ClientSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ClientSettings parseFrom(InputStream input)
public static ClientSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ClientSettings parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ClientSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ClientSettings> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAllowAllDomains()
public boolean getAllowAllDomains()
Optional. If set to true, it means allowed_domains are not enforced.
bool allow_all_domains = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The allowAllDomains.
|
getAllowedDomains(int index)
public String getAllowedDomains(int index)
Optional. Domains or subdomains of websites allowed to use the policy. All
subdomains of an allowed domain are automatically allowed. A valid domain
requires a host and must not include any path, port, query or fragment.
Examples: 'example.com' or 'subdomain.example.com'
Each policy supports a maximum of 250 domains. To use a policy on more
domains, set allow_all_domains to true. When this is set, you are
responsible for validating the hostname by checking the
token_properties.hostname field in each assessment response against your
list of allowed domains.
repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The allowedDomains at the given index.
|
getAllowedDomainsBytes(int index)
public ByteString getAllowedDomainsBytes(int index)
Optional. Domains or subdomains of websites allowed to use the policy. All
subdomains of an allowed domain are automatically allowed. A valid domain
requires a host and must not include any path, port, query or fragment.
Examples: 'example.com' or 'subdomain.example.com'
Each policy supports a maximum of 250 domains. To use a policy on more
domains, set allow_all_domains to true. When this is set, you are
responsible for validating the hostname by checking the
token_properties.hostname field in each assessment response against your
list of allowed domains.
repeated string allowed_domains = 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 allowedDomains at the given index.
|
getAllowedDomainsCount()
public int getAllowedDomainsCount()
Optional. Domains or subdomains of websites allowed to use the policy. All
subdomains of an allowed domain are automatically allowed. A valid domain
requires a host and must not include any path, port, query or fragment.
Examples: 'example.com' or 'subdomain.example.com'
Each policy supports a maximum of 250 domains. To use a policy on more
domains, set allow_all_domains to true. When this is set, you are
responsible for validating the hostname by checking the
token_properties.hostname field in each assessment response against your
list of allowed domains.
repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of allowedDomains.
|
getAllowedDomainsList()
public ProtocolStringList getAllowedDomainsList()
Optional. Domains or subdomains of websites allowed to use the policy. All
subdomains of an allowed domain are automatically allowed. A valid domain
requires a host and must not include any path, port, query or fragment.
Examples: 'example.com' or 'subdomain.example.com'
Each policy supports a maximum of 250 domains. To use a policy on more
domains, set allow_all_domains to true. When this is set, you are
responsible for validating the hostname by checking the
token_properties.hostname field in each assessment response against your
list of allowed domains.
repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public ClientSettings getDefaultInstanceForType()
getParserForType()
public Parser<ClientSettings> getParserForType()
Overrides
getProtectedEndpointGroup()
public ProtectedEndpointGroup getProtectedEndpointGroup()
Optional. Configuration for all API endpoints to protect with reCAPTCHA. If
this field is not set, reCAPTCHA will not automatically request tokens on
any API endpoints.
.google.cloud.recaptchaenterprise.v1.ProtectedEndpointGroup protected_endpoint_group = 3 [(.google.api.field_behavior) = OPTIONAL];
getProtectedEndpointGroupOrBuilder()
public ProtectedEndpointGroupOrBuilder getProtectedEndpointGroupOrBuilder()
Optional. Configuration for all API endpoints to protect with reCAPTCHA. If
this field is not set, reCAPTCHA will not automatically request tokens on
any API endpoints.
.google.cloud.recaptchaenterprise.v1.ProtectedEndpointGroup protected_endpoint_group = 3 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasProtectedEndpointGroup()
public boolean hasProtectedEndpointGroup()
Optional. Configuration for all API endpoints to protect with reCAPTCHA. If
this field is not set, reCAPTCHA will not automatically request tokens on
any API endpoints.
.google.cloud.recaptchaenterprise.v1.ProtectedEndpointGroup protected_endpoint_group = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the protectedEndpointGroup field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ClientSettings.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected ClientSettings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public ClientSettings.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
