publicfinalclass ManagementServerextendsGeneratedMessageV3implementsManagementServerOrBuilder
ManagementServer describes a single BackupDR ManagementServer instance.
Protobuf type google.cloud.backupdr.v1.ManagementServer
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BA_PROXY_URI_FIELD_NUMBER
publicstaticfinalintBA_PROXY_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
CREATE_TIME_FIELD_NUMBER
publicstaticfinalintCREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
DESCRIPTION_FIELD_NUMBER
publicstaticfinalintDESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
ETAG_FIELD_NUMBER
publicstaticfinalintETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
LABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
MANAGEMENT_URI_FIELD_NUMBER
publicstaticfinalintMANAGEMENT_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NETWORKS_FIELD_NUMBER
publicstaticfinalintNETWORKS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
OAUTH2_CLIENT_ID_FIELD_NUMBER
publicstaticfinalintOAUTH2_CLIENT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SATISFIES_PZI_FIELD_NUMBER
publicstaticfinalintSATISFIES_PZI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SATISFIES_PZS_FIELD_NUMBER
publicstaticfinalintSATISFIES_PZS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
STATE_FIELD_NUMBER
publicstaticfinalintSTATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
TYPE_FIELD_NUMBER
publicstaticfinalintTYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
UPDATE_TIME_FIELD_NUMBER
publicstaticfinalintUPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
WORKFORCE_IDENTITY_BASED_MANAGEMENT_URI_FIELD_NUMBER
publicstaticfinalintWORKFORCE_IDENTITY_BASED_MANAGEMENT_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
WORKFORCE_IDENTITY_BASED_OAUTH2_CLIENT_ID_FIELD_NUMBER
publicstaticfinalintWORKFORCE_IDENTITY_BASED_OAUTH2_CLIENT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticManagementServergetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticManagementServer.BuildernewBuilder()
newBuilder(ManagementServer prototype)
publicstaticManagementServer.BuildernewBuilder(ManagementServerprototype)
publicstaticManagementServerparseDelimitedFrom(InputStreaminput)
publicstaticManagementServerparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticManagementServerparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticManagementServerparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticManagementServerparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticManagementServerparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticManagementServerparseFrom(CodedInputStreaminput)
publicstaticManagementServerparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticManagementServerparseFrom(InputStreaminput)
publicstaticManagementServerparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticManagementServerparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticManagementServerparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<ManagementServer>parser()
Methods
containsLabels(String key)
publicbooleancontainsLabels(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
|
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBaProxyUri(int index)
publicStringgetBaProxyUri(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)
publicByteStringgetBaProxyUriBytes(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()
publicintgetBaProxyUriCount()
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()
publicProtocolStringListgetBaProxyUriList()
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];
getCreateTime()
publicTimestampgetCreateTime()
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()
publicTimestampOrBuildergetCreateTimeOrBuilder()
Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
publicManagementServergetDefaultInstanceForType()
getDescription()
publicStringgetDescription()
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()
publicByteStringgetDescriptionBytes()
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()
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()
publicByteStringgetEtagBytes()
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)
publicMap<String,String>getLabels()
getLabelsCount()
publicintgetLabelsCount()
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()
publicMap<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];
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(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];
| Returns |
| Type |
Description |
String |
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(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()
publicManagementURIgetManagementUri()
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];
getManagementUriOrBuilder()
publicManagementURIOrBuildergetManagementUriOrBuilder()
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];
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()
publicByteStringgetNameBytes()
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)
publicNetworkConfiggetNetworks(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
|
getNetworksCount()
publicintgetNetworksCount()
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()
publicList<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];
getNetworksOrBuilder(int index)
publicNetworkConfigOrBuildergetNetworksOrBuilder(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
|
getNetworksOrBuilderList()
publicList<?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()
publicStringgetOauth2ClientId()
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()
publicByteStringgetOauth2ClientIdBytes()
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()
publicParser<ManagementServer>getParserForType()
Overrides
getSatisfiesPzi()
publicbooleangetSatisfiesPzi()
Output only. Reserved for future use.
bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The satisfiesPzi.
|
getSatisfiesPzs()
publicBoolValuegetSatisfiesPzs()
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()
publicBoolValueOrBuildergetSatisfiesPzsOrBuilder()
Output only. Reserved for future use.
.google.protobuf.BoolValue satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getState()
publicManagementServer.InstanceStategetState()
Output only. The ManagementServer state.
.google.cloud.backupdr.v1.ManagementServer.InstanceState state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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()
publicManagementServer.InstanceTypegetType()
Optional. The type of the ManagementServer resource.
.google.cloud.backupdr.v1.ManagementServer.InstanceType type = 14 [(.google.api.field_behavior) = OPTIONAL];
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()
publicTimestampgetUpdateTime()
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()
publicTimestampOrBuildergetUpdateTimeOrBuilder()
Output only. The time when the instance was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getWorkforceIdentityBasedManagementUri()
publicWorkforceIdentityBasedManagementURIgetWorkforceIdentityBasedManagementUri()
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];
getWorkforceIdentityBasedManagementUriOrBuilder()
publicWorkforceIdentityBasedManagementURIOrBuildergetWorkforceIdentityBasedManagementUriOrBuilder()
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];
getWorkforceIdentityBasedOauth2ClientId()
publicWorkforceIdentityBasedOAuth2ClientIDgetWorkforceIdentityBasedOauth2ClientId()
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];
getWorkforceIdentityBasedOauth2ClientIdOrBuilder()
publicWorkforceIdentityBasedOAuth2ClientIDOrBuildergetWorkforceIdentityBasedOauth2ClientIdOrBuilder()
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];
hasCreateTime()
publicbooleanhasCreateTime()
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()
publicbooleanhasManagementUri()
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()
publicbooleanhasSatisfiesPzs()
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()
publicbooleanhasUpdateTime()
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()
publicbooleanhasWorkforceIdentityBasedManagementUri()
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()
publicbooleanhasWorkforceIdentityBasedOauth2ClientId()
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()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicManagementServer.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedManagementServer.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicManagementServer.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides