Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class ManagementServer.
ManagementServer describes a single BackupDR ManagementServer instance.
Generated from protobuf message google.cloud.backupdr.v1.ManagementServer
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Identifier. The resource name. |
↳ description |
string
Optional. The description of the ManagementServer instance (2048 characters or less). |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the instance was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time when the instance was updated. |
↳ type |
int
Optional. The type of the ManagementServer resource. |
↳ management_uri |
ManagementURI
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. |
↳ workforce_identity_based_management_uri |
WorkforceIdentityBasedManagementURI
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. |
↳ state |
int
Output only. The ManagementServer state. |
↳ networks |
array<NetworkConfig>
Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. |
↳ etag |
string
Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. |
↳ oauth2_client_id |
string
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). |
↳ workforce_identity_based_oauth2_client_id |
WorkforceIdentityBasedOAuth2ClientID
Output only. The OAuth client IDs for both types of user i.e. 1p and 3p. |
↳ ba_proxy_uri |
array
Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy. |
↳ satisfies_pzs |
Google\Protobuf\BoolValue
Output only. Reserved for future use. |
↳ satisfies_pzi |
bool
Output only. Reserved for future use. |
getName
Output only. Identifier. The resource name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Identifier. The resource name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The description of the ManagementServer instance (2048 characters or less).
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. The description of the ManagementServer instance (2048 characters or less).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time when the instance was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the instance was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time when the instance was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the instance was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Optional. The type of the ManagementServer resource.
| Returns | |
|---|---|
| Type | Description |
int |
|
setType
Optional. The type of the ManagementServer resource.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
ManagementURI|null |
|
hasManagementUri
clearManagementUri
setManagementUri
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.
| Parameter | |
|---|---|
| Name | Description |
var |
ManagementURI
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
WorkforceIdentityBasedManagementURI|null |
|
hasWorkforceIdentityBasedManagementUri
clearWorkforceIdentityBasedManagementUri
setWorkforceIdentityBasedManagementUri
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.
| Parameter | |
|---|---|
| Name | Description |
var |
WorkforceIdentityBasedManagementURI
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The ManagementServer state.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The ManagementServer state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetworks
Required. VPC networks to which the ManagementServer instance is connected.
For this version, only a single network is supported.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setNetworks
Required. VPC networks to which the ManagementServer instance is connected.
For this version, only a single network is supported.
| Parameter | |
|---|---|
| Name | Description |
var |
array<NetworkConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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).
| Returns | |
|---|---|
| Type | Description |
string |
|
setOauth2ClientId
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).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkforceIdentityBasedOauth2ClientId
Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
| Returns | |
|---|---|
| Type | Description |
WorkforceIdentityBasedOAuth2ClientID|null |
|
hasWorkforceIdentityBasedOauth2ClientId
clearWorkforceIdentityBasedOauth2ClientId
setWorkforceIdentityBasedOauth2ClientId
Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
| Parameter | |
|---|---|
| Name | Description |
var |
WorkforceIdentityBasedOAuth2ClientID
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBaProxyUri
Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setBaProxyUri
Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzs
Output only. Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null |
|
hasSatisfiesPzs
clearSatisfiesPzs
getSatisfiesPzsUnwrapped
Returns the unboxed value from getSatisfiesPzs()
Output only. Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool|null |
|
setSatisfiesPzs
Output only. Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setSatisfiesPzsUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Output only. Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzi
Output only. Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSatisfiesPzi
Output only. Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|