Class TokenProperties.Builder (3.27.0)

public static final class TokenProperties.Builder extends GeneratedMessageV3.Builder<TokenProperties.Builder> implements TokenPropertiesOrBuilder

Properties of the provided event token.

Protobuf type google.cloud.recaptchaenterprise.v1.TokenProperties

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TokenProperties.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TokenProperties.Builder
Overrides

build()

public TokenProperties build()
Returns
TypeDescription
TokenProperties

buildPartial()

public TokenProperties buildPartial()
Returns
TypeDescription
TokenProperties

clear()

public TokenProperties.Builder clear()
Returns
TypeDescription
TokenProperties.Builder
Overrides

clearAction()

public TokenProperties.Builder clearAction()

Action name provided at token generation.

string action = 5;

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

clearAndroidPackageName()

public TokenProperties.Builder clearAndroidPackageName()

The name of the Android package with which the token was generated (Android keys only).

string android_package_name = 8;

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

clearCreateTime()

public TokenProperties.Builder clearCreateTime()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TokenProperties.Builder

clearField(Descriptors.FieldDescriptor field)

public TokenProperties.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TokenProperties.Builder
Overrides

clearHostname()

public TokenProperties.Builder clearHostname()

The hostname of the page on which the token was generated (Web keys only).

string hostname = 4;

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

clearInvalidReason()

public TokenProperties.Builder clearInvalidReason()

Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

clearIosBundleId()

public TokenProperties.Builder clearIosBundleId()

The ID of the iOS bundle with which the token was generated (iOS keys only).

string ios_bundle_id = 9;

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TokenProperties.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TokenProperties.Builder
Overrides

clearValid()

public TokenProperties.Builder clearValid()

Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).

bool valid = 1;

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

clone()

public TokenProperties.Builder clone()
Returns
TypeDescription
TokenProperties.Builder
Overrides

getAction()

public String getAction()

Action name provided at token generation.

string action = 5;

Returns
TypeDescription
String

The action.

getActionBytes()

public ByteString getActionBytes()

Action name provided at token generation.

string action = 5;

Returns
TypeDescription
ByteString

The bytes for action.

getAndroidPackageName()

public String getAndroidPackageName()

The name of the Android package with which the token was generated (Android keys only).

string android_package_name = 8;

Returns
TypeDescription
String

The androidPackageName.

getAndroidPackageNameBytes()

public ByteString getAndroidPackageNameBytes()

The name of the Android package with which the token was generated (Android keys only).

string android_package_name = 8;

Returns
TypeDescription
ByteString

The bytes for androidPackageName.

getCreateTime()

public Timestamp getCreateTime()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public TokenProperties getDefaultInstanceForType()
Returns
TypeDescription
TokenProperties

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHostname()

public String getHostname()

The hostname of the page on which the token was generated (Web keys only).

string hostname = 4;

Returns
TypeDescription
String

The hostname.

getHostnameBytes()

public ByteString getHostnameBytes()

The hostname of the page on which the token was generated (Web keys only).

string hostname = 4;

Returns
TypeDescription
ByteString

The bytes for hostname.

getInvalidReason()

public TokenProperties.InvalidReason getInvalidReason()

Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;

Returns
TypeDescription
TokenProperties.InvalidReason

The invalidReason.

getInvalidReasonValue()

public int getInvalidReasonValue()

Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for invalidReason.

getIosBundleId()

public String getIosBundleId()

The ID of the iOS bundle with which the token was generated (iOS keys only).

string ios_bundle_id = 9;

Returns
TypeDescription
String

The iosBundleId.

getIosBundleIdBytes()

public ByteString getIosBundleIdBytes()

The ID of the iOS bundle with which the token was generated (iOS keys only).

string ios_bundle_id = 9;

Returns
TypeDescription
ByteString

The bytes for iosBundleId.

getValid()

public boolean getValid()

Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).

bool valid = 1;

Returns
TypeDescription
boolean

The valid.

hasCreateTime()

public boolean hasCreateTime()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
boolean

Whether the createTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public TokenProperties.Builder mergeCreateTime(Timestamp value)

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
TokenProperties.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TokenProperties.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TokenProperties.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TokenProperties.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TokenProperties.Builder
Overrides

mergeFrom(TokenProperties other)

public TokenProperties.Builder mergeFrom(TokenProperties other)
Parameter
NameDescription
otherTokenProperties
Returns
TypeDescription
TokenProperties.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TokenProperties.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TokenProperties.Builder
Overrides

setAction(String value)

public TokenProperties.Builder setAction(String value)

Action name provided at token generation.

string action = 5;

Parameter
NameDescription
valueString

The action to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setActionBytes(ByteString value)

public TokenProperties.Builder setActionBytes(ByteString value)

Action name provided at token generation.

string action = 5;

Parameter
NameDescription
valueByteString

The bytes for action to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setAndroidPackageName(String value)

public TokenProperties.Builder setAndroidPackageName(String value)

The name of the Android package with which the token was generated (Android keys only).

string android_package_name = 8;

Parameter
NameDescription
valueString

The androidPackageName to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setAndroidPackageNameBytes(ByteString value)

public TokenProperties.Builder setAndroidPackageNameBytes(ByteString value)

The name of the Android package with which the token was generated (Android keys only).

string android_package_name = 8;

Parameter
NameDescription
valueByteString

The bytes for androidPackageName to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public TokenProperties.Builder setCreateTime(Timestamp value)

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
TokenProperties.Builder

setCreateTime(Timestamp.Builder builderForValue)

public TokenProperties.Builder setCreateTime(Timestamp.Builder builderForValue)

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
TokenProperties.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TokenProperties.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TokenProperties.Builder
Overrides

setHostname(String value)

public TokenProperties.Builder setHostname(String value)

The hostname of the page on which the token was generated (Web keys only).

string hostname = 4;

Parameter
NameDescription
valueString

The hostname to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setHostnameBytes(ByteString value)

public TokenProperties.Builder setHostnameBytes(ByteString value)

The hostname of the page on which the token was generated (Web keys only).

string hostname = 4;

Parameter
NameDescription
valueByteString

The bytes for hostname to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setInvalidReason(TokenProperties.InvalidReason value)

public TokenProperties.Builder setInvalidReason(TokenProperties.InvalidReason value)

Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;

Parameter
NameDescription
valueTokenProperties.InvalidReason

The invalidReason to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setInvalidReasonValue(int value)

public TokenProperties.Builder setInvalidReasonValue(int value)

Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;

Parameter
NameDescription
valueint

The enum numeric value on the wire for invalidReason to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setIosBundleId(String value)

public TokenProperties.Builder setIosBundleId(String value)

The ID of the iOS bundle with which the token was generated (iOS keys only).

string ios_bundle_id = 9;

Parameter
NameDescription
valueString

The iosBundleId to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setIosBundleIdBytes(ByteString value)

public TokenProperties.Builder setIosBundleIdBytes(ByteString value)

The ID of the iOS bundle with which the token was generated (iOS keys only).

string ios_bundle_id = 9;

Parameter
NameDescription
valueByteString

The bytes for iosBundleId to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TokenProperties.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TokenProperties.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TokenProperties.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TokenProperties.Builder
Overrides

setValid(boolean value)

public TokenProperties.Builder setValid(boolean value)

Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).

bool valid = 1;

Parameter
NameDescription
valueboolean

The valid to set.

Returns
TypeDescription
TokenProperties.Builder

This builder for chaining.