Class ActiveDirectory (0.11.0)

public final class ActiveDirectory extends GeneratedMessageV3 implements ActiveDirectoryOrBuilder

ActiveDirectory is the public representation of the active directory config.

Protobuf type google.cloud.netapp.v1.ActiveDirectory

Static Fields

AES_ENCRYPTION_FIELD_NUMBER

public static final int AES_ENCRYPTION_FIELD_NUMBER
Field Value
TypeDescription
int

BACKUP_OPERATORS_FIELD_NUMBER

public static final int BACKUP_OPERATORS_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DNS_FIELD_NUMBER

public static final int DNS_FIELD_NUMBER
Field Value
TypeDescription
int

DOMAIN_FIELD_NUMBER

public static final int DOMAIN_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPT_DC_CONNECTIONS_FIELD_NUMBER

public static final int ENCRYPT_DC_CONNECTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

KDC_HOSTNAME_FIELD_NUMBER

public static final int KDC_HOSTNAME_FIELD_NUMBER
Field Value
TypeDescription
int

KDC_IP_FIELD_NUMBER

public static final int KDC_IP_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LDAP_SIGNING_FIELD_NUMBER

public static final int LDAP_SIGNING_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NET_BIOS_PREFIX_FIELD_NUMBER

public static final int NET_BIOS_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

NFS_USERS_WITH_LDAP_FIELD_NUMBER

public static final int NFS_USERS_WITH_LDAP_FIELD_NUMBER
Field Value
TypeDescription
int

ORGANIZATIONAL_UNIT_FIELD_NUMBER

public static final int ORGANIZATIONAL_UNIT_FIELD_NUMBER
Field Value
TypeDescription
int

PASSWORD_FIELD_NUMBER

public static final int PASSWORD_FIELD_NUMBER
Field Value
TypeDescription
int

SECURITY_OPERATORS_FIELD_NUMBER

public static final int SECURITY_OPERATORS_FIELD_NUMBER
Field Value
TypeDescription
int

SITE_FIELD_NUMBER

public static final int SITE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_DETAILS_FIELD_NUMBER

public static final int STATE_DETAILS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

USERNAME_FIELD_NUMBER

public static final int USERNAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ActiveDirectory getDefaultInstance()
Returns
TypeDescription
ActiveDirectory

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ActiveDirectory.Builder newBuilder()
Returns
TypeDescription
ActiveDirectory.Builder

newBuilder(ActiveDirectory prototype)

public static ActiveDirectory.Builder newBuilder(ActiveDirectory prototype)
Parameter
NameDescription
prototypeActiveDirectory
Returns
TypeDescription
ActiveDirectory.Builder

parseDelimitedFrom(InputStream input)

public static ActiveDirectory parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ActiveDirectory parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ActiveDirectory parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ActiveDirectory parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ActiveDirectory parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ActiveDirectory parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ActiveDirectory parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ActiveDirectory parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ActiveDirectory parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ActiveDirectory parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ActiveDirectory parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ActiveDirectory parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ActiveDirectory
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ActiveDirectory> parser()
Returns
TypeDescription
Parser<ActiveDirectory>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels for the active directory.

map<string, string> labels = 20;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAesEncryption()

public boolean getAesEncryption()

If enabled, AES encryption will be enabled for SMB communication.

bool aes_encryption = 9;

Returns
TypeDescription
boolean

The aesEncryption.

getBackupOperators(int index)

public String getBackupOperators(int index)

Users to be added to the Built-in Backup Operator active directory group.

repeated string backup_operators = 12;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The backupOperators at the given index.

getBackupOperatorsBytes(int index)

public ByteString getBackupOperatorsBytes(int index)

Users to be added to the Built-in Backup Operator active directory group.

repeated string backup_operators = 12;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the backupOperators at the given index.

getBackupOperatorsCount()

public int getBackupOperatorsCount()

Users to be added to the Built-in Backup Operator active directory group.

repeated string backup_operators = 12;

Returns
TypeDescription
int

The count of backupOperators.

getBackupOperatorsList()

public ProtocolStringList getBackupOperatorsList()

Users to be added to the Built-in Backup Operator active directory group.

repeated string backup_operators = 12;

Returns
TypeDescription
ProtocolStringList

A list containing the backupOperators.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time of the active directory.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time of the active directory.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ActiveDirectory getDefaultInstanceForType()
Returns
TypeDescription
ActiveDirectory

getDescription()

public String getDescription()

Description of the active directory.

string description = 17;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the active directory.

string description = 17;

Returns
TypeDescription
ByteString

The bytes for description.

getDns()

public String getDns()

Required. Comma separated list of DNS server IP addresses for the Active Directory domain.

string dns = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The dns.

getDnsBytes()

public ByteString getDnsBytes()

Required. Comma separated list of DNS server IP addresses for the Active Directory domain.

string dns = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for dns.

getDomain()

public String getDomain()

Required. Name of the Active Directory domain

string domain = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The domain.

getDomainBytes()

public ByteString getDomainBytes()

Required. Name of the Active Directory domain

string domain = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for domain.

getEncryptDcConnections()

public boolean getEncryptDcConnections()

If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.

bool encrypt_dc_connections = 19;

Returns
TypeDescription
boolean

The encryptDcConnections.

getKdcHostname()

public String getKdcHostname()

Name of the active directory machine. This optional parameter is used only while creating kerberos volume

string kdc_hostname = 14;

Returns
TypeDescription
String

The kdcHostname.

getKdcHostnameBytes()

public ByteString getKdcHostnameBytes()

Name of the active directory machine. This optional parameter is used only while creating kerberos volume

string kdc_hostname = 14;

Returns
TypeDescription
ByteString

The bytes for kdcHostname.

getKdcIp()

public String getKdcIp()

KDC server IP address for the active directory machine.

string kdc_ip = 15;

Returns
TypeDescription
String

The kdcIp.

getKdcIpBytes()

public ByteString getKdcIpBytes()

KDC server IP address for the active directory machine.

string kdc_ip = 15;

Returns
TypeDescription
ByteString

The bytes for kdcIp.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels for the active directory.

map<string, string> labels = 20;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels for the active directory.

map<string, string> labels = 20;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels for the active directory.

map<string, string> labels = 20;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels for the active directory.

map<string, string> labels = 20;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLdapSigning()

public boolean getLdapSigning()

Specifies whether or not the LDAP traffic needs to be signed.

bool ldap_signing = 18;

Returns
TypeDescription
boolean

The ldapSigning.

getName()

public String getName()

Output only. The resource name of the active directory. Format: projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the active directory. Format: projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getNetBiosPrefix()

public String getNetBiosPrefix()

Required. NetBIOSPrefix is used as a prefix for SMB server name.

string net_bios_prefix = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The netBiosPrefix.

getNetBiosPrefixBytes()

public ByteString getNetBiosPrefixBytes()

Required. NetBIOSPrefix is used as a prefix for SMB server name.

string net_bios_prefix = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for netBiosPrefix.

getNfsUsersWithLdap()

public boolean getNfsUsersWithLdap()

If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.

bool nfs_users_with_ldap = 16;

Returns
TypeDescription
boolean

The nfsUsersWithLdap.

getOrganizationalUnit()

public String getOrganizationalUnit()

The Organizational Unit (OU) within the Windows Active Directory the user belongs to.

string organizational_unit = 8;

Returns
TypeDescription
String

The organizationalUnit.

getOrganizationalUnitBytes()

public ByteString getOrganizationalUnitBytes()

The Organizational Unit (OU) within the Windows Active Directory the user belongs to.

string organizational_unit = 8;

Returns
TypeDescription
ByteString

The bytes for organizationalUnit.

getParserForType()

public Parser<ActiveDirectory> getParserForType()
Returns
TypeDescription
Parser<ActiveDirectory>
Overrides

getPassword()

public String getPassword()

Required. Password of the Active Directory domain administrator.

string password = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The password.

getPasswordBytes()

public ByteString getPasswordBytes()

Required. Password of the Active Directory domain administrator.

string password = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for password.

getSecurityOperators(int index)

public String getSecurityOperators(int index)

Domain users to be given the SeSecurityPrivilege.

repeated string security_operators = 13;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The securityOperators at the given index.

getSecurityOperatorsBytes(int index)

public ByteString getSecurityOperatorsBytes(int index)

Domain users to be given the SeSecurityPrivilege.

repeated string security_operators = 13;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the securityOperators at the given index.

getSecurityOperatorsCount()

public int getSecurityOperatorsCount()

Domain users to be given the SeSecurityPrivilege.

repeated string security_operators = 13;

Returns
TypeDescription
int

The count of securityOperators.

getSecurityOperatorsList()

public ProtocolStringList getSecurityOperatorsList()

Domain users to be given the SeSecurityPrivilege.

repeated string security_operators = 13;

Returns
TypeDescription
ProtocolStringList

A list containing the securityOperators.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSite()

public String getSite()

The Active Directory site the service will limit Domain Controller discovery too.

string site = 5;

Returns
TypeDescription
String

The site.

getSiteBytes()

public ByteString getSiteBytes()

The Active Directory site the service will limit Domain Controller discovery too.

string site = 5;

Returns
TypeDescription
ByteString

The bytes for site.

getState()

public ActiveDirectory.State getState()

Output only. The state of the AD.

.google.cloud.netapp.v1.ActiveDirectory.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ActiveDirectory.State

The state.

getStateDetails()

public String getStateDetails()

Output only. The state details of the Active Directory.

string state_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The stateDetails.

getStateDetailsBytes()

public ByteString getStateDetailsBytes()

Output only. The state details of the Active Directory.

string state_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for stateDetails.

getStateValue()

public int getStateValue()

Output only. The state of the AD.

.google.cloud.netapp.v1.ActiveDirectory.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUsername()

public String getUsername()

Required. Username of the Active Directory domain administrator.

string username = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The username.

getUsernameBytes()

public ByteString getUsernameBytes()

Required. Username of the Active Directory domain administrator.

string username = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for username.

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time of the active directory.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ActiveDirectory.Builder newBuilderForType()
Returns
TypeDescription
ActiveDirectory.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ActiveDirectory.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ActiveDirectory.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ActiveDirectory.Builder toBuilder()
Returns
TypeDescription
ActiveDirectory.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException