Interface ManagementServerOrBuilder (0.3.0)

public interface ManagementServerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Resource labels to represent user provided metadata. Labels currently defined:

  1. 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)

public abstract String getBaProxyUri(int index)

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)

public abstract ByteString getBaProxyUriBytes(int index)

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()

public abstract int getBaProxyUriCount()

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()

public abstract List<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()

public abstract Timestamp getCreateTime()

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()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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()

public abstract String getDescription()

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()

public abstract ByteString getDescriptionBytes()

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()

public abstract String getEtag()

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()

public abstract ByteString getEtagBytes()

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)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Resource labels to represent user provided metadata. Labels currently defined:

  1. 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()

public abstract Map<String,String> getLabelsMap()

Optional. Resource labels to represent user provided metadata. Labels currently defined:

  1. 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)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Resource labels to represent user provided metadata. Labels currently defined:

  1. 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)

public abstract String getLabelsOrThrow(String key)

Optional. Resource labels to represent user provided metadata. Labels currently defined:

  1. 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()

public abstract ManagementURI getManagementUri()

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()

public abstract ManagementURIOrBuilder getManagementUriOrBuilder()

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()

public abstract String getName()

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()

public abstract ByteString getNameBytes()

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)

public abstract NetworkConfig getNetworks(int index)

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()

public abstract int getNetworksCount()

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()

public abstract List<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)

public abstract NetworkConfigOrBuilder getNetworksOrBuilder(int index)

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()

public abstract List<? extends NetworkConfigOrBuilder> 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()

public abstract String getOauth2ClientId()

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()

public abstract ByteString getOauth2ClientIdBytes()

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.

getState()

public abstract ManagementServer.InstanceState getState()

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()

public abstract int getStateValue()

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()

public abstract ManagementServer.InstanceType getType()

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()

public abstract int getTypeValue()

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()

public abstract Timestamp getUpdateTime()

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()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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()

public abstract WorkforceIdentityBasedManagementURI getWorkforceIdentityBasedManagementUri()

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()

public abstract WorkforceIdentityBasedManagementURIOrBuilder getWorkforceIdentityBasedManagementUriOrBuilder()

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()

public abstract WorkforceIdentityBasedOAuth2ClientID getWorkforceIdentityBasedOauth2ClientId()

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()

public abstract WorkforceIdentityBasedOAuth2ClientIDOrBuilder getWorkforceIdentityBasedOauth2ClientIdOrBuilder()

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()

public abstract boolean hasCreateTime()

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()

public abstract boolean hasManagementUri()

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.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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()

public abstract boolean hasWorkforceIdentityBasedManagementUri()

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()

public abstract boolean hasWorkforceIdentityBasedOauth2ClientId()

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.