public final class ProtectedEndpoint extends GeneratedMessage implements ProtectedEndpointOrBuilder
Configuration for an API endpoint to protect with reCAPTCHA.
Protobuf type google.cloud.recaptchaenterprise.v1.ProtectedEndpoint
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
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ProtectedEndpoint getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ProtectedEndpoint.Builder newBuilder()
newBuilder(ProtectedEndpoint prototype)
public static ProtectedEndpoint.Builder newBuilder(ProtectedEndpoint prototype)
public static ProtectedEndpoint parseDelimitedFrom(InputStream input)
public static ProtectedEndpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ProtectedEndpoint parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProtectedEndpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ProtectedEndpoint parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProtectedEndpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProtectedEndpoint parseFrom(CodedInputStream input)
public static ProtectedEndpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ProtectedEndpoint parseFrom(InputStream input)
public static ProtectedEndpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ProtectedEndpoint parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProtectedEndpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ProtectedEndpoint> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAction()
public String getAction()
Required. Action name to be used for token generation for this endpoint.
The action name can only contain alphanumeric characters, slashes, and
underscores.
string action = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The action.
|
getActionBytes()
public ByteString getActionBytes()
Required. Action name to be used for token generation for this endpoint.
The action name can only contain alphanumeric characters, slashes, and
underscores.
string action = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for action.
|
getDefaultInstanceForType()
public ProtectedEndpoint getDefaultInstanceForType()
getParserForType()
public Parser<ProtectedEndpoint> getParserForType()
Overrides
getPath()
Required. URI path of the API endpoint to protect. Must start with '/'.
Supports glob characters '' to match a single path segment and '' to
match multiple path segments. Standalone root catch-alls ('/*' and '/*')
are invalid because it can negatively impact performance to trigger
reCAPTCHA on every single request to your backend.
Matching is evaluated against the URL path only (domain, scheme, and query
parameters are ignored).
Examples:
/login matches /login, https://example.com/login, and
/login?query=1, but not /login/step1./products/* matches /products/123, but not /products/123/456./content/** matches /content/articles/2024/01/01.
string path = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The path.
|
getPathBytes()
public ByteString getPathBytes()
Required. URI path of the API endpoint to protect. Must start with '/'.
Supports glob characters '' to match a single path segment and '' to
match multiple path segments. Standalone root catch-alls ('/*' and '/*')
are invalid because it can negatively impact performance to trigger
reCAPTCHA on every single request to your backend.
Matching is evaluated against the URL path only (domain, scheme, and query
parameters are ignored).
Examples:
/login matches /login, https://example.com/login, and
/login?query=1, but not /login/step1./products/* matches /products/123, but not /products/123/456./content/** matches /content/articles/2024/01/01.
string path = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for path.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ProtectedEndpoint.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected ProtectedEndpoint.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public ProtectedEndpoint.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
