Google Cloud Oracle Database V1 Client - Class GoldengateOciObjectStorageConnectionProperties (0.9.0)

Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class GoldengateOciObjectStorageConnectionProperties.

The properties of GoldengateOciObjectStorageConnection.

Generated from protobuf message google.cloud.oracledatabase.v1.GoldengateOciObjectStorageConnectionProperties

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ technology_type string

Optional. The technology type of OciObjectStorageConnection.

↳ tenancy_id string

Optional. The OCID of the related OCI tenancy.

↳ region string

Optional. The name of the region of OCI Object Storage. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

↳ user_id string

Optional. The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

↳ private_key_file string

Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.

↳ private_key_passphrase_secret string

Optional. The passphrase of the private key.

↳ public_key_fingerprint string

Optional. The fingerprint of the API Key of the user specified by the userId.

↳ use_resource_principal bool

Optional. Specifies that the user intends to authenticate to the instance using a resource principal.

getTechnologyType

Optional. The technology type of OciObjectStorageConnection.

Returns
Type Description
string

setTechnologyType

Optional. The technology type of OciObjectStorageConnection.

Parameter
Name Description
var string
Returns
Type Description
$this

getTenancyId

Optional. The OCID of the related OCI tenancy.

Returns
Type Description
string

setTenancyId

Optional. The OCID of the related OCI tenancy.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

Optional. The name of the region of OCI Object Storage. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

Returns
Type Description
string

setRegion

Optional. The name of the region of OCI Object Storage. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

Parameter
Name Description
var string
Returns
Type Description
$this

getUserId

Optional. The OCID of the OCI user who will access the Object Storage.

The user must have write access to the bucket they want to connect to.

Returns
Type Description
string

setUserId

Optional. The OCID of the OCI user who will access the Object Storage.

The user must have write access to the bucket they want to connect to.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrivateKeyFile

Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.

Returns
Type Description
string

setPrivateKeyFile

Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrivateKeyPassphraseSecret

Optional. The passphrase of the private key.

Returns
Type Description
string

setPrivateKeyPassphraseSecret

Optional. The passphrase of the private key.

Parameter
Name Description
var string
Returns
Type Description
$this

getPublicKeyFingerprint

Optional. The fingerprint of the API Key of the user specified by the userId.

Returns
Type Description
string

setPublicKeyFingerprint

Optional. The fingerprint of the API Key of the user specified by the userId.

Parameter
Name Description
var string
Returns
Type Description
$this

getUseResourcePrincipal

Optional. Specifies that the user intends to authenticate to the instance using a resource principal.

Returns
Type Description
bool

setUseResourcePrincipal

Optional. Specifies that the user intends to authenticate to the instance using a resource principal.

Parameter
Name Description
var bool
Returns
Type Description
$this