Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class GoldengateDeploymentProperties.
Properties of GoldengateDeployment.
Generated from protobuf message google.cloud.oracledatabase.v1.GoldengateDeploymentProperties
Namespace
Google \ Cloud \ OracleDatabase \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ ocid |
string
Output only. OCID of the GoldengateDeployment. |
↳ lifecycle_state |
int
Output only. State of the GoldengateDeployment. |
↳ license_model |
int
Optional. The Oracle license model that applies to a Deployment. |
↳ environment_type |
string
Optional. The environment type of the GoldengateDeployment. |
↳ cpu_core_count |
int
Optional. The Minimum number of OCPUs to be made available for this Deployment. |
↳ is_auto_scaling_enabled |
bool
Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count. |
↳ description |
string
Optional. The description of the GoldengateDeployment. |
↳ deployment_type |
string
Required. A valid Goldengate Deployment type. For a list of supported types, use the |
↳ ogg_data |
GoldengateOggDeployment
Required. The ogg data of the GoldengateDeployment. |
↳ maintenance_window |
GoldengateMaintenanceWindow
Optional. The maintenance window of the GoldengateDeployment. |
↳ maintenance_config |
GoldengateMaintenanceConfig
Optional. The maintenance configuration of the GoldengateDeployment. |
↳ fqdn |
string
Output only. The Fully Qualified Domain Name of the GoldengateDeployment. |
↳ lifecycle_sub_state |
int
Output only. The lifecycle sub-state of the GoldengateDeployment. |
↳ category |
int
Output only. The category of the GoldengateDeployment. |
↳ deployment_backup_id |
string
Output only. The deployment backup id of the GoldengateDeployment. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time the GoldengateDeployment was updated. |
↳ lifecycle_details |
string
Output only. The lifecycle details of the GoldengateDeployment. |
↳ healthy |
bool
Output only. Whether the GoldengateDeployment is healthy. |
↳ load_balancer_subnet_id |
string
Output only. The load balancer subnet id of the GoldengateDeployment. |
↳ load_balancer_id |
string
Output only. The load balancer id of the GoldengateDeployment. |
↳ nsg_ids |
string[]
Output only. The nsg ids of the GoldengateDeployment. |
↳ is_public |
bool
Output only. Whether the GoldengateDeployment is public. |
↳ public_ip_address |
string
Output only. The public ip address of the GoldengateDeployment. |
↳ private_ip_address |
string
Output only. The private ip address of the GoldengateDeployment. |
↳ deployment_url |
string
Output only. The deployment url of the GoldengateDeployment. |
↳ is_latest_version |
bool
Output only. Whether the GoldengateDeployment is of the latest version. |
↳ upgrade_required_time |
Google\Protobuf\Timestamp
Output only. The time upgrade required of the GoldengateDeployment. |
↳ storage_utilization_bytes |
int|string
Output only. The storage utilization in bytes of the GoldengateDeployment. |
↳ is_storage_utilization_limit_exceeded |
bool
Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment. |
↳ deployment_diagnostic_data |
DeploymentDiagnosticData
Output only. The deployment diagnostic data of the GoldengateDeployment. |
↳ backup_schedule |
GoldengateBackupSchedule
Output only. The backup schedule of the GoldengateDeployment. |
↳ next_maintenance_time |
Google\Protobuf\Timestamp
Output only. The time of next maintenance of the GoldengateDeployment. |
↳ next_maintenance_action_type |
int
Output only. The next maintenance action type of the GoldengateDeployment. |
↳ next_maintenance_description |
string
Output only. The next maintenance description of the GoldengateDeployment. |
↳ ogg_version_support_end_time |
Google\Protobuf\Timestamp
Output only. The time ogg version supported until of the GoldengateDeployment. |
↳ ingress_ips |
array<IngressIp>
Output only. The ingress ips of the GoldengateDeployment. |
↳ deployment_role |
int
Output only. The deployment role of the GoldengateDeployment. |
↳ last_backup_schedule_time |
Google\Protobuf\Timestamp
Output only. The time last backup scheduled of the GoldengateDeployment. |
↳ next_backup_schedule_time |
Google\Protobuf\Timestamp
Output only. The time next backup scheduled of the GoldengateDeployment. |
↳ role_change_time |
Google\Protobuf\Timestamp
Output only. The time when the role of the GoldengateDeployment was changed. |
↳ locks |
array<GoldengateDeploymentLock>
Output only. The locks of the GoldengateDeployment. |
↳ placements |
array<GoldengatePlacement>
Output only. The placements of the GoldengateDeployment. |
getOcid
Output only. OCID of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOcid
Output only. OCID of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLifecycleState
Output only. State of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type GoldengateDeploymentLifecycleState. |
setLifecycleState
Output only. State of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type GoldengateDeploymentLifecycleState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLicenseModel
Optional. The Oracle license model that applies to a Deployment.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type LicenseModel. |
setLicenseModel
Optional. The Oracle license model that applies to a Deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type LicenseModel. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnvironmentType
Optional. The environment type of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEnvironmentType
Optional. The environment type of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCpuCoreCount
Optional. The Minimum number of OCPUs to be made available for this Deployment.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCpuCoreCount
Optional. The Minimum number of OCPUs to be made available for this Deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsAutoScalingEnabled
Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsAutoScalingEnabled
Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The description of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. The description of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentType
Required. A valid Goldengate Deployment type. For a list of supported
types, use the ListGoldengateDeploymentTypes operation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeploymentType
Required. A valid Goldengate Deployment type. For a list of supported
types, use the ListGoldengateDeploymentTypes operation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOggData
Required. The ogg data of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
GoldengateOggDeployment|null |
|
hasOggData
clearOggData
setOggData
Required. The ogg data of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
GoldengateOggDeployment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenanceWindow
Optional. The maintenance window of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
GoldengateMaintenanceWindow|null |
|
hasMaintenanceWindow
clearMaintenanceWindow
setMaintenanceWindow
Optional. The maintenance window of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
GoldengateMaintenanceWindow
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenanceConfig
Optional. The maintenance configuration of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
GoldengateMaintenanceConfig|null |
|
hasMaintenanceConfig
clearMaintenanceConfig
setMaintenanceConfig
Optional. The maintenance configuration of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
GoldengateMaintenanceConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFqdn
Output only. The Fully Qualified Domain Name of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFqdn
Output only. The Fully Qualified Domain Name of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLifecycleSubState
Output only. The lifecycle sub-state of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type GoldengateDeploymentLifecycleSubState. |
setLifecycleSubState
Output only. The lifecycle sub-state of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type GoldengateDeploymentLifecycleSubState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCategory
Output only. The category of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type GoldengateDeploymentCategory. |
setCategory
Output only. The category of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type GoldengateDeploymentCategory. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentBackupId
Output only. The deployment backup id of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeploymentBackupId
Output only. The deployment backup id of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time the GoldengateDeployment was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the GoldengateDeployment was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLifecycleDetails
Output only. The lifecycle details of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLifecycleDetails
Output only. The lifecycle details of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHealthy
Output only. Whether the GoldengateDeployment is healthy.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setHealthy
Output only. Whether the GoldengateDeployment is healthy.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoadBalancerSubnetId
Output only. The load balancer subnet id of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLoadBalancerSubnetId
Output only. The load balancer subnet id of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoadBalancerId
Output only. The load balancer id of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLoadBalancerId
Output only. The load balancer id of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNsgIds
Output only. The nsg ids of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setNsgIds
Output only. The nsg ids of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsPublic
Output only. Whether the GoldengateDeployment is public.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsPublic
Output only. Whether the GoldengateDeployment is public.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPublicIpAddress
Output only. The public ip address of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPublicIpAddress
Output only. The public ip address of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrivateIpAddress
Output only. The private ip address of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPrivateIpAddress
Output only. The private ip address of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentUrl
Output only. The deployment url of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeploymentUrl
Output only. The deployment url of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsLatestVersion
Output only. Whether the GoldengateDeployment is of the latest version.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsLatestVersion
Output only. Whether the GoldengateDeployment is of the latest version.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpgradeRequiredTime
Output only. The time upgrade required of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpgradeRequiredTime
clearUpgradeRequiredTime
setUpgradeRequiredTime
Output only. The time upgrade required of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStorageUtilizationBytes
Output only. The storage utilization in bytes of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setStorageUtilizationBytes
Output only. The storage utilization in bytes of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsStorageUtilizationLimitExceeded
Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsStorageUtilizationLimitExceeded
Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentDiagnosticData
Output only. The deployment diagnostic data of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
DeploymentDiagnosticData|null |
|
hasDeploymentDiagnosticData
clearDeploymentDiagnosticData
setDeploymentDiagnosticData
Output only. The deployment diagnostic data of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
DeploymentDiagnosticData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupSchedule
Output only. The backup schedule of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
GoldengateBackupSchedule|null |
|
hasBackupSchedule
clearBackupSchedule
setBackupSchedule
Output only. The backup schedule of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
GoldengateBackupSchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextMaintenanceTime
Output only. The time of next maintenance of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasNextMaintenanceTime
clearNextMaintenanceTime
setNextMaintenanceTime
Output only. The time of next maintenance of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextMaintenanceActionType
Output only. The next maintenance action type of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type NextMaintenanceActionType. |
setNextMaintenanceActionType
Output only. The next maintenance action type of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type NextMaintenanceActionType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextMaintenanceDescription
Output only. The next maintenance description of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNextMaintenanceDescription
Output only. The next maintenance description of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOggVersionSupportEndTime
Output only. The time ogg version supported until of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasOggVersionSupportEndTime
clearOggVersionSupportEndTime
setOggVersionSupportEndTime
Output only. The time ogg version supported until of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIngressIps
Output only. The ingress ips of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<IngressIp> |
|
setIngressIps
Output only. The ingress ips of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
array<IngressIp>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentRole
Output only. The deployment role of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type GoldengateDeploymentRoleType. |
setDeploymentRole
Output only. The deployment role of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type GoldengateDeploymentRoleType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastBackupScheduleTime
Output only. The time last backup scheduled of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastBackupScheduleTime
clearLastBackupScheduleTime
setLastBackupScheduleTime
Output only. The time last backup scheduled of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextBackupScheduleTime
Output only. The time next backup scheduled of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasNextBackupScheduleTime
clearNextBackupScheduleTime
setNextBackupScheduleTime
Output only. The time next backup scheduled of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRoleChangeTime
Output only. The time when the role of the GoldengateDeployment was changed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasRoleChangeTime
clearRoleChangeTime
setRoleChangeTime
Output only. The time when the role of the GoldengateDeployment was changed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocks
Output only. The locks of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<GoldengateDeploymentLock> |
|
setLocks
Output only. The locks of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
array<GoldengateDeploymentLock>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlacements
Output only. The placements of the GoldengateDeployment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<GoldengatePlacement> |
|
setPlacements
Output only. The placements of the GoldengateDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
array<GoldengatePlacement>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|