Class ActiveDirectory

  • All Implemented Interfaces:
    ActiveDirectoryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ActiveDirectory
    extends com.google.protobuf.GeneratedMessageV3
    implements ActiveDirectoryOrBuilder
     ActiveDirectory is the public representation of the active directory config.
     
    Protobuf type google.cloud.netapp.v1.ActiveDirectory
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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];
        Specified by:
        getName in interface ActiveDirectoryOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for name.
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Create time of the active directory.
         
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ActiveDirectoryOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Create time of the active directory.
         
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ActiveDirectoryOrBuilder
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Create time of the active directory.
         
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ActiveDirectoryOrBuilder
      • 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];
        Specified by:
        getStateValue in interface ActiveDirectoryOrBuilder
        Returns:
        The enum numeric value on the wire for state.
      • 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];
        Specified by:
        getState in interface ActiveDirectoryOrBuilder
        Returns:
        The state.
      • getDomain

        public String getDomain()
         Required. Name of the Active Directory domain
         
        string domain = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDomain in interface ActiveDirectoryOrBuilder
        Returns:
        The domain.
      • getDomainBytes

        public com.google.protobuf.ByteString getDomainBytes()
         Required. Name of the Active Directory domain
         
        string domain = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDomainBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for domain.
      • getSite

        public String getSite()
         The Active Directory site the service will limit Domain Controller
         discovery too.
         
        string site = 5;
        Specified by:
        getSite in interface ActiveDirectoryOrBuilder
        Returns:
        The site.
      • getSiteBytes

        public com.google.protobuf.ByteString getSiteBytes()
         The Active Directory site the service will limit Domain Controller
         discovery too.
         
        string site = 5;
        Specified by:
        getSiteBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for site.
      • 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];
        Specified by:
        getDns in interface ActiveDirectoryOrBuilder
        Returns:
        The dns.
      • getDnsBytes

        public com.google.protobuf.ByteString getDnsBytes()
         Required. Comma separated list of DNS server IP addresses for the Active
         Directory domain.
         
        string dns = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDnsBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for dns.
      • 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];
        Specified by:
        getNetBiosPrefix in interface ActiveDirectoryOrBuilder
        Returns:
        The netBiosPrefix.
      • getNetBiosPrefixBytes

        public com.google.protobuf.ByteString getNetBiosPrefixBytes()
         Required. NetBIOSPrefix is used as a prefix for SMB server name.
         
        string net_bios_prefix = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNetBiosPrefixBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for netBiosPrefix.
      • getOrganizationalUnit

        public String getOrganizationalUnit()
         The Organizational Unit (OU) within the Windows Active Directory the user
         belongs to.
         
        string organizational_unit = 8;
        Specified by:
        getOrganizationalUnit in interface ActiveDirectoryOrBuilder
        Returns:
        The organizationalUnit.
      • getOrganizationalUnitBytes

        public com.google.protobuf.ByteString getOrganizationalUnitBytes()
         The Organizational Unit (OU) within the Windows Active Directory the user
         belongs to.
         
        string organizational_unit = 8;
        Specified by:
        getOrganizationalUnitBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for organizationalUnit.
      • getAesEncryption

        public boolean getAesEncryption()
         If enabled, AES encryption will be enabled for SMB communication.
         
        bool aes_encryption = 9;
        Specified by:
        getAesEncryption in interface ActiveDirectoryOrBuilder
        Returns:
        The aesEncryption.
      • getUsername

        public String getUsername()
         Required. Username of the Active Directory domain administrator.
         
        string username = 10 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUsername in interface ActiveDirectoryOrBuilder
        Returns:
        The username.
      • getUsernameBytes

        public com.google.protobuf.ByteString getUsernameBytes()
         Required. Username of the Active Directory domain administrator.
         
        string username = 10 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUsernameBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for username.
      • getPassword

        public String getPassword()
         Required. Password of the Active Directory domain administrator.
         
        string password = 11 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPassword in interface ActiveDirectoryOrBuilder
        Returns:
        The password.
      • getPasswordBytes

        public com.google.protobuf.ByteString getPasswordBytes()
         Required. Password of the Active Directory domain administrator.
         
        string password = 11 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPasswordBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for password.
      • getBackupOperatorsList

        public com.google.protobuf.ProtocolStringList getBackupOperatorsList()
         Users to be added to the Built-in Backup Operator active directory group.
         
        repeated string backup_operators = 12;
        Specified by:
        getBackupOperatorsList in interface ActiveDirectoryOrBuilder
        Returns:
        A list containing the backupOperators.
      • getBackupOperatorsCount

        public int getBackupOperatorsCount()
         Users to be added to the Built-in Backup Operator active directory group.
         
        repeated string backup_operators = 12;
        Specified by:
        getBackupOperatorsCount in interface ActiveDirectoryOrBuilder
        Returns:
        The count of backupOperators.
      • getBackupOperators

        public String getBackupOperators​(int index)
         Users to be added to the Built-in Backup Operator active directory group.
         
        repeated string backup_operators = 12;
        Specified by:
        getBackupOperators in interface ActiveDirectoryOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The backupOperators at the given index.
      • getBackupOperatorsBytes

        public com.google.protobuf.ByteString getBackupOperatorsBytes​(int index)
         Users to be added to the Built-in Backup Operator active directory group.
         
        repeated string backup_operators = 12;
        Specified by:
        getBackupOperatorsBytes in interface ActiveDirectoryOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the backupOperators at the given index.
      • getSecurityOperatorsList

        public com.google.protobuf.ProtocolStringList getSecurityOperatorsList()
         Domain users to be given the SeSecurityPrivilege.
         
        repeated string security_operators = 13;
        Specified by:
        getSecurityOperatorsList in interface ActiveDirectoryOrBuilder
        Returns:
        A list containing the securityOperators.
      • getSecurityOperatorsCount

        public int getSecurityOperatorsCount()
         Domain users to be given the SeSecurityPrivilege.
         
        repeated string security_operators = 13;
        Specified by:
        getSecurityOperatorsCount in interface ActiveDirectoryOrBuilder
        Returns:
        The count of securityOperators.
      • getSecurityOperators

        public String getSecurityOperators​(int index)
         Domain users to be given the SeSecurityPrivilege.
         
        repeated string security_operators = 13;
        Specified by:
        getSecurityOperators in interface ActiveDirectoryOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The securityOperators at the given index.
      • getSecurityOperatorsBytes

        public com.google.protobuf.ByteString getSecurityOperatorsBytes​(int index)
         Domain users to be given the SeSecurityPrivilege.
         
        repeated string security_operators = 13;
        Specified by:
        getSecurityOperatorsBytes in interface ActiveDirectoryOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the securityOperators at the given index.
      • getKdcHostname

        public String getKdcHostname()
         Name of the active directory machine. This optional parameter is used only
         while creating kerberos volume
         
        string kdc_hostname = 14;
        Specified by:
        getKdcHostname in interface ActiveDirectoryOrBuilder
        Returns:
        The kdcHostname.
      • getKdcHostnameBytes

        public com.google.protobuf.ByteString getKdcHostnameBytes()
         Name of the active directory machine. This optional parameter is used only
         while creating kerberos volume
         
        string kdc_hostname = 14;
        Specified by:
        getKdcHostnameBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for kdcHostname.
      • getKdcIp

        public String getKdcIp()
         KDC server IP address for the active directory machine.
         
        string kdc_ip = 15;
        Specified by:
        getKdcIp in interface ActiveDirectoryOrBuilder
        Returns:
        The kdcIp.
      • getKdcIpBytes

        public com.google.protobuf.ByteString getKdcIpBytes()
         KDC server IP address for the active directory machine.
         
        string kdc_ip = 15;
        Specified by:
        getKdcIpBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for kdcIp.
      • 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;
        Specified by:
        getNfsUsersWithLdap in interface ActiveDirectoryOrBuilder
        Returns:
        The nfsUsersWithLdap.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of the active directory.
         
        string description = 17;
        Specified by:
        getDescriptionBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for description.
      • getLdapSigning

        public boolean getLdapSigning()
         Specifies whether or not the LDAP traffic needs to be signed.
         
        bool ldap_signing = 18;
        Specified by:
        getLdapSigning in interface ActiveDirectoryOrBuilder
        Returns:
        The ldapSigning.
      • getEncryptDcConnections

        public boolean getEncryptDcConnections()
         If enabled, traffic between the SMB server to Domain Controller (DC) will
         be encrypted.
         
        bool encrypt_dc_connections = 19;
        Specified by:
        getEncryptDcConnections in interface ActiveDirectoryOrBuilder
        Returns:
        The encryptDcConnections.
      • getStateDetails

        public String getStateDetails()
         Output only. The state details of the Active Directory.
         
        string state_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateDetails in interface ActiveDirectoryOrBuilder
        Returns:
        The stateDetails.
      • getStateDetailsBytes

        public com.google.protobuf.ByteString getStateDetailsBytes()
         Output only. The state details of the Active Directory.
         
        string state_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateDetailsBytes in interface ActiveDirectoryOrBuilder
        Returns:
        The bytes for stateDetails.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static ActiveDirectory parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ActiveDirectory parseFrom​(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ActiveDirectory parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ActiveDirectory parseFrom​(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ActiveDirectory parseFrom​(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ActiveDirectory parseFrom​(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ActiveDirectory parseFrom​(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException
        Throws:
        IOException
      • newBuilderForType

        public ActiveDirectory.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public ActiveDirectory.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected ActiveDirectory.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • parser

        public static com.google.protobuf.Parser<ActiveDirectory> parser()
      • getParserForType

        public com.google.protobuf.Parser<ActiveDirectory> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public ActiveDirectory getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder