Package com.oracle.bmc.goldengate.model

Class Deployment.Builder

  • Enclosing class:
    Deployment
    public static class Deployment.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Deployment.Builder id​(String id)
        The OCID of the deployment being referenced.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

        public Deployment.Builder displayName​(String displayName)
        An object’s Display Name.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • description

        public Deployment.Builder description​(String description)
        Metadata about this specific object.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • compartmentId

        public Deployment.Builder compartmentId​(String compartmentId)
        The OCID of the compartment being referenced.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • availabilityDomain

        public Deployment.Builder availabilityDomain​(String availabilityDomain)
        The availability domain of a placement.
        Parameters:
        availabilityDomain - the value to set
        Returns:
        this builder

      • faultDomain

        public Deployment.Builder faultDomain​(String faultDomain)
        The fault domain of a placement.
        Parameters:
        faultDomain - the value to set
        Returns:
        this builder

      • deploymentRole

        public Deployment.Builder deploymentRole​(DeploymentRole deploymentRole)
        The type of the deployment role.
        Parameters:
        deploymentRole - the value to set
        Returns:
        this builder

      • timeRoleChanged

        public Deployment.Builder timeRoleChanged​(Date timeRoleChanged)
        The time of the last role change.

        The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

        Parameters:
        timeRoleChanged - the value to set
        Returns:
        this builder

      • sourceDeploymentId

        public Deployment.Builder sourceDeploymentId​(String sourceDeploymentId)
        The OCID of the deployment being referenced.
        Parameters:
        sourceDeploymentId - the value to set
        Returns:
        this builder

      • deploymentBackupId

        public Deployment.Builder deploymentBackupId​(String deploymentBackupId)
        The OCID of the backup being referenced.
        Parameters:
        deploymentBackupId - the value to set
        Returns:
        this builder

      • timeCreated

        public Deployment.Builder timeCreated​(Date timeCreated)
        The time the resource was created.

        The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public Deployment.Builder timeUpdated​(Date timeUpdated)
        The time the resource was last updated.

        The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • lifecycleState

        public Deployment.Builder lifecycleState​(LifecycleState lifecycleState)
        Possible lifecycle states.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleSubState

        public Deployment.Builder lifecycleSubState​(LifecycleSubState lifecycleSubState)
        Possible GGS lifecycle sub-states.
        Parameters:
        lifecycleSubState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public Deployment.Builder lifecycleDetails​(String lifecycleDetails)
        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.

        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • freeformTags

        public Deployment.Builder freeformTags​(Map<String,​String> freeformTags)
        A simple key-value pair that is applied without any predefined name, type, or scope.

        Exists for cross-compatibility only.

        Example: {"bar-key": "value"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public Deployment.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Tags defined for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"foo-namespace": {"bar-key": "value"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • isHealthy

        public Deployment.Builder isHealthy​(Boolean isHealthy)
        True if all of the aggregate resources are working correctly.
        Parameters:
        isHealthy - the value to set
        Returns:
        this builder

      • subnetId

        public Deployment.Builder subnetId​(String subnetId)
        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.

        Parameters:
        subnetId - the value to set
        Returns:
        this builder

      • loadBalancerSubnetId

        public Deployment.Builder loadBalancerSubnetId​(String loadBalancerSubnetId)
        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.

        Parameters:
        loadBalancerSubnetId - the value to set
        Returns:
        this builder

      • loadBalancerId

        public Deployment.Builder loadBalancerId​(String loadBalancerId)
        The OCID of the loadbalancer in the customer’s subnet.

        The loadbalancer of the public deployment created in the customer subnet.

        Parameters:
        loadBalancerId - the value to set
        Returns:
        this builder

      • fqdn

        public Deployment.Builder fqdn​(String fqdn)
        A three-label Fully Qualified Domain Name (FQDN) for a resource.
        Parameters:
        fqdn - the value to set
        Returns:
        this builder

      • licenseModel

        public Deployment.Builder licenseModel​(LicenseModel licenseModel)
        The Oracle license model that applies to a Deployment.
        Parameters:
        licenseModel - the value to set
        Returns:
        this builder

      • isByolCpuCoreCountLimitEnabled

        public Deployment.Builder isByolCpuCoreCountLimitEnabled​(Boolean isByolCpuCoreCountLimitEnabled)
        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.

        Parameters:
        isByolCpuCoreCountLimitEnabled - the value to set
        Returns:
        this builder

      • byolCpuCoreCountLimit

        public Deployment.Builder byolCpuCoreCountLimit​(Integer byolCpuCoreCountLimit)
        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.

        Parameters:
        byolCpuCoreCountLimit - the value to set
        Returns:
        this builder

      • environmentType

        public Deployment.Builder environmentType​(EnvironmentType environmentType)
        Specifies whether the deployment is used in a production or development/testing environment.
        Parameters:
        environmentType - the value to set
        Returns:
        this builder

      • category

        public Deployment.Builder category​(DeploymentCategory category)
        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’.

        Parameters:
        category - the value to set
        Returns:
        this builder

      • cpuCoreCount

        public Deployment.Builder cpuCoreCount​(Integer cpuCoreCount)
        The Minimum number of OCPUs to be made available for this Deployment.
        Parameters:
        cpuCoreCount - the value to set
        Returns:
        this builder

      • isAutoScalingEnabled

        public Deployment.Builder isAutoScalingEnabled​(Boolean isAutoScalingEnabled)
        Indicates if auto scaling is enabled for the Deployment’s CPU core count.
        Parameters:
        isAutoScalingEnabled - the value to set
        Returns:
        this builder

      • nsgIds

        public Deployment.Builder nsgIds​(List<String> nsgIds)
        An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
        Parameters:
        nsgIds - the value to set
        Returns:
        this builder

      • isPublic

        public Deployment.Builder isPublic​(Boolean isPublic)
        True if this object is publicly available.
        Parameters:
        isPublic - the value to set
        Returns:
        this builder

      • publicIpAddress

        public Deployment.Builder publicIpAddress​(String publicIpAddress)
        The public IP address representing the access point for the Deployment.
        Parameters:
        publicIpAddress - the value to set
        Returns:
        this builder

      • privateIpAddress

        public Deployment.Builder privateIpAddress​(String privateIpAddress)
        The private IP address in the customer’s VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
        Parameters:
        privateIpAddress - the value to set
        Returns:
        this builder

      • deploymentUrl

        public Deployment.Builder deploymentUrl​(String deploymentUrl)
        The URL of a resource.
        Parameters:
        deploymentUrl - the value to set
        Returns:
        this builder

      • systemTags

        public Deployment.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        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}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder

      • isLatestVersion

        public Deployment.Builder isLatestVersion​(Boolean isLatestVersion)
        Indicates if the resource is the the latest available version.
        Parameters:
        isLatestVersion - the value to set
        Returns:
        this builder

      • timeUpgradeRequired

        public Deployment.Builder timeUpgradeRequired​(Date timeUpgradeRequired)
        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.

        Parameters:
        timeUpgradeRequired - the value to set
        Returns:
        this builder

      • storageUtilizationInBytes

        public Deployment.Builder storageUtilizationInBytes​(Long storageUtilizationInBytes)
        The amount of storage being utilized (in bytes)
        Parameters:
        storageUtilizationInBytes - the value to set
        Returns:
        this builder

      • isStorageUtilizationLimitExceeded

        public Deployment.Builder isStorageUtilizationLimitExceeded​(Boolean isStorageUtilizationLimitExceeded)
        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.

        Parameters:
        isStorageUtilizationLimitExceeded - the value to set
        Returns:
        this builder

      • deploymentType

        public Deployment.Builder deploymentType​(DeploymentType deploymentType)
        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’.

        Parameters:
        deploymentType - the value to set
        Returns:
        this builder

      • timeOfNextMaintenance

        public Deployment.Builder timeOfNextMaintenance​(Date timeOfNextMaintenance)
        The time of next maintenance schedule.

        The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

        Parameters:
        timeOfNextMaintenance - the value to set
        Returns:
        this builder

      • nextMaintenanceActionType

        public Deployment.Builder nextMaintenanceActionType​(MaintenanceActionType nextMaintenanceActionType)
        Type of the next maintenance.
        Parameters:
        nextMaintenanceActionType - the value to set
        Returns:
        this builder

      • nextMaintenanceDescription

        public Deployment.Builder nextMaintenanceDescription​(String nextMaintenanceDescription)
        Description of the next maintenance.
        Parameters:
        nextMaintenanceDescription - the value to set
        Returns:
        this builder

      • timeOggVersionSupportedUntil

        public Deployment.Builder timeOggVersionSupportedUntil​(Date timeOggVersionSupportedUntil)
        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.

        Parameters:
        timeOggVersionSupportedUntil - the value to set
        Returns:
        this builder

      • timeLastBackupScheduled

        public Deployment.Builder timeLastBackupScheduled​(Date timeLastBackupScheduled)
        The timestamp of last deployment backup scheduled.

        The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

        Parameters:
        timeLastBackupScheduled - the value to set
        Returns:
        this builder

      • timeNextBackupScheduled

        public Deployment.Builder timeNextBackupScheduled​(Date timeNextBackupScheduled)
        The timestamp of next deployment backup scheduled.

        The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.

        Parameters:
        timeNextBackupScheduled - the value to set
        Returns:
        this builder

      • ingressIps

        public Deployment.Builder ingressIps​(List<IngressIpDetails> ingressIps)
        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.

        Parameters:
        ingressIps - the value to set
        Returns:
        this builder

      • subscriptionId

        public Deployment.Builder subscriptionId​(String subscriptionId)
        The OCID of the subscription with which resource needs to be associated with.
        Parameters:
        subscriptionId - the value to set
        Returns:
        this builder

      • clusterPlacementGroupId

        public Deployment.Builder clusterPlacementGroupId​(String clusterPlacementGroupId)
        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.

        Parameters:
        clusterPlacementGroupId - the value to set
        Returns:
        this builder

      • securityAttributes

        public Deployment.Builder securityAttributes​(Map<String,​Map<String,​Object>> securityAttributes)
        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"}}}

        Parameters:
        securityAttributes - the value to set
        Returns:
        this builder