Tool.Authentication.ApiKeyConfig.Builder (proto-google-cloud-dialogflow-cx-v3beta1 0.71.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
    - - com.google.cloud.dialogflow.cx.v3beta1.Tool.Authentication.ApiKeyConfig.Builder

All Implemented Interfaces:

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

Enclosing class:

Tool.Authentication.ApiKeyConfig
```
public static final class Tool.Authentication.ApiKeyConfig.Builder
extends com.google.protobuf.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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Tool.Authentication.ApiKeyConfig.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Tool.Authentication.ApiKeyConfig`	`build()`
`Tool.Authentication.ApiKeyConfig`	`buildPartial()`
`Tool.Authentication.ApiKeyConfig.Builder`	`clear()`
`Tool.Authentication.ApiKeyConfig.Builder`	`clearApiKey()` Optional.
`Tool.Authentication.ApiKeyConfig.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Tool.Authentication.ApiKeyConfig.Builder`	`clearKeyName()` Required.
`Tool.Authentication.ApiKeyConfig.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Tool.Authentication.ApiKeyConfig.Builder`	`clearRequestLocation()` Required.
`Tool.Authentication.ApiKeyConfig.Builder`	`clone()`
`String`	`getApiKey()` Optional.
`com.google.protobuf.ByteString`	`getApiKeyBytes()` Optional.
`Tool.Authentication.ApiKeyConfig`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getKeyName()` Required.
`com.google.protobuf.ByteString`	`getKeyNameBytes()` Required.
`Tool.Authentication.RequestLocation`	`getRequestLocation()` Required.
`int`	`getRequestLocationValue()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Tool.Authentication.ApiKeyConfig.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Tool.Authentication.ApiKeyConfig.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Tool.Authentication.ApiKeyConfig.Builder`	`mergeFrom(Tool.Authentication.ApiKeyConfig other)`
`Tool.Authentication.ApiKeyConfig.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Tool.Authentication.ApiKeyConfig.Builder`	`setApiKey(String value)` Optional.
`Tool.Authentication.ApiKeyConfig.Builder`	`setApiKeyBytes(com.google.protobuf.ByteString value)` Optional.
`Tool.Authentication.ApiKeyConfig.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Tool.Authentication.ApiKeyConfig.Builder`	`setKeyName(String value)` Required.
`Tool.Authentication.ApiKeyConfig.Builder`	`setKeyNameBytes(com.google.protobuf.ByteString value)` Required.
`Tool.Authentication.ApiKeyConfig.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Tool.Authentication.ApiKeyConfig.Builder`	`setRequestLocation(Tool.Authentication.RequestLocation value)` Required.
`Tool.Authentication.ApiKeyConfig.Builder`	`setRequestLocationValue(int value)` Required.
`Tool.Authentication.ApiKeyConfig.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - 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.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - clear
```
public Tool.Authentication.ApiKeyConfig.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - getDefaultInstanceForType
```
public Tool.Authentication.ApiKeyConfig getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Tool.Authentication.ApiKeyConfig build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Tool.Authentication.ApiKeyConfig buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Tool.Authentication.ApiKeyConfig.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - setField
```
public Tool.Authentication.ApiKeyConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - clearField
```
public Tool.Authentication.ApiKeyConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - clearOneof
```
public Tool.Authentication.ApiKeyConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - setRepeatedField
```
public Tool.Authentication.ApiKeyConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                 int index,
                                                                 Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - addRepeatedField
```
public Tool.Authentication.ApiKeyConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                 Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - mergeFrom
```
public Tool.Authentication.ApiKeyConfig.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - mergeFrom
```
public Tool.Authentication.ApiKeyConfig.Builder mergeFrom(Tool.Authentication.ApiKeyConfig other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - mergeFrom
```
public Tool.Authentication.ApiKeyConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.Authentication.ApiKeyConfig.Builder>
    
    Throws:
    
    IOException
  - 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.
  - setKeyName
```
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];
    Parameters:
    
    value - The keyName to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setKeyNameBytes
```
public Tool.Authentication.ApiKeyConfig.Builder setKeyNameBytes(com.google.protobuf.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];
    Parameters:
    
    value - The bytes for keyName to set.
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setApiKey
```
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];
    Parameters:
    
    value - The apiKey to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setApiKeyBytes
```
public Tool.Authentication.ApiKeyConfig.Builder setApiKeyBytes(com.google.protobuf.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];
    Parameters:
    
    value - The bytes for apiKey to set.
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setRequestLocationValue
```
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];
    Parameters:
    
    value - The enum numeric value on the wire for requestLocation to set.
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setRequestLocation
```
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];
    Parameters:
    
    value - The requestLocation to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setUnknownFields
```
public final Tool.Authentication.ApiKeyConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>
  - mergeUnknownFields
```
public final Tool.Authentication.ApiKeyConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Tool.Authentication.ApiKeyConfig.Builder>

Class Tool.Authentication.ApiKeyConfig.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getKeyName

getKeyNameBytes

setKeyName

clearKeyName

setKeyNameBytes

getApiKey

getApiKeyBytes

setApiKey

clearApiKey

setApiKeyBytes

getRequestLocationValue

setRequestLocationValue

getRequestLocation

setRequestLocation

clearRequestLocation

setUnknownFields

mergeUnknownFields