Class Tool.Authentication.ApiKeyConfig.Builder (0.55.0)

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.cx.v3beta1.Tool.Authentication.ApiKeyConfig

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

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

clearApiKey()

public Tool.Authentication.ApiKeyConfig.Builder clearApiKey()

Required. The API key.

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

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

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

clearRequestLocation()

public Tool.Authentication.ApiKeyConfig.Builder clearRequestLocation()

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.ApiKeyConfig.Builder

This builder for chaining.

clone()

public Tool.Authentication.ApiKeyConfig.Builder clone()
Returns
Type Description
Tool.Authentication.ApiKeyConfig.Builder
Overrides

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

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

setApiKey(String value)

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

Required. The API key.

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

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)

Required. The API key.

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

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

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

setRequestLocation(Tool.Authentication.RequestLocation value)

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

Required. Key location in the request.

.google.cloud.dialogflow.cx.v3beta1.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.cx.v3beta1.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.

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