Class Tool.Authentication.ApiKeyConfig (0.73.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 0.73.0keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int API_KEY_FIELD_NUMBER
Field Value
Type Description
int
public static final int KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int REQUEST_LOCATION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static Tool . Authentication . ApiKeyConfig getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static Tool . Authentication . ApiKeyConfig . Builder newBuilder ()
public static Tool . Authentication . ApiKeyConfig . Builder newBuilder ( Tool . Authentication . ApiKeyConfig prototype )
public static Tool . Authentication . ApiKeyConfig parseDelimitedFrom ( InputStream input )
public static Tool . Authentication . ApiKeyConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static Tool . Authentication . ApiKeyConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static Tool . Authentication . ApiKeyConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static Tool . Authentication . ApiKeyConfig parseFrom ( ByteString data )
public static Tool . Authentication . ApiKeyConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Tool . Authentication . ApiKeyConfig parseFrom ( CodedInputStream input )
public static Tool . Authentication . ApiKeyConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Tool . Authentication . ApiKeyConfig parseFrom ( InputStream input )
public static Tool . Authentication . ApiKeyConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static Tool . Authentication . ApiKeyConfig parseFrom ( ByteBuffer data )
public static Tool . Authentication . ApiKeyConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<Tool . Authentication . ApiKeyConfig > parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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.
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.
public Tool . Authentication . ApiKeyConfig getDefaultInstanceForType ()
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.
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.
public Parser<Tool . Authentication . ApiKeyConfig > getParserForType ()
Overrides
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];
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.
public int getSerializedSize ()
Returns
Type Description
int
Overrides
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public Tool . Authentication . ApiKeyConfig . Builder newBuilderForType ()
protected Tool . Authentication . ApiKeyConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public Tool . Authentication . ApiKeyConfig . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
