Package com.oracle.bmc.goldengate.model

Class 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).

    • Method Detail

      • 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

      • 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

      • getIsByolCpuCoreCountLimitEnabled

        public Boolean getIsByolCpuCoreCountLimitEnabled()
        Flag to allow to configure the ‘Bring Your Own License’ (BYOL) license type CPU limit.

        If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

        Returns:
        the value

      • getByolCpuCoreCountLimit

        public Integer getByolCpuCoreCountLimit()
        The maximum number of CPUs allowed with a ‘Bring Your Own License’ (BYOL) license type.

        Any CPU usage above this limit is considered as License Included and billed.

        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

      • 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

      • 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

      • 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

      • getSubscriptionId

        public String getSubscriptionId()
        The OCID of the subscription with which resource needs to be associated with.
        Returns:
        the value

      • getClusterPlacementGroupId

        public String getClusterPlacementGroupId()
        The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

        Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.

        Returns:
        the value

      • getSecurityAttributes

        public Map<String,​Map<String,​Object>> getSecurityAttributes()
        Security attributes for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}

        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