Class OciConfigProfile

  • All Implemented Interfaces:
    OciConfigProvider

    @Deprecated(since="2.5.0",
                forRemoval=true)
    public class OciConfigProfile
    extends Object
    implements OciConfigProvider
    Deprecated, for removal: This API element is subject to removal in a future version.
    OCI SDK instead
    OCI configuration required to connect to a service over REST API.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OciConfigProfile.Builder
      Deprecated, for removal: This API element is subject to removal in a future version.
      Fluent API builder for OciConfigProfile.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static OciConfigProfile.Builder builder()
      Deprecated, for removal: This API element is subject to removal in a future version.
      A new fluent API builder to configure a new profile config.
      static OciConfigProfile create()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create configuration from the default location ~/.oci/config and default profile DEFAULT.
      static OciConfigProfile create​(Config config)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new instance from configuration.
      Map<String,​String> fullConfig()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Full map of configuration properties either from OCI config file or from config.
      String keyFingerprint()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Fingerprint of the key.
      String privateKey()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Private key (PEM encoded) used to sign requests.
      Optional<String> property​(String key)
      Deprecated, for removal: This API element is subject to removal in a future version.
      A property defined either in OCI config file or in config.
      String region()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Region to use when connecting to OCI.
      OciSignatureData signatureData()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the current signature data.
      String tenancyOcid()
      Deprecated, for removal: This API element is subject to removal in a future version.
      OCID of the tenancy.
      String userOcid()
      Deprecated, for removal: This API element is subject to removal in a future version.
      OCID of the user.
    • Method Detail

      • create

        public static OciConfigProfile create()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Create configuration from the default location ~/.oci/config and default profile DEFAULT.
        Returns:
        a new configuration loaded from default location
      • builder

        public static OciConfigProfile.Builder builder()
        Deprecated, for removal: This API element is subject to removal in a future version.
        A new fluent API builder to configure a new profile config.
        Returns:
        a new builder
      • create

        public static OciConfigProfile create​(Config config)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Create a new instance from configuration.
        Parameters:
        config - configuration
        Returns:
        a new profile configuration
      • signatureData

        public OciSignatureData signatureData()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: OciConfigProvider
        Get the current signature data.
        Specified by:
        signatureData in interface OciConfigProvider
        Returns:
        current signature data
      • userOcid

        public String userOcid()
        Deprecated, for removal: This API element is subject to removal in a future version.
        OCID of the user. Uses key user in OCI config file and in config.
        Returns:
        user OCID
      • tenancyOcid

        public String tenancyOcid()
        Deprecated, for removal: This API element is subject to removal in a future version.
        OCID of the tenancy. Uses key tenancy in OCI config file and in config.
        Specified by:
        tenancyOcid in interface OciConfigProvider
        Returns:
        tenancy OCID
      • keyFingerprint

        public String keyFingerprint()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Fingerprint of the key. Uses key fingerprint in OCI config file and in config.
        Returns:
        key fingerprint
      • region

        public String region()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Region to use when connecting to OCI. This is used to resolve the host to connect to. Uses key region in OCI config file and in config.
        Specified by:
        region in interface OciConfigProvider
        Returns:
        OCI region, such as eu-frankfurt-1
      • privateKey

        public String privateKey()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Private key (PEM encoded) used to sign requests. Uses key-file in OCI config to locate the PEM file, uses key-pem in config.
        Returns:
        private key to use for signing requests
      • property

        public Optional<String> property​(String key)
        Deprecated, for removal: This API element is subject to removal in a future version.
        A property defined either in OCI config file or in config.
        Parameters:
        key - name of the property
        Returns:
        value if present in configuration
      • fullConfig

        public Map<String,​String> fullConfig()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Full map of configuration properties either from OCI config file or from config.
        Returns:
        map of key/value pairs