java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.goldengate.model.Deployment

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class Deployment
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.
Note: Objects should always be created or deserialized using the Deployment.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Deployment.Builder, which maintain a set of all explicitly set fields called Deployment.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Deployment.Builder

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
Deployment(String id, String displayName, String description, String compartmentId, String availabilityDomain, String faultDomain, DeploymentRole deploymentRole, Date timeRoleChanged, String sourceDeploymentId, List<DeploymentPlacementInfo> placements, String deploymentBackupId, Date timeCreated, Date timeUpdated, LifecycleState lifecycleState, LifecycleSubState lifecycleSubState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, List<ResourceLock> locks, Boolean isHealthy, String subnetId, String loadBalancerSubnetId, String loadBalancerId, String fqdn, LicenseModel licenseModel, EnvironmentType environmentType, DeploymentCategory category, Integer cpuCoreCount, Boolean isAutoScalingEnabled, List<String> nsgIds, Boolean isPublic, String publicIpAddress, String privateIpAddress, String deploymentUrl, Map<String,Map<String,Object>> systemTags, Boolean isLatestVersion, Date timeUpgradeRequired, Long storageUtilizationInBytes, Boolean isStorageUtilizationLimitExceeded, DeploymentType deploymentType, OggDeployment oggData, DeploymentDiagnosticData deploymentDiagnosticData, MaintenanceWindow maintenanceWindow, Date timeOfNextMaintenance, MaintenanceActionType nextMaintenanceActionType, String nextMaintenanceDescription, MaintenanceConfiguration maintenanceConfiguration, Date timeOggVersionSupportedUntil, BackupSchedule backupSchedule, Date timeLastBackupScheduled, Date timeNextBackupScheduled, List<IngressIpDetails> ingressIps)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Deployment.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getAvailabilityDomain()`	The availability domain of a placement.
`BackupSchedule`	`getBackupSchedule()`
`DeploymentCategory`	`getCategory()`	The deployment category defines the broad separation of the deployment type into three categories.
`String`	`getCompartmentId()`	The OCID of the compartment being referenced.
`Integer`	`getCpuCoreCount()`	The Minimum number of OCPUs to be made available for this Deployment.
`Map<String,Map<String,Object>>`	`getDefinedTags()`	Tags defined for this resource.
`String`	`getDeploymentBackupId()`	The OCID of the backup being referenced.
`DeploymentDiagnosticData`	`getDeploymentDiagnosticData()`
`DeploymentRole`	`getDeploymentRole()`	The type of the deployment role.
`DeploymentType`	`getDeploymentType()`	The type of deployment, which can be any one of the Allowed values.
`String`	`getDeploymentUrl()`	The URL of a resource.
`String`	`getDescription()`	Metadata about this specific object.
`String`	`getDisplayName()`	An object’s Display Name.
`EnvironmentType`	`getEnvironmentType()`	Specifies whether the deployment is used in a production or development/testing environment.
`String`	`getFaultDomain()`	The fault domain of a placement.
`String`	`getFqdn()`	A three-label Fully Qualified Domain Name (FQDN) for a resource.
`Map<String,String>`	`getFreeformTags()`	A simple key-value pair that is applied without any predefined name, type, or scope.
`String`	`getId()`	The OCID of the deployment being referenced.
`List<IngressIpDetails>`	`getIngressIps()`	List of ingress IP addresses from where the GoldenGate deployment connects to this connection’s privateIp.
`Boolean`	`getIsAutoScalingEnabled()`	Indicates if auto scaling is enabled for the Deployment’s CPU core count.
`Boolean`	`getIsHealthy()`	True if all of the aggregate resources are working correctly.
`Boolean`	`getIsLatestVersion()`	Indicates if the resource is the the latest available version.
`Boolean`	`getIsPublic()`	True if this object is publicly available.
`Boolean`	`getIsStorageUtilizationLimitExceeded()`	Deprecated: This field is not updated and will be removed in future versions.
`LicenseModel`	`getLicenseModel()`	The Oracle license model that applies to a Deployment.
`String`	`getLifecycleDetails()`	Describes the object’s current state in detail.
`LifecycleState`	`getLifecycleState()`	Possible lifecycle states.
`LifecycleSubState`	`getLifecycleSubState()`	Possible GGS lifecycle sub-states.
`String`	`getLoadBalancerId()`	The OCID of the loadbalancer in the customer’s subnet.
`String`	`getLoadBalancerSubnetId()`	The OCID of a public subnet in the customer tenancy.
`List<ResourceLock>`	`getLocks()`	Locks associated with this resource.
`MaintenanceConfiguration`	`getMaintenanceConfiguration()`
`MaintenanceWindow`	`getMaintenanceWindow()`
`MaintenanceActionType`	`getNextMaintenanceActionType()`	Type of the next maintenance.
`String`	`getNextMaintenanceDescription()`	Description of the next maintenance.
`List<String>`	`getNsgIds()`	An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
`OggDeployment`	`getOggData()`
`List<DeploymentPlacementInfo>`	`getPlacements()`	An array of local peers of deployment
`String`	`getPrivateIpAddress()`	The private IP address in the customer’s VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
`String`	`getPublicIpAddress()`	The public IP address representing the access point for the Deployment.
`String`	`getSourceDeploymentId()`	The OCID of the deployment being referenced.
`Long`	`getStorageUtilizationInBytes()`	The amount of storage being utilized (in bytes)
`String`	`getSubnetId()`	The OCID of the subnet of the deployment’s private endpoint.
`Map<String,Map<String,Object>>`	`getSystemTags()`	The system tags associated with this resource, if any.
`Date`	`getTimeCreated()`	The time the resource was created.
`Date`	`getTimeLastBackupScheduled()`	The timestamp of last deployment backup scheduled.
`Date`	`getTimeNextBackupScheduled()`	The timestamp of next deployment backup scheduled.
`Date`	`getTimeOfNextMaintenance()`	The time of next maintenance schedule.
`Date`	`getTimeOggVersionSupportedUntil()`	The time until OGG version is supported.
`Date`	`getTimeRoleChanged()`	The time of the last role change.
`Date`	`getTimeUpdated()`	The time the resource was last updated.
`Date`	`getTimeUpgradeRequired()`	Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records to check, when deployment will be forced to upgrade to a newer version.
`int`	`hashCode()`
`Deployment.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Deployment
```
@Deprecated
@ConstructorProperties({"id","displayName","description","compartmentId","availabilityDomain","faultDomain","deploymentRole","timeRoleChanged","sourceDeploymentId","placements","deploymentBackupId","timeCreated","timeUpdated","lifecycleState","lifecycleSubState","lifecycleDetails","freeformTags","definedTags","locks","isHealthy","subnetId","loadBalancerSubnetId","loadBalancerId","fqdn","licenseModel","environmentType","category","cpuCoreCount","isAutoScalingEnabled","nsgIds","isPublic","publicIpAddress","privateIpAddress","deploymentUrl","systemTags","isLatestVersion","timeUpgradeRequired","storageUtilizationInBytes","isStorageUtilizationLimitExceeded","deploymentType","oggData","deploymentDiagnosticData","maintenanceWindow","timeOfNextMaintenance","nextMaintenanceActionType","nextMaintenanceDescription","maintenanceConfiguration","timeOggVersionSupportedUntil","backupSchedule","timeLastBackupScheduled","timeNextBackupScheduled","ingressIps"})
public Deployment(String id,
                  String displayName,
                  String description,
                  String compartmentId,
                  String availabilityDomain,
                  String faultDomain,
                  DeploymentRole deploymentRole,
                  Date timeRoleChanged,
                  String sourceDeploymentId,
                  List<DeploymentPlacementInfo> placements,
                  String deploymentBackupId,
                  Date timeCreated,
                  Date timeUpdated,
                  LifecycleState lifecycleState,
                  LifecycleSubState lifecycleSubState,
                  String lifecycleDetails,
                  Map<String,String> freeformTags,
                  Map<String,Map<String,Object>> definedTags,
                  List<ResourceLock> locks,
                  Boolean isHealthy,
                  String subnetId,
                  String loadBalancerSubnetId,
                  String loadBalancerId,
                  String fqdn,
                  LicenseModel licenseModel,
                  EnvironmentType environmentType,
                  DeploymentCategory category,
                  Integer cpuCoreCount,
                  Boolean isAutoScalingEnabled,
                  List<String> nsgIds,
                  Boolean isPublic,
                  String publicIpAddress,
                  String privateIpAddress,
                  String deploymentUrl,
                  Map<String,Map<String,Object>> systemTags,
                  Boolean isLatestVersion,
                  Date timeUpgradeRequired,
                  Long storageUtilizationInBytes,
                  Boolean isStorageUtilizationLimitExceeded,
                  DeploymentType deploymentType,
                  OggDeployment oggData,
                  DeploymentDiagnosticData deploymentDiagnosticData,
                  MaintenanceWindow maintenanceWindow,
                  Date timeOfNextMaintenance,
                  MaintenanceActionType nextMaintenanceActionType,
                  String nextMaintenanceDescription,
                  MaintenanceConfiguration maintenanceConfiguration,
                  Date timeOggVersionSupportedUntil,
                  BackupSchedule backupSchedule,
                  Date timeLastBackupScheduled,
                  Date timeNextBackupScheduled,
                  List<IngressIpDetails> ingressIps)
```
    Deprecated.
- Method Detail
  - builder
```
public static Deployment.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public Deployment.Builder toBuilder()
```
  - getId
```
public String getId()
```
    The OCID of the deployment being referenced.
    
    Returns:
    
    the value
  - getDisplayName
```
public String getDisplayName()
```
    An object’s Display Name.
    
    Returns:
    
    the value
  - getDescription
```
public String getDescription()
```
    Metadata about this specific object.
    
    Returns:
    
    the value
  - getCompartmentId
```
public String getCompartmentId()
```
    The OCID of the compartment being referenced.
    
    Returns:
    
    the value
  - getAvailabilityDomain
```
public String getAvailabilityDomain()
```
    The availability domain of a placement.
    
    Returns:
    
    the value
  - getFaultDomain
```
public String getFaultDomain()
```
    The fault domain of a placement.
    
    Returns:
    
    the value
  - getDeploymentRole
```
public DeploymentRole getDeploymentRole()
```
    The type of the deployment role.
    
    Returns:
    
    the value
  - getTimeRoleChanged
```
public Date getTimeRoleChanged()
```
    The time of the last role change.
    The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    
    Returns:
    
    the value
  - getSourceDeploymentId
```
public String getSourceDeploymentId()
```
    The OCID of the deployment being referenced.
    
    Returns:
    
    the value
  - getPlacements
```
public List<DeploymentPlacementInfo> getPlacements()
```
    An array of local peers of deployment
    
    Returns:
    
    the value
  - getDeploymentBackupId
```
public String getDeploymentBackupId()
```
    The OCID of the backup being referenced.
    
    Returns:
    
    the value
  - getTimeCreated
```
public Date getTimeCreated()
```
    The time the resource was created.
    The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    
    Returns:
    
    the value
  - getTimeUpdated
```
public Date getTimeUpdated()
```
    The time the resource was last updated.
    The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    
    Returns:
    
    the value
  - getLifecycleState
```
public LifecycleState getLifecycleState()
```
    Possible lifecycle states.
    
    Returns:
    
    the value
  - getLifecycleSubState
```
public LifecycleSubState getLifecycleSubState()
```
    Possible GGS lifecycle sub-states.
    
    Returns:
    
    the value
  - getLifecycleDetails
```
public String getLifecycleDetails()
```
    Describes the object’s current state in detail.
    For example, it can be used to provide actionable information for a resource in a Failed state.
    
    Returns:
    
    the value
  - getFreeformTags
```
public Map<String,String> getFreeformTags()
```
    A simple key-value pair that is applied without any predefined name, type, or scope.
    Exists for cross-compatibility only.
    
    Example: {"bar-key": "value"}
    
    Returns:
    
    the value
  - getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
    Tags defined for this resource.
    Each key is predefined and scoped to a namespace.
    
    Example: {"foo-namespace": {"bar-key": "value"}}
    
    Returns:
    
    the value
  - getLocks
```
public List<ResourceLock> getLocks()
```
    Locks associated with this resource.
    
    Returns:
    
    the value
  - getIsHealthy
```
public Boolean getIsHealthy()
```
    True if all of the aggregate resources are working correctly.
    
    Returns:
    
    the value
  - getSubnetId
```
public String getSubnetId()
```
    The OCID of the subnet of the deployment’s private endpoint.
    The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
    
    Returns:
    
    the value
  - getLoadBalancerSubnetId
```
public String getLoadBalancerSubnetId()
```
    The OCID of a public subnet in the customer tenancy.
    Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
    
    Returns:
    
    the value
  - getLoadBalancerId
```
public String getLoadBalancerId()
```
    The OCID of the loadbalancer in the customer’s subnet.
    The loadbalancer of the public deployment created in the customer subnet.
    
    Returns:
    
    the value
  - getFqdn
```
public String getFqdn()
```
    A three-label Fully Qualified Domain Name (FQDN) for a resource.
    
    Returns:
    
    the value
  - getLicenseModel
```
public LicenseModel getLicenseModel()
```
    The Oracle license model that applies to a Deployment.
    
    Returns:
    
    the value
  - getEnvironmentType
```
public EnvironmentType getEnvironmentType()
```
    Specifies whether the deployment is used in a production or development/testing environment.
    
    Returns:
    
    the value
  - getCategory
```
public DeploymentCategory getCategory()
```
    The deployment category defines the broad separation of the deployment type into three categories.
    Currently the separation is ‘DATA_REPLICATION’, ‘STREAM_ANALYTICS’ and ‘DATA_TRANSFORMS’.
    
    Returns:
    
    the value
  - getCpuCoreCount
```
public Integer getCpuCoreCount()
```
    The Minimum number of OCPUs to be made available for this Deployment.
    
    Returns:
    
    the value
  - getIsAutoScalingEnabled
```
public Boolean getIsAutoScalingEnabled()
```
    Indicates if auto scaling is enabled for the Deployment’s CPU core count.
    
    Returns:
    
    the value
  - getNsgIds
```
public List<String> getNsgIds()
```
    An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
    
    Returns:
    
    the value
  - getIsPublic
```
public Boolean getIsPublic()
```
    True if this object is publicly available.
    
    Returns:
    
    the value
  - getPublicIpAddress
```
public String getPublicIpAddress()
```
    The public IP address representing the access point for the Deployment.
    
    Returns:
    
    the value
  - getPrivateIpAddress
```
public String getPrivateIpAddress()
```
    The private IP address in the customer’s VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
    
    Returns:
    
    the value
  - getDeploymentUrl
```
public String getDeploymentUrl()
```
    The URL of a resource.
    
    Returns:
    
    the value
  - getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
    The system tags associated with this resource, if any.
    The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
    
    Example: {orcl-cloud: {free-tier-retain: true}}
    
    Returns:
    
    the value
  - getIsLatestVersion
```
public Boolean getIsLatestVersion()
```
    Indicates if the resource is the the latest available version.
    
    Returns:
    
    the value
  - getTimeUpgradeRequired
```
public Date getTimeUpgradeRequired()
```
    Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records to check, when deployment will be forced to upgrade to a newer version.
    Old description: The date the existing version in use will no longer be considered as usable and an upgrade will be required. This date is typically 6 months after the version was released for use by GGS. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    
    Returns:
    
    the value
  - getStorageUtilizationInBytes
```
public Long getStorageUtilizationInBytes()
```
    The amount of storage being utilized (in bytes)
    
    Returns:
    
    the value
  - getIsStorageUtilizationLimitExceeded
```
public Boolean getIsStorageUtilizationLimitExceeded()
```
    Deprecated: This field is not updated and will be removed in future versions.
    If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=. Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit. Exceeding the limit may be an indication of a misconfiguration of the deployment’s GoldenGate service.
    
    Returns:
    
    the value
  - getDeploymentType
```
public DeploymentType getDeploymentType()
```
    The type of deployment, which can be any one of the Allowed values.
    NOTE: Use of the value ‘OGG’ is maintained for backward compatibility purposes. Its use is discouraged in favor of ‘DATABASE_ORACLE’.
    
    Returns:
    
    the value
  - getOggData
```
public OggDeployment getOggData()
```
  - getDeploymentDiagnosticData
```
public DeploymentDiagnosticData getDeploymentDiagnosticData()
```
  - getMaintenanceWindow
```
public MaintenanceWindow getMaintenanceWindow()
```
  - getTimeOfNextMaintenance
```
public Date getTimeOfNextMaintenance()
```
    The time of next maintenance schedule.
    The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    
    Returns:
    
    the value
  - getNextMaintenanceActionType
```
public MaintenanceActionType getNextMaintenanceActionType()
```
    Type of the next maintenance.
    
    Returns:
    
    the value
  - getNextMaintenanceDescription
```
public String getNextMaintenanceDescription()
```
    Description of the next maintenance.
    
    Returns:
    
    the value
  - getMaintenanceConfiguration
```
public MaintenanceConfiguration getMaintenanceConfiguration()
```
  - getTimeOggVersionSupportedUntil
```
public Date getTimeOggVersionSupportedUntil()
```
    The time until OGG version is supported.
    After this date has passed OGG version will not be available anymore. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
    
    Returns:
    
    the value
  - getBackupSchedule
```
public BackupSchedule getBackupSchedule()
```
  - getTimeLastBackupScheduled
```
public Date getTimeLastBackupScheduled()
```
    The timestamp of last deployment backup scheduled.
    The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
    
    Returns:
    
    the value
  - getTimeNextBackupScheduled
```
public Date getTimeNextBackupScheduled()
```
    The timestamp of next deployment backup scheduled.
    The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
    
    Returns:
    
    the value
  - getIngressIps
```
public List<IngressIpDetails> getIngressIps()
```
    List of ingress IP addresses from where the GoldenGate deployment connects to this connection’s privateIp.
    Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
    
    Returns:
    
    the value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - toString
```
public String toString(boolean includeByteArrayContents)
```
    Return a string representation of the object.
    
    Parameters:
    
    includeByteArrayContents - true to include the full contents of byte arrays
    
    Returns:
    
    string representation
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class Deployment

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

Deployment

Method Detail

builder

toBuilder

getId

getDisplayName

getDescription

getCompartmentId

getAvailabilityDomain

getFaultDomain

getDeploymentRole

getTimeRoleChanged

getSourceDeploymentId

getPlacements

getDeploymentBackupId

getTimeCreated

getTimeUpdated

getLifecycleState

getLifecycleSubState

getLifecycleDetails

getFreeformTags

getDefinedTags

getLocks

getIsHealthy

getSubnetId

getLoadBalancerSubnetId

getLoadBalancerId

getFqdn

getLicenseModel

getEnvironmentType

getCategory

getCpuCoreCount

getIsAutoScalingEnabled

getNsgIds

getIsPublic

getPublicIpAddress

getPrivateIpAddress

getDeploymentUrl

getSystemTags

getIsLatestVersion

getTimeUpgradeRequired

getStorageUtilizationInBytes

getIsStorageUtilizationLimitExceeded

getDeploymentType

getOggData

getDeploymentDiagnosticData

getMaintenanceWindow

getTimeOfNextMaintenance

getNextMaintenanceActionType

getNextMaintenanceDescription

getMaintenanceConfiguration

getTimeOggVersionSupportedUntil

getBackupSchedule

getTimeLastBackupScheduled

getTimeNextBackupScheduled

getIngressIps

toString

toString

equals

hashCode