Package com.google.cloud.dialogflow.v2

Class Tool.Authentication.ApiKeyConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.Tool.Authentication.ApiKeyConfig
All Implemented Interfaces:
Tool.Authentication.ApiKeyConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Tool.Authentication
public static final class Tool.Authentication.ApiKeyConfig extends com.google.protobuf.GeneratedMessage implements Tool.Authentication.ApiKeyConfigOrBuilder
 Config for authentication with API key.
Protobuf type google.cloud.dialogflow.v2.Tool.Authentication.ApiKeyConfig
See Also:

  • Field Details

    • KEY_NAME_FIELD_NUMBER

      public static final int KEY_NAME_FIELD_NUMBER
      See Also:

    • API_KEY_FIELD_NUMBER

      public static final int API_KEY_FIELD_NUMBER
      See Also:

    • SECRET_VERSION_FOR_API_KEY_FIELD_NUMBER

      public static final int SECRET_VERSION_FOR_API_KEY_FIELD_NUMBER
      See Also:

    • REQUEST_LOCATION_FIELD_NUMBER

      public static final int REQUEST_LOCATION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

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

    • getSecretVersionForApiKey

      public 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) = { ... }
      Specified by:
      getSecretVersionForApiKey in interface Tool.Authentication.ApiKeyConfigOrBuilder
      Returns:
      The secretVersionForApiKey.

    • getSecretVersionForApiKeyBytes

      public 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) = { ... }
      Specified by:
      getSecretVersionForApiKeyBytes in interface Tool.Authentication.ApiKeyConfigOrBuilder
      Returns:
      The bytes for secretVersionForApiKey.

    • getRequestLocationValue

      public int getRequestLocationValue()
       Required. Key location in the request.
      .google.cloud.dialogflow.v2.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.

    • getRequestLocation

      public 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];
      Specified by:
      getRequestLocation in interface Tool.Authentication.ApiKeyConfigOrBuilder
      Returns:
      The requestLocation.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Tool.Authentication.ApiKeyConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Tool.Authentication.ApiKeyConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.Authentication.ApiKeyConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Tool.Authentication.ApiKeyConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Tool.Authentication.ApiKeyConfig.Builder newBuilder()

    • newBuilder

      public static Tool.Authentication.ApiKeyConfig.Builder newBuilder(Tool.Authentication.ApiKeyConfig prototype)

    • toBuilder

      public Tool.Authentication.ApiKeyConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Tool.Authentication.ApiKeyConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Tool.Authentication.ApiKeyConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Tool.Authentication.ApiKeyConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<Tool.Authentication.ApiKeyConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Tool.Authentication.ApiKeyConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder