Google Cloud Dataproc V1 Client - Class KerberosConfig (3.11.0)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class KerberosConfig.

Specifies Kerberos related configuration.

Generated from protobuf message google.cloud.dataproc.v1.KerberosConfig

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ enable_kerberos bool

Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

↳ root_principal_password_uri string

Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

↳ kms_key_uri string

Optional. The uri of the KMS key used to encrypt various sensitive files.

↳ keystore_uri string

Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

↳ truststore_uri string

Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

↳ keystore_password_uri string

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.

↳ key_password_uri string

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.

↳ truststore_password_uri string

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.

↳ cross_realm_trust_realm string

Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

↳ cross_realm_trust_kdc string

Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

↳ cross_realm_trust_admin_server string

Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

↳ cross_realm_trust_shared_password_uri string

Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.

↳ kdc_db_key_uri string

Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

↳ tgt_lifetime_hours int

Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

↳ realm string

Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

getEnableKerberos

Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

Returns
TypeDescription
bool

setEnableKerberos

Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getRootPrincipalPasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

Returns
TypeDescription
string

setRootPrincipalPasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKmsKeyUri

Optional. The uri of the KMS key used to encrypt various sensitive files.

Returns
TypeDescription
string

setKmsKeyUri

Optional. The uri of the KMS key used to encrypt various sensitive files.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKeystoreUri

Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

Returns
TypeDescription
string

setKeystoreUri

Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTruststoreUri

Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

Returns
TypeDescription
string

setTruststoreUri

Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKeystorePasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.

Returns
TypeDescription
string

setKeystorePasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKeyPasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.

Returns
TypeDescription
string

setKeyPasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTruststorePasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.

Returns
TypeDescription
string

setTruststorePasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCrossRealmTrustRealm

Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

Returns
TypeDescription
string

setCrossRealmTrustRealm

Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCrossRealmTrustKdc

Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

Returns
TypeDescription
string

setCrossRealmTrustKdc

Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCrossRealmTrustAdminServer

Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

Returns
TypeDescription
string

setCrossRealmTrustAdminServer

Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCrossRealmTrustSharedPasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.

Returns
TypeDescription
string

setCrossRealmTrustSharedPasswordUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKdcDbKeyUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

Returns
TypeDescription
string

setKdcDbKeyUri

Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTgtLifetimeHours

Optional. The lifetime of the ticket granting ticket, in hours.

If not specified, or user specifies 0, then default value 10 will be used.

Returns
TypeDescription
int

setTgtLifetimeHours

Optional. The lifetime of the ticket granting ticket, in hours.

If not specified, or user specifies 0, then default value 10 will be used.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRealm

Optional. The name of the on-cluster Kerberos realm.

If not specified, the uppercased domain of hostnames will be the realm.

Returns
TypeDescription
string

setRealm

Optional. The name of the on-cluster Kerberos realm.

If not specified, the uppercased domain of hostnames will be the realm.

Parameter
NameDescription
var string
Returns
TypeDescription
$this