Class TokenProperties.Builder (3.52.0)

Version latest

• 3.52.0 (latest)
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.12
• 2.6.1
• 2.5.0
• 2.4.10
• 2.3.1

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TokenProperties.Builder

Implements

TokenPropertiesOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TokenProperties.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public TokenProperties build()

Returns
Type	Description
TokenProperties

buildPartial()

public TokenProperties buildPartial()

Returns
Type	Description
TokenProperties

clear()

public TokenProperties.Builder clear()

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAction()

public TokenProperties.Builder clearAction()

Output only. Action name provided at token generation.

string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

clearAndroidPackageName()

public TokenProperties.Builder clearAndroidPackageName()

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

string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

clearCreateTime()

public TokenProperties.Builder clearCreateTime()

Output only. The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TokenProperties.Builder

clearField(Descriptors.FieldDescriptor field)

public TokenProperties.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHostname()

public TokenProperties.Builder clearHostname()

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

string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

clearInvalidReason()

public TokenProperties.Builder clearInvalidReason()

Output only. Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

clearIosBundleId()

public TokenProperties.Builder clearIosBundleId()

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

string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TokenProperties.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearValid()

public TokenProperties.Builder clearValid()

Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

clone()

public TokenProperties.Builder clone()

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAction()

public String getAction()

Output only. Action name provided at token generation.

string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The action.

getActionBytes()

public ByteString getActionBytes()

Output only. Action name provided at token generation.

string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for action.

getAndroidPackageName()

public String getAndroidPackageName()

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

string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The androidPackageName.

getAndroidPackageNameBytes()

public ByteString getAndroidPackageNameBytes()

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

string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for androidPackageName.

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public TokenProperties getDefaultInstanceForType()

Returns
Type	Description
TokenProperties

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getHostname()

public String getHostname()

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

string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The hostname.

getHostnameBytes()

public ByteString getHostnameBytes()

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

string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for hostname.

getInvalidReason()

public TokenProperties.InvalidReason getInvalidReason()

Output only. Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TokenProperties.InvalidReason	The invalidReason.

getInvalidReasonValue()

public int getInvalidReasonValue()

Output only. Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for invalidReason.

getIosBundleId()

public String getIosBundleId()

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

string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The iosBundleId.

getIosBundleIdBytes()

public ByteString getIosBundleIdBytes()

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

string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for iosBundleId.

getValid()

public boolean getValid()

Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The valid.

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public TokenProperties.Builder mergeCreateTime(Timestamp value)

Output only. The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
TokenProperties.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TokenProperties.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TokenProperties.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public TokenProperties.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
TokenProperties.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(TokenProperties other)

public TokenProperties.Builder mergeFrom(TokenProperties other)

Parameter
Name	Description
other	TokenProperties

Returns
Type	Description
TokenProperties.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TokenProperties.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAction(String value)

public TokenProperties.Builder setAction(String value)

Output only. Action name provided at token generation.

string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The action to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setActionBytes(ByteString value)

public TokenProperties.Builder setActionBytes(ByteString value)

Output only. Action name provided at token generation.

string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for action to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setAndroidPackageName(String value)

public TokenProperties.Builder setAndroidPackageName(String value)

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

string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The androidPackageName to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setAndroidPackageNameBytes(ByteString value)

public TokenProperties.Builder setAndroidPackageNameBytes(ByteString value)

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

string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for androidPackageName to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setCreateTime(Timestamp value)

public TokenProperties.Builder setCreateTime(Timestamp value)

Output only. The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
TokenProperties.Builder

setCreateTime(Timestamp.Builder builderForValue)

public TokenProperties.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
TokenProperties.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TokenProperties.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHostname(String value)

public TokenProperties.Builder setHostname(String value)

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

string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The hostname to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setHostnameBytes(ByteString value)

public TokenProperties.Builder setHostnameBytes(ByteString value)

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

string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for hostname to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setInvalidReason(TokenProperties.InvalidReason value)

public TokenProperties.Builder setInvalidReason(TokenProperties.InvalidReason value)

Output only. Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	TokenProperties.InvalidReason The invalidReason to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setInvalidReasonValue(int value)

public TokenProperties.Builder setInvalidReasonValue(int value)

Output only. Reason associated with the response when valid = false.

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	int The enum numeric value on the wire for invalidReason to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setIosBundleId(String value)

public TokenProperties.Builder setIosBundleId(String value)

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

string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The iosBundleId to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.

setIosBundleIdBytes(ByteString value)

public TokenProperties.Builder setIosBundleIdBytes(ByteString value)

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

string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for iosBundleId to set.

Returns
Type	Description
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
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final TokenProperties.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TokenProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setValid(boolean value)

public TokenProperties.Builder setValid(boolean value)

Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	boolean The valid to set.

Returns
Type	Description
TokenProperties.Builder	This builder for chaining.