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.
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
↳ update_time
↳ 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
>
Optional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA
↳ 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
↳ satisfies_pzi
bool
Output only. Reserved for future use.
getName
Output only. Identifier. The resource name.
string
setName
Output only. Identifier. The resource name.
var
string
$this
getDescription
Optional. The description of the ManagementServer instance (2048 characters or less).
string
setDescription
Optional. The description of the ManagementServer instance (2048 characters or less).
var
string
$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.
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.
$this
getCreateTime
Output only. The time when the instance was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the instance was created.
$this
getUpdateTime
Output only. The time when the instance was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the instance was updated.
$this
getType
Optional. The type of the ManagementServer resource.
int
setType
Optional. The type of the ManagementServer resource.
var
int
$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.
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.
$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.
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.
$this
getState
Output only. The ManagementServer state.
int
setState
Output only. The ManagementServer state.
var
int
$this
getNetworks
Optional. VPC networks to which the ManagementServer instance is connected.
For this version, only a single network is supported. This field is optional if MS is created without PSA
setNetworks
Optional. VPC networks to which the ManagementServer instance is connected.
For this version, only a single network is supported. This field is optional if MS is created without PSA
$this
getEtag
Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
string
setEtag
Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
var
string
$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 ).
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 ).
var
string
$this
getWorkforceIdentityBasedOauth2ClientId
Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
hasWorkforceIdentityBasedOauth2ClientId
clearWorkforceIdentityBasedOauth2ClientId
setWorkforceIdentityBasedOauth2ClientId
Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
$this
getBaProxyUri
Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
setBaProxyUri
Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
var
string[]
$this
getSatisfiesPzs
Output only. Reserved for future use.
hasSatisfiesPzs
clearSatisfiesPzs
getSatisfiesPzsUnwrapped
Returns the unboxed value from getSatisfiesPzs()
Output only. Reserved for future use.
bool|null
setSatisfiesPzs
Output only. Reserved for future use.
$this
setSatisfiesPzsUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Output only. Reserved for future use.
var
bool|null
$this
getSatisfiesPzi
Output only. Reserved for future use.
bool
setSatisfiesPzi
Output only. Reserved for future use.
var
bool
$this
