Interface AuthConfig.ApiKeyConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AuthConfig.ApiKeyConfig, AuthConfig.ApiKeyConfig.Builder
Enclosing class:
AuthConfig

public static interface AuthConfig.ApiKeyConfigOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      String getName()
       Required. The parameter name of the API key.
       E.g. If the API request is "https://example.com/act?api_key=<API KEY>",
       "api_key" would be the parameter name.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The parameter name of the API key.
       E.g. If the API request is "https://example.com/act?api_key=<API KEY>",
       "api_key" would be the parameter name.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for name.
    • hasApiKey

      boolean hasApiKey()
       Required. The name of the SecretManager secret version resource storing
       the API key. Format:
       `projects/{project}/secrets/{secrete}/versions/{version}`. The
       `secretmanager.versions.access` permission should be granted to the
       service account accessing the secret.
       
      .google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the apiKey field is set.
    • getApiKey

      Secret getApiKey()
       Required. The name of the SecretManager secret version resource storing
       the API key. Format:
       `projects/{project}/secrets/{secrete}/versions/{version}`. The
       `secretmanager.versions.access` permission should be granted to the
       service account accessing the secret.
       
      .google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The apiKey.
    • getApiKeyOrBuilder

      SecretOrBuilder getApiKeyOrBuilder()
       Required. The name of the SecretManager secret version resource storing
       the API key. Format:
       `projects/{project}/secrets/{secrete}/versions/{version}`. The
       `secretmanager.versions.access` permission should be granted to the
       service account accessing the secret.
       
      .google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];
    • getHttpElementLocationValue

      int getHttpElementLocationValue()
       Required. The location of the API key.
       The default value is QUERY.
       
      .google.cloud.apihub.v1.AuthConfig.ApiKeyConfig.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for httpElementLocation.
    • getHttpElementLocation

       Required. The location of the API key.
       The default value is QUERY.
       
      .google.cloud.apihub.v1.AuthConfig.ApiKeyConfig.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The httpElementLocation.