Interface ConfigMethodConfig

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
ConfigMethodConfig.BuilderBase.ConfigMethodConfigImpl

public interface ConfigMethodConfig extends Prototype.Api
Configuration of the config authentication method.
See Also:
  • Method Details

    • builder

      static ConfigMethodConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder
    • builder

      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance
    • create

      static ConfigMethodConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      static ConfigMethodConfig create()
      Create a new instance with default values.
      Returns:
      a new instance
    • region

      String region()
      The OCI region.
      Returns:
      the OCI region
    • fingerprint

      String fingerprint()
      The OCI authentication fingerprint.

      This configuration property must be provided in order to set the API signing key's fingerprint. See SimpleAuthenticationDetailsProvider.getFingerprint() for more details.

      Returns:
      the OCI authentication fingerprint
    • privateKey

      Optional<Resource> privateKey()
      The OCI authentication private key resource. A resource can be defined as a resource on classpath, file on the file system, base64 encoded text value in config, or plain-text value in config.

      If not defined, we will use .oci/oic_api_key.pem file in user home directory.

      Returns:
      the OCI authentication key file
    • passphrase

      Optional<char[]> passphrase()
      The OCI authentication passphrase.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPassphraseCharacters().

      Returns:
      the OCI authentication passphrase
    • tenantId

      String tenantId()
      The OCI tenant id.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getTenantId().

      Returns:
      the OCI tenant id
    • userId

      String userId()
      The OCI user id.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getUserId().

      Returns:
      the OCI user id