Class Domain (1.32.0)

public final class Domain extends GeneratedMessageV3 implements DomainOrBuilder

Represents a managed Microsoft Active Directory domain.

Protobuf type google.cloud.managedidentities.v1.Domain

Implements

DomainOrBuilder

Static Fields

ADMIN_FIELD_NUMBER

public static final int ADMIN_FIELD_NUMBER
Field Value
TypeDescription
int

AUTHORIZED_NETWORKS_FIELD_NUMBER

public static final int AUTHORIZED_NETWORKS_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

FQDN_FIELD_NUMBER

public static final int FQDN_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATIONS_FIELD_NUMBER

public static final int LOCATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RESERVED_IP_RANGE_FIELD_NUMBER

public static final int RESERVED_IP_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_MESSAGE_FIELD_NUMBER

public static final int STATUS_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

TRUSTS_FIELD_NUMBER

public static final int TRUSTS_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Domain getDefaultInstance()
Returns
TypeDescription
Domain

getDescriptor()

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

newBuilder()

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

newBuilder(Domain prototype)

public static Domain.Builder newBuilder(Domain prototype)
Parameter
NameDescription
prototypeDomain
Returns
TypeDescription
Domain.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Resource labels that can contain user-provided metadata.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

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];

Returns
TypeDescription
String

The admin.

getAdminBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for admin.

getAuthorizedNetworks(int index)

public String getAuthorizedNetworks(int index)

Optional. The full names of the Google Compute Engine 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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The authorizedNetworks at the given index.

getAuthorizedNetworksBytes(int index)

public ByteString getAuthorizedNetworksBytes(int index)

Optional. The full names of the Google Compute Engine 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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the authorizedNetworks at the given index.

getAuthorizedNetworksCount()

public int getAuthorizedNetworksCount()

Optional. The full names of the Google Compute Engine 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];

Returns
TypeDescription
int

The count of authorizedNetworks.

getAuthorizedNetworksList()

public ProtocolStringList getAuthorizedNetworksList()

Optional. The full names of the Google Compute Engine 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];

Returns
TypeDescription
ProtocolStringList

A list containing the authorizedNetworks.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the instance was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the instance was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Domain getDefaultInstanceForType()
Returns
TypeDescription
Domain

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];

Returns
TypeDescription
String

The fqdn.

getFqdnBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for fqdn.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Resource labels that can contain user-provided metadata.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

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];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Resource labels that can contain user-provided metadata.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLocations(int index)

public String getLocations(int index)

Required. Locations where domain needs to be provisioned. regions 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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The locations at the given index.

getLocationsBytes(int index)

public ByteString getLocationsBytes(int index)

Required. Locations where domain needs to be provisioned. regions 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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the locations at the given index.

getLocationsCount()

public int getLocationsCount()

Required. Locations where domain needs to be provisioned. regions 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];

Returns
TypeDescription
int

The count of locations.

getLocationsList()

public ProtocolStringList getLocationsList()

Required. Locations where domain needs to be provisioned. regions 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];

Returns
TypeDescription
ProtocolStringList

A list containing the locations.

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];

Returns
TypeDescription
String

The name.

getNameBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

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];

Returns
TypeDescription
String

The reservedIpRange.

getReservedIpRangeBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for reservedIpRange.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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];

Returns
TypeDescription
Domain.State

The state.

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];

Returns
TypeDescription
int

The enum numeric value on the wire for 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];

Returns
TypeDescription
String

The statusMessage.

getStatusMessageBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for statusMessage.

getTrusts(int index)

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
Trust

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];

Returns
TypeDescription
int

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];

Returns
TypeDescription
List<Trust>

getTrustsOrBuilder(int index)

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
TrustOrBuilder

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];

Returns
TypeDescription
List<? extends com.google.cloud.managedidentities.v1.TrustOrBuilder>

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update time.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update time.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the instance was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last update time.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime 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 Domain.Builder newBuilderForType()
Returns
TypeDescription
Domain.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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