Package com.google.cloud.managedidentities.v1

Class Domain

  • All Implemented Interfaces:
    DomainOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Domain
extends com.google.protobuf.GeneratedMessageV3
implements DomainOrBuilder
     Represents a managed Microsoft Active Directory domain.
    Protobuf type google.cloud.managedidentities.v1.Domain
    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()
         Required. The unique name of the domain using the form:
 `projects/{project_id}/locations/global/domains/{domain_name}`.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface DomainOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The unique name of the domain using the form:
 `projects/{project_id}/locations/global/domains/{domain_name}`.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface DomainOrBuilder
        Returns:
        The bytes for name.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: DomainOrBuilder
         Optional. Resource labels that can contain user-provided metadata.
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface DomainOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. Resource labels that can contain user-provided metadata.
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface DomainOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. Resource labels that can contain user-provided metadata.
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface DomainOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. Resource labels that can contain user-provided metadata.
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface DomainOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. Resource labels that can contain user-provided metadata.
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface DomainOrBuilder

      • getAuthorizedNetworksList

        public com.google.protobuf.ProtocolStringList getAuthorizedNetworksList()
         Optional. The full names of the Google Compute Engine
 [networks](/compute/docs/networks-and-firewalls#networks) the domain
 instance is connected to. Networks can be added using UpdateDomain.
 The domain is only available on networks listed in `authorized_networks`.
 If CIDR subnets overlap between networks, domain creation will fail.
        repeated string authorized_networks = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthorizedNetworksList in interface DomainOrBuilder
        Returns:
        A list containing the authorizedNetworks.

      • getAuthorizedNetworksCount

        public int getAuthorizedNetworksCount()
         Optional. The full names of the Google Compute Engine
 [networks](/compute/docs/networks-and-firewalls#networks) the domain
 instance is connected to. Networks can be added using UpdateDomain.
 The domain is only available on networks listed in `authorized_networks`.
 If CIDR subnets overlap between networks, domain creation will fail.
        repeated string authorized_networks = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthorizedNetworksCount in interface DomainOrBuilder
        Returns:
        The count of authorizedNetworks.

      • getAuthorizedNetworks

        public String getAuthorizedNetworks​(int index)
         Optional. The full names of the Google Compute Engine
 [networks](/compute/docs/networks-and-firewalls#networks) the domain
 instance is connected to. Networks can be added using UpdateDomain.
 The domain is only available on networks listed in `authorized_networks`.
 If CIDR subnets overlap between networks, domain creation will fail.
        repeated string authorized_networks = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthorizedNetworks in interface DomainOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The authorizedNetworks at the given index.

      • getAuthorizedNetworksBytes

        public com.google.protobuf.ByteString getAuthorizedNetworksBytes​(int index)
         Optional. The full names of the Google Compute Engine
 [networks](/compute/docs/networks-and-firewalls#networks) the domain
 instance is connected to. Networks can be added using UpdateDomain.
 The domain is only available on networks listed in `authorized_networks`.
 If CIDR subnets overlap between networks, domain creation will fail.
        repeated string authorized_networks = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthorizedNetworksBytes in interface DomainOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the authorizedNetworks at the given index.

      • getReservedIpRange

        public String getReservedIpRange()
         Required. The CIDR range of internal addresses that are reserved for this
 domain. Reserved networks must be /24 or larger. Ranges must be
 unique and non-overlapping with existing subnets in
 [Domain].[authorized_networks].
        string reserved_ip_range = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getReservedIpRange in interface DomainOrBuilder
        Returns:
        The reservedIpRange.

      • getReservedIpRangeBytes

        public com.google.protobuf.ByteString getReservedIpRangeBytes()
         Required. The CIDR range of internal addresses that are reserved for this
 domain. Reserved networks must be /24 or larger. Ranges must be
 unique and non-overlapping with existing subnets in
 [Domain].[authorized_networks].
        string reserved_ip_range = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getReservedIpRangeBytes in interface DomainOrBuilder
        Returns:
        The bytes for reservedIpRange.

      • getLocationsList

        public com.google.protobuf.ProtocolStringList getLocationsList()
         Required. Locations where domain needs to be provisioned.
 [regions][compute/docs/regions-zones/]
 e.g. us-west1 or us-east4
 Service supports up to 4 locations at once. Each location will use a /26
 block.
        repeated string locations = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLocationsList in interface DomainOrBuilder
        Returns:
        A list containing the locations.

      • getLocationsCount

        public int getLocationsCount()
         Required. Locations where domain needs to be provisioned.
 [regions][compute/docs/regions-zones/]
 e.g. us-west1 or us-east4
 Service supports up to 4 locations at once. Each location will use a /26
 block.
        repeated string locations = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLocationsCount in interface DomainOrBuilder
        Returns:
        The count of locations.

      • getLocations

        public String getLocations​(int index)
         Required. Locations where domain needs to be provisioned.
 [regions][compute/docs/regions-zones/]
 e.g. us-west1 or us-east4
 Service supports up to 4 locations at once. Each location will use a /26
 block.
        repeated string locations = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLocations in interface DomainOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The locations at the given index.

      • getLocationsBytes

        public com.google.protobuf.ByteString getLocationsBytes​(int index)
         Required. Locations where domain needs to be provisioned.
 [regions][compute/docs/regions-zones/]
 e.g. us-west1 or us-east4
 Service supports up to 4 locations at once. Each location will use a /26
 block.
        repeated string locations = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLocationsBytes in interface DomainOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the locations at the given index.

      • getAdmin

        public String getAdmin()
         Optional. The name of delegated administrator account used to perform
 Active Directory operations. If not specified, `setupadmin` will be used.
        string admin = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAdmin in interface DomainOrBuilder
        Returns:
        The admin.

      • getAdminBytes

        public com.google.protobuf.ByteString getAdminBytes()
         Optional. The name of delegated administrator account used to perform
 Active Directory operations. If not specified, `setupadmin` will be used.
        string admin = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAdminBytes in interface DomainOrBuilder
        Returns:
        The bytes for admin.

      • getFqdn

        public String getFqdn()
         Output only. The fully-qualified domain name of the exposed domain used by
 clients to connect to the service. Similar to what would be chosen for an
 Active Directory set up on an internal network.
        string fqdn = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFqdn in interface DomainOrBuilder
        Returns:
        The fqdn.

      • getFqdnBytes

        public com.google.protobuf.ByteString getFqdnBytes()
         Output only. The fully-qualified domain name of the exposed domain used by
 clients to connect to the service. Similar to what would be chosen for an
 Active Directory set up on an internal network.
        string fqdn = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFqdnBytes in interface DomainOrBuilder
        Returns:
        The bytes for fqdn.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface DomainOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface DomainOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface DomainOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The last update time.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface DomainOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The last update time.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface DomainOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The last update time.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface DomainOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The current state of this domain.
        .google.cloud.managedidentities.v1.Domain.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface DomainOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Domain.State getState()
         Output only. The current state of this domain.
        .google.cloud.managedidentities.v1.Domain.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface DomainOrBuilder
        Returns:
        The state.

      • getStatusMessage

        public String getStatusMessage()
         Output only. Additional information about the current status of this
 domain, if available.
        string status_message = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusMessage in interface DomainOrBuilder
        Returns:
        The statusMessage.

      • getStatusMessageBytes

        public com.google.protobuf.ByteString getStatusMessageBytes()
         Output only. Additional information about the current status of this
 domain, if available.
        string status_message = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusMessageBytes in interface DomainOrBuilder
        Returns:
        The bytes for statusMessage.

      • getTrustsList

        public List<Trust> getTrustsList()
         Output only. The current trusts associated with the domain.
        repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrustsList in interface DomainOrBuilder

      • getTrustsOrBuilderList

        public List<? extends TrustOrBuilder> getTrustsOrBuilderList()
         Output only. The current trusts associated with the domain.
        repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrustsOrBuilderList in interface DomainOrBuilder

      • getTrustsCount

        public int getTrustsCount()
         Output only. The current trusts associated with the domain.
        repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrustsCount in interface DomainOrBuilder

      • getTrusts

        public Trust getTrusts​(int index)
         Output only. The current trusts associated with the domain.
        repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrusts in interface DomainOrBuilder

      • getTrustsOrBuilder

        public TrustOrBuilder getTrustsOrBuilder​(int index)
         Output only. The current trusts associated with the domain.
        repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrustsOrBuilder in interface DomainOrBuilder

      • 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 Domain parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Domain getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Domain> parser()

      • getParserForType

        public com.google.protobuf.Parser<Domain> 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 Domain getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder