Class KerberosConfig (4.40.0)

public final class KerberosConfig extends GeneratedMessageV3 implements KerberosConfigOrBuilder

Specifies Kerberos related configuration.

Protobuf type google.cloud.dataproc.v1.KerberosConfig

Static Fields

CROSS_REALM_TRUST_ADMIN_SERVER_FIELD_NUMBER

public static final int CROSS_REALM_TRUST_ADMIN_SERVER_FIELD_NUMBER
Field Value
Type Description
int

CROSS_REALM_TRUST_KDC_FIELD_NUMBER

public static final int CROSS_REALM_TRUST_KDC_FIELD_NUMBER
Field Value
Type Description
int

CROSS_REALM_TRUST_REALM_FIELD_NUMBER

public static final int CROSS_REALM_TRUST_REALM_FIELD_NUMBER
Field Value
Type Description
int

CROSS_REALM_TRUST_SHARED_PASSWORD_URI_FIELD_NUMBER

public static final int CROSS_REALM_TRUST_SHARED_PASSWORD_URI_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_KERBEROS_FIELD_NUMBER

public static final int ENABLE_KERBEROS_FIELD_NUMBER
Field Value
Type Description
int

KDC_DB_KEY_URI_FIELD_NUMBER

public static final int KDC_DB_KEY_URI_FIELD_NUMBER
Field Value
Type Description
int

KEYSTORE_PASSWORD_URI_FIELD_NUMBER

public static final int KEYSTORE_PASSWORD_URI_FIELD_NUMBER
Field Value
Type Description
int

KEYSTORE_URI_FIELD_NUMBER

public static final int KEYSTORE_URI_FIELD_NUMBER
Field Value
Type Description
int

KEY_PASSWORD_URI_FIELD_NUMBER

public static final int KEY_PASSWORD_URI_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_URI_FIELD_NUMBER

public static final int KMS_KEY_URI_FIELD_NUMBER
Field Value
Type Description
int

REALM_FIELD_NUMBER

public static final int REALM_FIELD_NUMBER
Field Value
Type Description
int

ROOT_PRINCIPAL_PASSWORD_URI_FIELD_NUMBER

public static final int ROOT_PRINCIPAL_PASSWORD_URI_FIELD_NUMBER
Field Value
Type Description
int

TGT_LIFETIME_HOURS_FIELD_NUMBER

public static final int TGT_LIFETIME_HOURS_FIELD_NUMBER
Field Value
Type Description
int

TRUSTSTORE_PASSWORD_URI_FIELD_NUMBER

public static final int TRUSTSTORE_PASSWORD_URI_FIELD_NUMBER
Field Value
Type Description
int

TRUSTSTORE_URI_FIELD_NUMBER

public static final int TRUSTSTORE_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static KerberosConfig getDefaultInstance()
Returns
Type Description
KerberosConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static KerberosConfig.Builder newBuilder()
Returns
Type Description
KerberosConfig.Builder

newBuilder(KerberosConfig prototype)

public static KerberosConfig.Builder newBuilder(KerberosConfig prototype)
Parameter
Name Description
prototype KerberosConfig
Returns
Type Description
KerberosConfig.Builder

parseDelimitedFrom(InputStream input)

public static KerberosConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KerberosConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KerberosConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KerberosConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static KerberosConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
KerberosConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KerberosConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KerberosConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KerberosConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
KerberosConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KerberosConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KerberosConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KerberosConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
KerberosConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KerberosConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KerberosConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static KerberosConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KerberosConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KerberosConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KerberosConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static KerberosConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
KerberosConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KerberosConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KerberosConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<KerberosConfig> parser()
Returns
Type Description
Parser<KerberosConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCrossRealmTrustAdminServer()

public String getCrossRealmTrustAdminServer()

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

string cross_realm_trust_admin_server = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The crossRealmTrustAdminServer.

getCrossRealmTrustAdminServerBytes()

public ByteString getCrossRealmTrustAdminServerBytes()

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

string cross_realm_trust_admin_server = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for crossRealmTrustAdminServer.

getCrossRealmTrustKdc()

public String getCrossRealmTrustKdc()

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

string cross_realm_trust_kdc = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The crossRealmTrustKdc.

getCrossRealmTrustKdcBytes()

public ByteString getCrossRealmTrustKdcBytes()

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

string cross_realm_trust_kdc = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for crossRealmTrustKdc.

getCrossRealmTrustRealm()

public String getCrossRealmTrustRealm()

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

string cross_realm_trust_realm = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The crossRealmTrustRealm.

getCrossRealmTrustRealmBytes()

public ByteString getCrossRealmTrustRealmBytes()

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

string cross_realm_trust_realm = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for crossRealmTrustRealm.

getCrossRealmTrustSharedPasswordUri()

public String 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.

string cross_realm_trust_shared_password_uri = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The crossRealmTrustSharedPasswordUri.

getCrossRealmTrustSharedPasswordUriBytes()

public ByteString getCrossRealmTrustSharedPasswordUriBytes()

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.

string cross_realm_trust_shared_password_uri = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for crossRealmTrustSharedPasswordUri.

getDefaultInstanceForType()

public KerberosConfig getDefaultInstanceForType()
Returns
Type Description
KerberosConfig

getEnableKerberos()

public boolean getEnableKerberos()

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

bool enable_kerberos = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableKerberos.

getKdcDbKeyUri()

public String getKdcDbKeyUri()

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

string kdc_db_key_uri = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kdcDbKeyUri.

getKdcDbKeyUriBytes()

public ByteString getKdcDbKeyUriBytes()

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

string kdc_db_key_uri = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kdcDbKeyUri.

getKeyPasswordUri()

public String 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.

string key_password_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The keyPasswordUri.

getKeyPasswordUriBytes()

public ByteString getKeyPasswordUriBytes()

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.

string key_password_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for keyPasswordUri.

getKeystorePasswordUri()

public String 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.

string keystore_password_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The keystorePasswordUri.

getKeystorePasswordUriBytes()

public ByteString getKeystorePasswordUriBytes()

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.

string keystore_password_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for keystorePasswordUri.

getKeystoreUri()

public String getKeystoreUri()

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

string keystore_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The keystoreUri.

getKeystoreUriBytes()

public ByteString getKeystoreUriBytes()

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

string keystore_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for keystoreUri.

getKmsKeyUri()

public String getKmsKeyUri()

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

string kms_key_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kmsKeyUri.

getKmsKeyUriBytes()

public ByteString getKmsKeyUriBytes()

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

string kms_key_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kmsKeyUri.

getParserForType()

public Parser<KerberosConfig> getParserForType()
Returns
Type Description
Parser<KerberosConfig>
Overrides

getRealm()

public String getRealm()

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

string realm = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The realm.

getRealmBytes()

public ByteString getRealmBytes()

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

string realm = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for realm.

getRootPrincipalPasswordUri()

public String getRootPrincipalPasswordUri()

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

string root_principal_password_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The rootPrincipalPasswordUri.

getRootPrincipalPasswordUriBytes()

public ByteString getRootPrincipalPasswordUriBytes()

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

string root_principal_password_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for rootPrincipalPasswordUri.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTgtLifetimeHours()

public int 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.

int32 tgt_lifetime_hours = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The tgtLifetimeHours.

getTruststorePasswordUri()

public String 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.

string truststore_password_uri = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The truststorePasswordUri.

getTruststorePasswordUriBytes()

public ByteString getTruststorePasswordUriBytes()

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.

string truststore_password_uri = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for truststorePasswordUri.

getTruststoreUri()

public String getTruststoreUri()

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

string truststore_uri = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The truststoreUri.

getTruststoreUriBytes()

public ByteString getTruststoreUriBytes()

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

string truststore_uri = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for truststoreUri.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public KerberosConfig.Builder newBuilderForType()
Returns
Type Description
KerberosConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KerberosConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
KerberosConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public KerberosConfig.Builder toBuilder()
Returns
Type Description
KerberosConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException