Class Tool.Authentication.ApiKeyConfig.Builder (4.87.0)

Version latest

• 4.87.0 (latest)
• 4.86.0
• 4.84.0
• 4.82.0
• 4.81.0
• 4.80.0
• 4.79.0
• 4.78.0
• 4.76.0
• 4.74.0
• 4.73.0
• 4.70.0
• 4.69.0
• 4.68.0
• 4.66.0
• 4.65.0
• 4.64.0
• 4.63.0
• 4.62.0
• 4.61.0
• 4.60.0
• 4.59.0
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public static final class Tool.Authentication.ApiKeyConfig.Builder extends GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder> implements Tool.Authentication.ApiKeyConfigOrBuilder

Config for authentication with API key.

Protobuf type google.cloud.dialogflow.v2beta1.Tool.Authentication.ApiKeyConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Tool.Authentication.ApiKeyConfig.Builder

Implements

Tool.Authentication.ApiKeyConfigOrBuilder

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 Tool.Authentication.ApiKeyConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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

build()

public Tool.Authentication.ApiKeyConfig build()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

buildPartial()

public Tool.Authentication.ApiKeyConfig buildPartial()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

clear()

public Tool.Authentication.ApiKeyConfig.Builder clear()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearApiKey()

public Tool.Authentication.ApiKeyConfig.Builder clearApiKey()

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

string api_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Tool.Authentication.ApiKeyConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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

clearKeyName()

public Tool.Authentication.ApiKeyConfig.Builder clearKeyName()

Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=<API KEY>", "X-Api-Key" would be the parameter name.

string key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Tool.Authentication.ApiKeyConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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

clearRequestLocation()

public Tool.Authentication.ApiKeyConfig.Builder clearRequestLocation()

Required. Key location in the request.

.google.cloud.dialogflow.v2beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

clearSecretVersionForApiKey()

public Tool.Authentication.ApiKeyConfig.Builder clearSecretVersionForApiKey()

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}

string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

clone()

public Tool.Authentication.ApiKeyConfig.Builder clone()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getApiKey()

public String getApiKey()

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

string api_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The apiKey.

getApiKeyBytes()

public ByteString getApiKeyBytes()

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

string api_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for apiKey.

getDefaultInstanceForType()

public Tool.Authentication.ApiKeyConfig getDefaultInstanceForType()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getKeyName()

public String getKeyName()

Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=<API KEY>", "X-Api-Key" would be the parameter name.

string key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The keyName.

getKeyNameBytes()

public ByteString getKeyNameBytes()

Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=<API KEY>", "X-Api-Key" would be the parameter name.

string key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for keyName.

getRequestLocation()

public Tool.Authentication.RequestLocation getRequestLocation()

Required. Key location in the request.

.google.cloud.dialogflow.v2beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Tool.Authentication.RequestLocation	The requestLocation.

getRequestLocationValue()

public int getRequestLocationValue()

Required. Key location in the request.

.google.cloud.dialogflow.v2beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

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

getSecretVersionForApiKey()

public String getSecretVersionForApiKey()

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}

string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The secretVersionForApiKey.

getSecretVersionForApiKeyBytes()

public ByteString getSecretVersionForApiKeyBytes()

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}

string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for secretVersionForApiKey.

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()

mergeFrom(Tool.Authentication.ApiKeyConfig other)

public Tool.Authentication.ApiKeyConfig.Builder mergeFrom(Tool.Authentication.ApiKeyConfig other)

Parameter
Name	Description
other	Tool.Authentication.ApiKeyConfig

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Tool.Authentication.ApiKeyConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Tool.Authentication.ApiKeyConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Tool.Authentication.ApiKeyConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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

setApiKey(String value)

public Tool.Authentication.ApiKeyConfig.Builder setApiKey(String value)

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

string api_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The apiKey to set.

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

setApiKeyBytes(ByteString value)

public Tool.Authentication.ApiKeyConfig.Builder setApiKeyBytes(ByteString value)

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

string api_key = 2 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Tool.Authentication.ApiKeyConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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

setKeyName(String value)

public Tool.Authentication.ApiKeyConfig.Builder setKeyName(String value)

Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=<API KEY>", "X-Api-Key" would be the parameter name.

string key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The keyName to set.

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

setKeyNameBytes(ByteString value)

public Tool.Authentication.ApiKeyConfig.Builder setKeyNameBytes(ByteString value)

Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=<API KEY>", "X-Api-Key" would be the parameter name.

string key_name = 1 [(.google.api.field_behavior) = REQUIRED];

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

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

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

public Tool.Authentication.ApiKeyConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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

setRequestLocation(Tool.Authentication.RequestLocation value)

public Tool.Authentication.ApiKeyConfig.Builder setRequestLocation(Tool.Authentication.RequestLocation value)

Required. Key location in the request.

.google.cloud.dialogflow.v2beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Tool.Authentication.RequestLocation The requestLocation to set.

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

setRequestLocationValue(int value)

public Tool.Authentication.ApiKeyConfig.Builder setRequestLocationValue(int value)

Required. Key location in the request.

.google.cloud.dialogflow.v2beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

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

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

setSecretVersionForApiKey(String value)

public Tool.Authentication.ApiKeyConfig.Builder setSecretVersionForApiKey(String value)

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}

string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The secretVersionForApiKey to set.

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

setSecretVersionForApiKeyBytes(ByteString value)

public Tool.Authentication.ApiKeyConfig.Builder setSecretVersionForApiKeyBytes(ByteString value)

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}

string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

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

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Tool.Authentication.ApiKeyConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

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