Package com.google.cloud.dialogflow.v2

Interface Tool.Authentication.ApiKeyConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Tool.Authentication.ApiKeyConfig, Tool.Authentication.ApiKeyConfig.Builder
Enclosing class:
Tool.Authentication
public static interface Tool.Authentication.ApiKeyConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getKeyName

      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:
      The keyName.

    • getKeyNameBytes

      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];
      Returns:
      The bytes for keyName.

    • getApiKey

      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:
      The apiKey.

    • getApiKeyBytes

      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];
      Returns:
      The bytes for apiKey.

    • getSecretVersionForApiKey

      String getSecretVersionForApiKey()
       Optional. The name of the SecretManager secret version resource storing
 the API key. If this field is set, the `api_key` field will be ignored.
 Format: `projects/{project}/secrets/{secret}/versions/{version}`
      string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The secretVersionForApiKey.

    • getSecretVersionForApiKeyBytes

      com.google.protobuf.ByteString getSecretVersionForApiKeyBytes()
       Optional. The name of the SecretManager secret version resource storing
 the API key. If this field is set, the `api_key` field will be ignored.
 Format: `projects/{project}/secrets/{secret}/versions/{version}`
      string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for secretVersionForApiKey.

    • getRequestLocationValue

      int getRequestLocationValue()
       Required. Key location in the request.
      .google.cloud.dialogflow.v2.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for requestLocation.

    • getRequestLocation

      Tool.Authentication.RequestLocation getRequestLocation()
       Required. Key location in the request.
      .google.cloud.dialogflow.v2.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The requestLocation.