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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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.
Generated from protobuf field bool enable_kerberos = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableKerberos
Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Generated from protobuf field bool enable_kerberos = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRootPrincipalPasswordUri
Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
Generated from protobuf field string root_principal_password_uri = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string |
|
setRootPrincipalPasswordUri
Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
Generated from protobuf field string root_principal_password_uri = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKeyUri
Optional. The uri of the KMS key used to encrypt various sensitive files.
Generated from protobuf field string kms_key_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string |
|
setKmsKeyUri
Optional. The uri of the KMS key used to encrypt various sensitive files.
Generated from protobuf field string kms_key_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string keystore_uri = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string keystore_uri = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string truststore_uri = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string truststore_uri = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string keystore_password_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string keystore_password_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string key_password_uri = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string key_password_uri = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string truststore_password_uri = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string truststore_password_uri = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCrossRealmTrustRealm
Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Generated from protobuf field string cross_realm_trust_realm = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string |
|
setCrossRealmTrustRealm
Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Generated from protobuf field string cross_realm_trust_realm = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCrossRealmTrustKdc
Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Generated from protobuf field string cross_realm_trust_kdc = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string |
|
setCrossRealmTrustKdc
Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Generated from protobuf field string cross_realm_trust_kdc = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCrossRealmTrustAdminServer
Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Generated from protobuf field string cross_realm_trust_admin_server = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string |
|
setCrossRealmTrustAdminServer
Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Generated from protobuf field string cross_realm_trust_admin_server = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string cross_realm_trust_shared_password_uri = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string cross_realm_trust_shared_password_uri = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKdcDbKeyUri
Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
Generated from protobuf field string kdc_db_key_uri = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string |
|
setKdcDbKeyUri
Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
Generated from protobuf field string kdc_db_key_uri = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field int32 tgt_lifetime_hours = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field int32 tgt_lifetime_hours = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRealm
Optional. The name of the on-cluster Kerberos realm.
If not specified, the uppercased domain of hostnames will be the realm.
Generated from protobuf field string realm = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string |
|
setRealm
Optional. The name of the on-cluster Kerberos realm.
If not specified, the uppercased domain of hostnames will be the realm.
Generated from protobuf field string realm = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|