- 0.58.0 (latest)
- 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.ApiKeyConfigImplements
Tool.Authentication.ApiKeyConfigOrBuilderStatic 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 |
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> |
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 |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
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 |
Exceptions | |
---|---|
Type | Description |
IOException |