Class CacheUsernameDownloadSettings
java.lang.Object
com.azure.resourcemanager.storagecache.models.CacheUsernameDownloadSettings
Settings for Extended Groups username and group download.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the autoDownloadCertificate property: Determines if the certificate should be automatically downloaded.Get the caCertificateUri property: The URI of the CA certificate to validate the LDAP secure connection.Get the credentials property: When present, these are the credentials for the secure LDAP connection.Get the encryptLdapConnection property: Whether or not the LDAP connection should be encrypted.Get the extendedGroups property: Whether or not Extended Groups is enabled.Get the groupFileUri property: The URI of the file containing group information (in /etc/group file format).Get the ldapBaseDN property: The base distinguished name for the LDAP domain.Get the ldapServer property: The fully qualified domain name or IP address of the LDAP server to use.Get the requireValidCertificate property: Determines if the certificates must be validated by a certificate authority.Get the userFileUri property: The URI of the file containing user information (in /etc/passwd file format).Get the usernameDownloaded property: Indicates whether or not the HPC Cache has performed the username download successfully.Get the usernameSource property: This setting determines how the cache gets username and group names for clients.void
validate()
Validates the instance.withAutoDownloadCertificate
(Boolean autoDownloadCertificate) Set the autoDownloadCertificate property: Determines if the certificate should be automatically downloaded.withCaCertificateUri
(String caCertificateUri) Set the caCertificateUri property: The URI of the CA certificate to validate the LDAP secure connection.withCredentials
(CacheUsernameDownloadSettingsCredentials credentials) Set the credentials property: When present, these are the credentials for the secure LDAP connection.withEncryptLdapConnection
(Boolean encryptLdapConnection) Set the encryptLdapConnection property: Whether or not the LDAP connection should be encrypted.withExtendedGroups
(Boolean extendedGroups) Set the extendedGroups property: Whether or not Extended Groups is enabled.withGroupFileUri
(String groupFileUri) Set the groupFileUri property: The URI of the file containing group information (in /etc/group file format).withLdapBaseDN
(String ldapBaseDN) Set the ldapBaseDN property: The base distinguished name for the LDAP domain.withLdapServer
(String ldapServer) Set the ldapServer property: The fully qualified domain name or IP address of the LDAP server to use.withRequireValidCertificate
(Boolean requireValidCertificate) Set the requireValidCertificate property: Determines if the certificates must be validated by a certificate authority.withUserFileUri
(String userFileUri) Set the userFileUri property: The URI of the file containing user information (in /etc/passwd file format).withUsernameSource
(UsernameSource usernameSource) Set the usernameSource property: This setting determines how the cache gets username and group names for clients.
-
Constructor Details
-
CacheUsernameDownloadSettings
public CacheUsernameDownloadSettings()
-
-
Method Details
-
extendedGroups
Get the extendedGroups property: Whether or not Extended Groups is enabled.- Returns:
- the extendedGroups value.
-
withExtendedGroups
Set the extendedGroups property: Whether or not Extended Groups is enabled.- Parameters:
extendedGroups
- the extendedGroups value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
usernameSource
Get the usernameSource property: This setting determines how the cache gets username and group names for clients.- Returns:
- the usernameSource value.
-
withUsernameSource
Set the usernameSource property: This setting determines how the cache gets username and group names for clients.- Parameters:
usernameSource
- the usernameSource value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
groupFileUri
Get the groupFileUri property: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.- Returns:
- the groupFileUri value.
-
withGroupFileUri
Set the groupFileUri property: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.- Parameters:
groupFileUri
- the groupFileUri value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
userFileUri
Get the userFileUri property: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.- Returns:
- the userFileUri value.
-
withUserFileUri
Set the userFileUri property: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.- Parameters:
userFileUri
- the userFileUri value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
ldapServer
Get the ldapServer property: The fully qualified domain name or IP address of the LDAP server to use.- Returns:
- the ldapServer value.
-
withLdapServer
Set the ldapServer property: The fully qualified domain name or IP address of the LDAP server to use.- Parameters:
ldapServer
- the ldapServer value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
ldapBaseDN
Get the ldapBaseDN property: The base distinguished name for the LDAP domain.- Returns:
- the ldapBaseDN value.
-
withLdapBaseDN
Set the ldapBaseDN property: The base distinguished name for the LDAP domain.- Parameters:
ldapBaseDN
- the ldapBaseDN value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
encryptLdapConnection
Get the encryptLdapConnection property: Whether or not the LDAP connection should be encrypted.- Returns:
- the encryptLdapConnection value.
-
withEncryptLdapConnection
Set the encryptLdapConnection property: Whether or not the LDAP connection should be encrypted.- Parameters:
encryptLdapConnection
- the encryptLdapConnection value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
requireValidCertificate
Get the requireValidCertificate property: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.- Returns:
- the requireValidCertificate value.
-
withRequireValidCertificate
Set the requireValidCertificate property: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.- Parameters:
requireValidCertificate
- the requireValidCertificate value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
autoDownloadCertificate
Get the autoDownloadCertificate property: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.- Returns:
- the autoDownloadCertificate value.
-
withAutoDownloadCertificate
Set the autoDownloadCertificate property: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.- Parameters:
autoDownloadCertificate
- the autoDownloadCertificate value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
caCertificateUri
Get the caCertificateUri property: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.- Returns:
- the caCertificateUri value.
-
withCaCertificateUri
Set the caCertificateUri property: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.- Parameters:
caCertificateUri
- the caCertificateUri value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
usernameDownloaded
Get the usernameDownloaded property: Indicates whether or not the HPC Cache has performed the username download successfully.- Returns:
- the usernameDownloaded value.
-
credentials
Get the credentials property: When present, these are the credentials for the secure LDAP connection.- Returns:
- the credentials value.
-
withCredentials
public CacheUsernameDownloadSettings withCredentials(CacheUsernameDownloadSettingsCredentials credentials) Set the credentials property: When present, these are the credentials for the secure LDAP connection.- Parameters:
credentials
- the credentials value to set.- Returns:
- the CacheUsernameDownloadSettings object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-