com.google.cloud.dialogflow.cx.v3beta1

Class Tool.Authentication.ApiKeyConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.cx.v3beta1.Tool.Authentication.ApiKeyConfig

All Implemented Interfaces:

Tool.Authentication.ApiKeyConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Tool.Authentication

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

 Config for authentication with API key.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tool.Authentication.ApiKeyConfig.Builder Config for authentication with API key.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_KEY_FIELD_NUMBER
static int	KEY_NAME_FIELD_NUMBER
static int	REQUEST_LOCATION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApiKey() Optional.
com.google.protobuf.ByteString	getApiKeyBytes() Optional.
static Tool.Authentication.ApiKeyConfig	getDefaultInstance()
Tool.Authentication.ApiKeyConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getKeyName() Required.
com.google.protobuf.ByteString	getKeyNameBytes() Required.
com.google.protobuf.Parser<Tool.Authentication.ApiKeyConfig>	getParserForType()
Tool.Authentication.RequestLocation	getRequestLocation() Required.
int	getRequestLocationValue() Required.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Tool.Authentication.ApiKeyConfig.Builder	newBuilder()
static Tool.Authentication.ApiKeyConfig.Builder	newBuilder(Tool.Authentication.ApiKeyConfig prototype)
Tool.Authentication.ApiKeyConfig.Builder	newBuilderForType()
protected Tool.Authentication.ApiKeyConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Tool.Authentication.ApiKeyConfig	parseDelimitedFrom(InputStream input)
static Tool.Authentication.ApiKeyConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool.Authentication.ApiKeyConfig	parseFrom(byte[] data)
static Tool.Authentication.ApiKeyConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool.Authentication.ApiKeyConfig	parseFrom(ByteBuffer data)
static Tool.Authentication.ApiKeyConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool.Authentication.ApiKeyConfig	parseFrom(com.google.protobuf.ByteString data)
static Tool.Authentication.ApiKeyConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool.Authentication.ApiKeyConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Tool.Authentication.ApiKeyConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool.Authentication.ApiKeyConfig	parseFrom(InputStream input)
static Tool.Authentication.ApiKeyConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Tool.Authentication.ApiKeyConfig>	parser()
Tool.Authentication.ApiKeyConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

KEY_NAME_FIELD_NUMBER

public static final int KEY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

API_KEY_FIELD_NUMBER

public static final int API_KEY_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_LOCATION_FIELD_NUMBER

public static final int REQUEST_LOCATION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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];

Specified by:

getKeyName in interface Tool.Authentication.ApiKeyConfigOrBuilder

Returns:

The keyName.

getKeyNameBytes

public com.google.protobuf.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];

Specified by:

getKeyNameBytes in interface Tool.Authentication.ApiKeyConfigOrBuilder

Returns:

The bytes for keyName.

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];

Specified by:

getApiKey in interface Tool.Authentication.ApiKeyConfigOrBuilder

Returns:

The apiKey.

getApiKeyBytes

public com.google.protobuf.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];

Specified by:

getApiKeyBytes in interface Tool.Authentication.ApiKeyConfigOrBuilder

Returns:

The bytes for apiKey.

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];

Specified by:

getRequestLocationValue in interface Tool.Authentication.ApiKeyConfigOrBuilder

Returns:

The enum numeric value on the wire for requestLocation.

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];

Specified by:

getRequestLocation in interface Tool.Authentication.ApiKeyConfigOrBuilder

Returns:

The requestLocation.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(byte[] data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

public static Tool.Authentication.ApiKeyConfig parseDelimitedFrom(InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

public static Tool.Authentication.ApiKeyConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

newBuilderForType

public Tool.Authentication.ApiKeyConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

newBuilder

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

toBuilder

public Tool.Authentication.ApiKeyConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Tool.Authentication.ApiKeyConfig getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Tool.Authentication.ApiKeyConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Tool.Authentication.ApiKeyConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder