/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/netapp/v1/active_directory.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.netapp.v1;
public interface ActiveDirectoryOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.netapp.v1.ActiveDirectory)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Identifier. 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) = IDENTIFIER];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Identifier. 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) = IDENTIFIER];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. Create time of the active directory.
*
*
* .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Create time of the active directory.
*
*
* .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The state of the AD.
*
*
*
* .google.cloud.netapp.v1.ActiveDirectory.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The state of the AD.
*
*
*
* .google.cloud.netapp.v1.ActiveDirectory.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.netapp.v1.ActiveDirectory.State getState();
/**
*
*
*
* Required. Name of the Active Directory domain
*
*
* string domain = 4 [(.google.api.field_behavior) = REQUIRED];
*
* @return The domain.
*/
java.lang.String getDomain();
/**
*
*
*
* Required. Name of the Active Directory domain
*
*
* string domain = 4 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for domain.
*/
com.google.protobuf.ByteString getDomainBytes();
/**
*
*
*
* The Active Directory site the service will limit Domain Controller
* discovery too.
*
*
* string site = 5;
*
* @return The site.
*/
java.lang.String getSite();
/**
*
*
*
* The Active Directory site the service will limit Domain Controller
* discovery too.
*
*
* string site = 5;
*
* @return The bytes for site.
*/
com.google.protobuf.ByteString getSiteBytes();
/**
*
*
*
* Required. Comma separated list of DNS server IP addresses for the Active
* Directory domain.
*
*
* string dns = 6 [(.google.api.field_behavior) = REQUIRED];
*
* @return The dns.
*/
java.lang.String getDns();
/**
*
*
*
* Required. Comma separated list of DNS server IP addresses for the Active
* Directory domain.
*
*
* string dns = 6 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for dns.
*/
com.google.protobuf.ByteString getDnsBytes();
/**
*
*
*
* Required. NetBIOSPrefix is used as a prefix for SMB server name.
*
*
* string net_bios_prefix = 7 [(.google.api.field_behavior) = REQUIRED];
*
* @return The netBiosPrefix.
*/
java.lang.String getNetBiosPrefix();
/**
*
*
*
* Required. NetBIOSPrefix is used as a prefix for SMB server name.
*
*
* string net_bios_prefix = 7 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for netBiosPrefix.
*/
com.google.protobuf.ByteString getNetBiosPrefixBytes();
/**
*
*
*
* The Organizational Unit (OU) within the Windows Active Directory the user
* belongs to.
*
*
* string organizational_unit = 8;
*
* @return The organizationalUnit.
*/
java.lang.String getOrganizationalUnit();
/**
*
*
*
* The Organizational Unit (OU) within the Windows Active Directory the user
* belongs to.
*
*
* string organizational_unit = 8;
*
* @return The bytes for organizationalUnit.
*/
com.google.protobuf.ByteString getOrganizationalUnitBytes();
/**
*
*
*
* If enabled, AES encryption will be enabled for SMB communication.
*
*
* bool aes_encryption = 9;
*
* @return The aesEncryption.
*/
boolean getAesEncryption();
/**
*
*
*
* Required. Username of the Active Directory domain administrator.
*
*
* string username = 10 [(.google.api.field_behavior) = REQUIRED];
*
* @return The username.
*/
java.lang.String getUsername();
/**
*
*
*
* Required. Username of the Active Directory domain administrator.
*
*
* string username = 10 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for username.
*/
com.google.protobuf.ByteString getUsernameBytes();
/**
*
*
*
* Required. Password of the Active Directory domain administrator.
*
*
* string password = 11 [(.google.api.field_behavior) = REQUIRED];
*
* @return The password.
*/
java.lang.String getPassword();
/**
*
*
*
* Required. Password of the Active Directory domain administrator.
*
*
* string password = 11 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for password.
*/
com.google.protobuf.ByteString getPasswordBytes();
/**
*
*
*
* Optional. Users to be added to the Built-in Backup Operator active
* directory group.
*
*
* repeated string backup_operators = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return A list containing the backupOperators.
*/
java.util.List getBackupOperatorsList();
/**
*
*
*
* Optional. Users to be added to the Built-in Backup Operator active
* directory group.
*
*
* repeated string backup_operators = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The count of backupOperators.
*/
int getBackupOperatorsCount();
/**
*
*
*
* Optional. Users to be added to the Built-in Backup Operator active
* directory group.
*
*
* repeated string backup_operators = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the element to return.
* @return The backupOperators at the given index.
*/
java.lang.String getBackupOperators(int index);
/**
*
*
*
* Optional. Users to be added to the Built-in Backup Operator active
* directory group.
*
*
* repeated string backup_operators = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the value to return.
* @return The bytes of the backupOperators at the given index.
*/
com.google.protobuf.ByteString getBackupOperatorsBytes(int index);
/**
*
*
*
* Optional. Users to be added to the Built-in Admininstrators group.
*
*
* repeated string administrators = 22 [(.google.api.field_behavior) = OPTIONAL];
*
* @return A list containing the administrators.
*/
java.util.List getAdministratorsList();
/**
*
*
*
* Optional. Users to be added to the Built-in Admininstrators group.
*
*
* repeated string administrators = 22 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The count of administrators.
*/
int getAdministratorsCount();
/**
*
*
*
* Optional. Users to be added to the Built-in Admininstrators group.
*
*
* repeated string administrators = 22 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the element to return.
* @return The administrators at the given index.
*/
java.lang.String getAdministrators(int index);
/**
*
*
*
* Optional. Users to be added to the Built-in Admininstrators group.
*
*
* repeated string administrators = 22 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the value to return.
* @return The bytes of the administrators at the given index.
*/
com.google.protobuf.ByteString getAdministratorsBytes(int index);
/**
*
*
*
* Optional. Domain users to be given the SeSecurityPrivilege.
*
*
* repeated string security_operators = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @return A list containing the securityOperators.
*/
java.util.List getSecurityOperatorsList();
/**
*
*
*
* Optional. Domain users to be given the SeSecurityPrivilege.
*
*
* repeated string security_operators = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The count of securityOperators.
*/
int getSecurityOperatorsCount();
/**
*
*
*
* Optional. Domain users to be given the SeSecurityPrivilege.
*
*
* repeated string security_operators = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the element to return.
* @return The securityOperators at the given index.
*/
java.lang.String getSecurityOperators(int index);
/**
*
*
*
* Optional. Domain users to be given the SeSecurityPrivilege.
*
*
* repeated string security_operators = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the value to return.
* @return The bytes of the securityOperators at the given index.
*/
com.google.protobuf.ByteString getSecurityOperatorsBytes(int index);
/**
*
*
*
* Name of the active directory machine. This optional parameter is used only
* while creating kerberos volume
*
*
* string kdc_hostname = 14;
*
* @return The kdcHostname.
*/
java.lang.String getKdcHostname();
/**
*
*
*
* Name of the active directory machine. This optional parameter is used only
* while creating kerberos volume
*
*
* string kdc_hostname = 14;
*
* @return The bytes for kdcHostname.
*/
com.google.protobuf.ByteString getKdcHostnameBytes();
/**
*
*
*
* KDC server IP address for the active directory machine.
*
*
* string kdc_ip = 15;
*
* @return The kdcIp.
*/
java.lang.String getKdcIp();
/**
*
*
*
* KDC server IP address for the active directory machine.
*
*
* string kdc_ip = 15;
*
* @return The bytes for kdcIp.
*/
com.google.protobuf.ByteString getKdcIpBytes();
/**
*
*
*
* 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;
*
* @return The nfsUsersWithLdap.
*/
boolean getNfsUsersWithLdap();
/**
*
*
*
* Description of the active directory.
*
*
* string description = 17;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Description of the active directory.
*
*
* string description = 17;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Specifies whether or not the LDAP traffic needs to be signed.
*
*
* bool ldap_signing = 18;
*
* @return The ldapSigning.
*/
boolean getLdapSigning();
/**
*
*
*
* If enabled, traffic between the SMB server to Domain Controller (DC) will
* be encrypted.
*
*
* bool encrypt_dc_connections = 19;
*
* @return The encryptDcConnections.
*/
boolean getEncryptDcConnections();
/**
*
*
*
* Labels for the active directory.
*
*
* map<string, string> labels = 20;
*/
int getLabelsCount();
/**
*
*
*
* Labels for the active directory.
*
*
* map<string, string> labels = 20;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Labels for the active directory.
*
*
* map<string, string> labels = 20;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Labels for the active directory.
*
*
* map<string, string> labels = 20;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Labels for the active directory.
*
*
* map<string, string> labels = 20;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. The state details of the Active Directory.
*
*
* string state_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The stateDetails.
*/
java.lang.String getStateDetails();
/**
*
*
*
* Output only. The state details of the Active Directory.
*
*
* string state_details = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for stateDetails.
*/
com.google.protobuf.ByteString getStateDetailsBytes();
}
