Class ManagementServer (0.3.0)

public final class ManagementServer extends GeneratedMessageV3 implements ManagementServerOrBuilder

ManagementServer describes a single BackupDR ManagementServer instance.

Protobuf type google.cloud.backupdr.v1.ManagementServer

Static Fields

BA_PROXY_URI_FIELD_NUMBER

public static final int BA_PROXY_URI_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MANAGEMENT_URI_FIELD_NUMBER

public static final int MANAGEMENT_URI_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NETWORKS_FIELD_NUMBER

public static final int NETWORKS_FIELD_NUMBER
Field Value
Type Description
int

OAUTH2_CLIENT_ID_FIELD_NUMBER

public static final int OAUTH2_CLIENT_ID_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WORKFORCE_IDENTITY_BASED_MANAGEMENT_URI_FIELD_NUMBER

public static final int WORKFORCE_IDENTITY_BASED_MANAGEMENT_URI_FIELD_NUMBER
Field Value
Type Description
int

WORKFORCE_IDENTITY_BASED_OAUTH2_CLIENT_ID_FIELD_NUMBER

public static final int WORKFORCE_IDENTITY_BASED_OAUTH2_CLIENT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ManagementServer getDefaultInstance()
Returns
Type Description
ManagementServer

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ManagementServer.Builder newBuilder()
Returns
Type Description
ManagementServer.Builder

newBuilder(ManagementServer prototype)

public static ManagementServer.Builder newBuilder(ManagementServer prototype)
Parameter
Name Description
prototype ManagementServer
Returns
Type Description
ManagementServer.Builder

parseDelimitedFrom(InputStream input)

public static ManagementServer parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ManagementServer
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ManagementServer parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ManagementServer
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ManagementServer parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ManagementServer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ManagementServer parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ManagementServer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ManagementServer parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ManagementServer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ManagementServer parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ManagementServer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ManagementServer parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ManagementServer
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ManagementServer parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ManagementServer
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ManagementServer parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ManagementServer
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ManagementServer parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ManagementServer
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ManagementServer parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ManagementServer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ManagementServer parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ManagementServer
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ManagementServer> parser()
Returns
Type Description
Parser<ManagementServer>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBaProxyUri(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the baProxyUri.

getCreateTime()

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

getDefaultInstanceForType()

public ManagementServer getDefaultInstanceForType()
Returns
Type Description
ManagementServer

getDescription()

public 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 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.

getParserForType()

public Parser<ManagementServer> getParserForType()
Returns
Type Description
Parser<ManagementServer>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ManagementServer.Builder newBuilderForType()
Returns
Type Description
ManagementServer.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ManagementServer.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ManagementServer.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ManagementServer.Builder toBuilder()
Returns
Type Description
ManagementServer.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException