Credentials

AwsGlueSchemaRegistryCredentialsSpec

alias of S3AccessKeyCredentials

class AzureAccountKeyCredentials(
account_name: str | Secret,
account_key: str | Secret,
)

Bases: AzureCredentials

Categories:

credentials

Credentials class to access Azure using account key credentials (account name and account key).

Variables:
  • account_name (Secret) – The Azure account name.

  • account_key (Secret) – The Azure account key.

  • dict (to_dict() ->) – Convert the AzureAccountNameKeyCredentials object to a dictionary

property account_key: Secret

The Azure account key.

Type:

Secret

property account_name: Secret

The Azure account name.

Type:

Secret

ConfluentSchemaRegistryCredentialsSpec

alias of UserPasswordCredentials

class GCPServiceAccountKeyCredentials(
service_account_key: str | Secret,
)

Bases: GCPCredentials

Categories:

credentials

Credentials class to store the credentials needed to access GCS using account key credentials (service account key).

Variables:
  • service_account_key (Secret) – The GCS service account key.

  • dict (to_dict() ->) – Convert the GCPServiceAccountKeyCredentials object to a dictionary

property service_account_key: Secret

The GCS service account key.

Type:

Secret

class HMACCredentials(
access_key: str | Secret,
secret_key: str | Secret,
)

Bases: Credentials

Categories:

credentials

Generic HMAC credentials consisting of an access key and a secret key.

These credentials follow the same shape as AWS S3 access keys and are compatible with any service that uses HMAC-based authentication over the S3-compatible API, such as GCS HMAC keys or MinIO credentials.

Variables:
  • access_key (Secret) – The HMAC access key id.

  • secret_key (Secret) – The HMAC secret key.

  • dict (to_dict() ->) – Convert the HMACCredentials object to a dictionary.

property access_key: Secret

The HMAC access key id.

Type:

Secret

property secret_key: Secret

The HMAC secret key.

Type:

Secret

KafkaCredentialsSpec

alias of UserPasswordCredentials

class S3AccessKeyCredentials(
aws_access_key_id: str | Secret,
aws_secret_access_key: str | Secret,
)

Bases: S3Credentials

Categories:

credentials

Credentials class to access an S3 bucket using access key credentials (access key id and secret access key).

Variables:
  • aws_access_key_id (Secret) – The AWS access key id.

  • aws_secret_access_key (Secret) – The AWS secret access key.

  • dict (to_dict() ->) – Convert the S3AccessKeyCredentials object to a dictionary

property aws_access_key_id: Secret

The AWS access key id.

Type:

Secret

property aws_secret_access_key: Secret

The AWS secret access key.

Type:

Secret

class SalesforceTokenCredentials(
username: str | Secret,
password: str | Secret,
security_token: str | Secret,
)

Bases: SalesforceCredentials

Categories:

credentials

Credentials class to store the credentials needed to access a Salesforce using a username, a password and a token.

Variables:
  • username (Secret) – The username to access Salesforce.

  • password (Secret) – The password to access Salesforce.

  • security_token (Secret) – The security token to access Salesforce.

  • dict (to_dict() ->) – Convert the AzureAccountNameKeyCredentials object to a dictionary

property password: Secret

The password to access Salesforce.

Type:

Secret

property security_token: Secret

The security token to access Salesforce.

Type:

Secret

property username: Secret

The username to access Salesforce.

Type:

Secret

class UserPasswordCredentials(
user: str | Secret,
password: str | Secret,
)

Bases: Credentials

Categories:

credentials

Represents credentials consisting of a user and a password.

This class is used to manage and securely handle user and password credentials. It includes functionalities to set user and password details, convert them into a dictionary representation, and provide a string representation for debugging purposes.

property password: Secret

The password.

Type:

Secret

property user: Secret

The user.

Type:

Secret