com.google.cloud.managedidentities.v1

Interface DomainOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Domain, Domain.Builder

public interface DomainOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
String	getAdmin() Optional.
com.google.protobuf.ByteString	getAdminBytes() Optional.
String	getAuthorizedNetworks(int index) Optional.
com.google.protobuf.ByteString	getAuthorizedNetworksBytes(int index) Optional.
int	getAuthorizedNetworksCount() Optional.
List<String>	getAuthorizedNetworksList() Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getFqdn() Output only.
com.google.protobuf.ByteString	getFqdnBytes() Output only.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getLocations(int index) Required.
com.google.protobuf.ByteString	getLocationsBytes(int index) Required.
int	getLocationsCount() Required.
List<String>	getLocationsList() Required.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getReservedIpRange() Required.
com.google.protobuf.ByteString	getReservedIpRangeBytes() Required.
Domain.State	getState() Output only.
int	getStateValue() Output only.
String	getStatusMessage() Output only.
com.google.protobuf.ByteString	getStatusMessageBytes() Output only.
Trust	getTrusts(int index) Output only.
int	getTrustsCount() Output only.
List<Trust>	getTrustsList() Output only.
TrustOrBuilder	getTrustsOrBuilder(int index) Output only.
List<? extends TrustOrBuilder>	getTrustsOrBuilderList() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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

Returns:

The bytes for name.

getLabelsCount

int getLabelsCount()

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

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

containsLabels

boolean containsLabels(String key)

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

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

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

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

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

getLabelsOrDefault

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

getLabelsOrThrow

String getLabelsOrThrow(String key)

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

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

getAuthorizedNetworksList

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

Returns:

A list containing the authorizedNetworks.

getAuthorizedNetworksCount

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

Returns:

The count of authorizedNetworks.

getAuthorizedNetworks

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

Parameters:

index - The index of the element to return.

Returns:

The authorizedNetworks at the given index.

getAuthorizedNetworksBytes

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the authorizedNetworks at the given index.

getReservedIpRange

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:

The reservedIpRange.

getReservedIpRangeBytes

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

Returns:

The bytes for reservedIpRange.

getLocationsList

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

Returns:

A list containing the locations.

getLocationsCount

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

Returns:

The count of locations.

getLocations

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

Parameters:

index - The index of the element to return.

Returns:

The locations at the given index.

getLocationsBytes

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the locations at the given index.

getAdmin

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:

The admin.

getAdminBytes

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

Returns:

The bytes for admin.

getFqdn

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:

The fqdn.

getFqdnBytes

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

Returns:

The bytes for fqdn.

hasCreateTime

boolean hasCreateTime()

 Output only. The time the instance was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

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

Returns:

The createTime.

getCreateTimeOrBuilder

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

hasUpdateTime

boolean hasUpdateTime()

 Output only. The last update time.
 

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

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. The last update time.
 

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. The last update time.
 

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

getStateValue

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:

The enum numeric value on the wire for state.

getState

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:

The state.

getStatusMessage

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:

The statusMessage.

getStatusMessageBytes

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

Returns:

The bytes for statusMessage.

getTrustsList

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

getTrusts

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

getTrustsCount

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

getTrustsOrBuilderList

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

getTrustsOrBuilder

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