Class Tool.Authentication.ApiKeyConfig (0.64.0)

Version latest

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

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

Config for authentication with API key.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Tool.Authentication.ApiKeyConfig

Inheritance

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

Implements

Tool.Authentication.ApiKeyConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

API_KEY_FIELD_NUMBER

public static final int API_KEY_FIELD_NUMBER

Field Value
Type	Description
int

KEY_NAME_FIELD_NUMBER

public static final int KEY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

REQUEST_LOCATION_FIELD_NUMBER

public static final int REQUEST_LOCATION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Tool.Authentication.ApiKeyConfig getDefaultInstance()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Tool.Authentication.ApiKeyConfig.Builder newBuilder()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

newBuilder(Tool.Authentication.ApiKeyConfig prototype)

public static Tool.Authentication.ApiKeyConfig.Builder newBuilder(Tool.Authentication.ApiKeyConfig prototype)

Parameter
Name	Description
prototype	Tool.Authentication.ApiKeyConfig

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

parseDelimitedFrom(InputStream input)

public static Tool.Authentication.ApiKeyConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool.Authentication.ApiKeyConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Tool.Authentication.ApiKeyConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Tool.Authentication.ApiKeyConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Tool.Authentication.ApiKeyConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Tool.Authentication.ApiKeyConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Tool.Authentication.ApiKeyConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool.Authentication.ApiKeyConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Tool.Authentication.ApiKeyConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool.Authentication.ApiKeyConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Tool.Authentication.ApiKeyConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Tool.Authentication.ApiKeyConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Tool.Authentication.ApiKeyConfig> parser()

Returns
Type	Description
Parser<ApiKeyConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getApiKey()

public String getApiKey()

Required. The API key.

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

Returns
Type	Description
String	The apiKey.

getApiKeyBytes()

public ByteString getApiKeyBytes()

Required. The API key.

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

Returns
Type	Description
ByteString	The bytes for apiKey.

getDefaultInstanceForType()

public Tool.Authentication.ApiKeyConfig getDefaultInstanceForType()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig

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.

getParserForType()

public Parser<Tool.Authentication.ApiKeyConfig> getParserForType()

Returns
Type	Description
Parser<ApiKeyConfig>

Overrides

GeneratedMessageV3.getParserForType()

getRequestLocation()

public Tool.Authentication.RequestLocation getRequestLocation()

Required. Key location in the request.

.google.cloud.dialogflow.cx.v3beta1.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.cx.v3beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Tool.Authentication.ApiKeyConfig.Builder newBuilderForType()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Tool.Authentication.ApiKeyConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Tool.Authentication.ApiKeyConfig.Builder toBuilder()

Returns
Type	Description
Tool.Authentication.ApiKeyConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException