Constructor
new Key(propertiesopt)
Constructs a new Key.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.recaptchaenterprise.v1.IKey |
<optional> |
Properties to set |
- Implements:
-
- IKey
Members
androidSettings
Key androidSettings.
createTime
Key createTime.
displayName
Key displayName.
iosSettings
Key iosSettings.
labels
Key labels.
name
Key name.
platformSettings
Key platformSettings.
testingOptions
Key testingOptions.
wafSettings
Key wafSettings.
webSettings
Key webSettings.
Methods
toJSON() → {Object.<string, *>}
Converts this Key to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.recaptchaenterprise.v1.Key}
Creates a new Key instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.recaptchaenterprise.v1.IKey |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.recaptchaenterprise.v1.Key |
Key instance |
(static) decode(reader, lengthopt) → {google.cloud.recaptchaenterprise.v1.Key}
Decodes a Key message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.recaptchaenterprise.v1.Key |
Key |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.recaptchaenterprise.v1.Key}
Decodes a Key message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.recaptchaenterprise.v1.Key |
Key |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Key message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.recaptchaenterprise.v1.IKey |
Key message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Key message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.recaptchaenterprise.v1.IKey |
Key message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.recaptchaenterprise.v1.Key}
Creates a Key message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.recaptchaenterprise.v1.Key |
Key |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Key
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Key message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.recaptchaenterprise.v1.Key |
Key |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Key message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|