Interface ManagementServerOrBuilder (0.5.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface ManagementServerOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
publicabstractbooleancontainsLabels(Stringkey)Optional. Resource labels to represent user provided metadata. Labels currently defined:
- migrate_from_go=<false|true> If set to true, the MS is created in migration ready mode.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBaProxyUri(int index)
publicabstractStringgetBaProxyUri(intindex)Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
repeated string ba_proxy_uri = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The baProxyUri at the given index. |
getBaProxyUriBytes(int index)
publicabstractByteStringgetBaProxyUriBytes(intindex)Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
repeated string ba_proxy_uri = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the baProxyUri at the given index. |
getBaProxyUriCount()
publicabstractintgetBaProxyUriCount()Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
repeated string ba_proxy_uri = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The count of baProxyUri. |
getBaProxyUriList()
publicabstractList<String>getBaProxyUriList()Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
repeated string ba_proxy_uri = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the baProxyUri. |
getCreateTime()
publicabstractTimestampgetCreateTime()Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
publicabstractTimestampOrBuildergetCreateTimeOrBuilder()Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDescription()
publicabstractStringgetDescription()Optional. The description of the ManagementServer instance (2048 characters or less).
string description = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
publicabstractByteStringgetDescriptionBytes()Optional. The description of the ManagementServer instance (2048 characters or less).
string description = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getEtag()
publicabstractStringgetEtag()Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
string etag = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
publicabstractByteStringgetEtagBytes()Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
string etag = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
getLabels() (deprecated)
publicabstractMap<String,String>getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
publicabstractintgetLabelsCount()Optional. Resource labels to represent user provided metadata. Labels currently defined:
- migrate_from_go=<false|true> If set to true, the MS is created in migration ready mode.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
publicabstractMap<String,String>getLabelsMap()Optional. Resource labels to represent user provided metadata. Labels currently defined:
- migrate_from_go=<false|true> If set to true, the MS is created in migration ready mode.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
publicabstractStringgetLabelsOrDefault(Stringkey,StringdefaultValue)Optional. Resource labels to represent user provided metadata. Labels currently defined:
- migrate_from_go=<false|true> If set to true, the MS is created in migration ready mode.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
publicabstractStringgetLabelsOrThrow(Stringkey)Optional. Resource labels to represent user provided metadata. Labels currently defined:
- migrate_from_go=<false|true> If set to true, the MS is created in migration ready mode.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getManagementUri()
publicabstractManagementURIgetManagementUri()Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
.google.cloud.backupdr.v1.ManagementURI management_uri = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ManagementURI |
The managementUri. |
getManagementUriOrBuilder()
publicabstractManagementURIOrBuildergetManagementUriOrBuilder()Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
.google.cloud.backupdr.v1.ManagementURI management_uri = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ManagementURIOrBuilder |
|
getName()
publicabstractStringgetName()Output only. Identifier. The resource name.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
publicabstractByteStringgetNameBytes()Output only. Identifier. The resource name.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNetworks(int index)
publicabstractNetworkConfiggetNetworks(intindex)Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported.
repeated .google.cloud.backupdr.v1.NetworkConfig networks = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
NetworkConfig |
|
getNetworksCount()
publicabstractintgetNetworksCount()Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported.
repeated .google.cloud.backupdr.v1.NetworkConfig networks = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
|
getNetworksList()
publicabstractList<NetworkConfig>getNetworksList()Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported.
repeated .google.cloud.backupdr.v1.NetworkConfig networks = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<NetworkConfig> |
|
getNetworksOrBuilder(int index)
publicabstractNetworkConfigOrBuildergetNetworksOrBuilder(intindex)Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported.
repeated .google.cloud.backupdr.v1.NetworkConfig networks = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
NetworkConfigOrBuilder |
|
getNetworksOrBuilderList()
publicabstractList<?extendsNetworkConfigOrBuilder>getNetworksOrBuilderList()Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported.
repeated .google.cloud.backupdr.v1.NetworkConfig networks = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.backupdr.v1.NetworkConfigOrBuilder> |
|
getOauth2ClientId()
publicabstractStringgetOauth2ClientId()Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).
string oauth2_client_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The oauth2ClientId. |
getOauth2ClientIdBytes()
publicabstractByteStringgetOauth2ClientIdBytes()Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).
string oauth2_client_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for oauth2ClientId. |
getSatisfiesPzi()
publicabstractbooleangetSatisfiesPzi()Output only. Reserved for future use.
bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzi. |
getSatisfiesPzs()
publicabstractBoolValuegetSatisfiesPzs()Output only. Reserved for future use.
.google.protobuf.BoolValue satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
BoolValue |
The satisfiesPzs. |
getSatisfiesPzsOrBuilder()
publicabstractBoolValueOrBuildergetSatisfiesPzsOrBuilder()Output only. Reserved for future use.
.google.protobuf.BoolValue satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
BoolValueOrBuilder |
|
getState()
publicabstractManagementServer.InstanceStategetState()Output only. The ManagementServer state.
.google.cloud.backupdr.v1.ManagementServer.InstanceState state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ManagementServer.InstanceState |
The state. |
getStateValue()
publicabstractintgetStateValue()Output only. The ManagementServer state.
.google.cloud.backupdr.v1.ManagementServer.InstanceState state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getType()
publicabstractManagementServer.InstanceTypegetType()Optional. The type of the ManagementServer resource.
.google.cloud.backupdr.v1.ManagementServer.InstanceType type = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ManagementServer.InstanceType |
The type. |
getTypeValue()
publicabstractintgetTypeValue()Optional. The type of the ManagementServer resource.
.google.cloud.backupdr.v1.ManagementServer.InstanceType type = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
getUpdateTime()
publicabstractTimestampgetUpdateTime()Output only. The time when the instance was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()Output only. The time when the instance was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getWorkforceIdentityBasedManagementUri()
publicabstractWorkforceIdentityBasedManagementURIgetWorkforceIdentityBasedManagementUri()Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
.google.cloud.backupdr.v1.WorkforceIdentityBasedManagementURI workforce_identity_based_management_uri = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkforceIdentityBasedManagementURI |
The workforceIdentityBasedManagementUri. |
getWorkforceIdentityBasedManagementUriOrBuilder()
publicabstractWorkforceIdentityBasedManagementURIOrBuildergetWorkforceIdentityBasedManagementUriOrBuilder()Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
.google.cloud.backupdr.v1.WorkforceIdentityBasedManagementURI workforce_identity_based_management_uri = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkforceIdentityBasedManagementURIOrBuilder |
|
getWorkforceIdentityBasedOauth2ClientId()
publicabstractWorkforceIdentityBasedOAuth2ClientIDgetWorkforceIdentityBasedOauth2ClientId()Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
.google.cloud.backupdr.v1.WorkforceIdentityBasedOAuth2ClientID workforce_identity_based_oauth2_client_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkforceIdentityBasedOAuth2ClientID |
The workforceIdentityBasedOauth2ClientId. |
getWorkforceIdentityBasedOauth2ClientIdOrBuilder()
publicabstractWorkforceIdentityBasedOAuth2ClientIDOrBuildergetWorkforceIdentityBasedOauth2ClientIdOrBuilder()Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
.google.cloud.backupdr.v1.WorkforceIdentityBasedOAuth2ClientID workforce_identity_based_oauth2_client_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkforceIdentityBasedOAuth2ClientIDOrBuilder |
|
hasCreateTime()
publicabstractbooleanhasCreateTime()Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasManagementUri()
publicabstractbooleanhasManagementUri()Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
.google.cloud.backupdr.v1.ManagementURI management_uri = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the managementUri field is set. |
hasSatisfiesPzs()
publicabstractbooleanhasSatisfiesPzs()Output only. Reserved for future use.
.google.protobuf.BoolValue satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the satisfiesPzs field is set. |
hasUpdateTime()
publicabstractbooleanhasUpdateTime()Output only. The time when the instance was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
hasWorkforceIdentityBasedManagementUri()
publicabstractbooleanhasWorkforceIdentityBasedManagementUri()Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
.google.cloud.backupdr.v1.WorkforceIdentityBasedManagementURI workforce_identity_based_management_uri = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the workforceIdentityBasedManagementUri field is set. |
hasWorkforceIdentityBasedOauth2ClientId()
publicabstractbooleanhasWorkforceIdentityBasedOauth2ClientId()Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
.google.cloud.backupdr.v1.WorkforceIdentityBasedOAuth2ClientID workforce_identity_based_oauth2_client_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the workforceIdentityBasedOauth2ClientId field is set. |