i.sdk.oci-hdfs-connector.2.9.2.1.source-code.overview.html Maven / Gradle / Ivy

Go to download


Quick Start Guide

User Documentation
More complete user documentation is available on the Oracle Cloud Infrastructure documentation portal.

HDFS Connector Properties
The following table details the HDFS properties you can set to connect to Oracle Cloud Infrastructure Object Storage.  Additional properties can be found in the user documentation
or by looking through the Javadocs for BmcProperties.


  
    
      Name
      Description
      Type
      Default
      Required?
    
  
  
    
      fs.oci.client.hostname
      Host endpoint for the Object Storage Service. For example https://objectstorage.us-phoenix-1.oraclecloud.com.
      string
      
      yes
    
    
      fs.oci.client.auth.tenantId
      Tenant OCID of the account.  Required unless a custom authenticator is provided.
      string
      
      yes
    
    
      fs.oci.client.auth.userId
      User OCID of the user making the request.  Required unless a custom authenticator is provided.
      string
      
      yes
    
    
      fs.oci.client.auth.fingerprint
      Fingerprint for the PEM file being used.  Required unless a custom authenticator is provided.
      string
      
      yes
    
    
      fs.oci.client.auth.pemfilepath
      Path to the PEM file used for authentication.  Required unless a custom authenticator is provided.
      string
      
      yes
    
    
      fs.oci.client.auth.passphrase
      Pass phrase to use if the PEM file is in encrypted format.
      string
      
      no
    
  



URI Format
HDFS filesystems and files are referenced through URIs.  Oracle Cloud Infrastructure Object Storage filesystem uses the scheme 'oci'.
Note: The scheme 'oraclebmc' is deprecated but still supported.

Root
The root of the Object Storage Service filesystem is denoted by a path where the authority component comprises the bucket and the namespace:

oci://bucket@namespace/

Objects/Files
An object named a/b/c/foo.json is referenced as:

oci://bucket@namespace/a/b/c/foo.json

Name	Description	Type	Default	Required?
fs.oci.client.hostname	Host endpoint for the Object Storage Service. For example `https://objectstorage.us-phoenix-1.oraclecloud.com`.	string		yes
fs.oci.client.auth.tenantId	Tenant OCID of the account. Required unless a custom authenticator is provided.	string		yes
fs.oci.client.auth.userId	User OCID of the user making the request. Required unless a custom authenticator is provided.	string		yes
fs.oci.client.auth.fingerprint	Fingerprint for the PEM file being used. Required unless a custom authenticator is provided.	string		yes
fs.oci.client.auth.pemfilepath	Path to the PEM file used for authentication. Required unless a custom authenticator is provided.	string		yes
fs.oci.client.auth.passphrase	Pass phrase to use if the PEM file is in encrypted format.	string		no