Class DeploymentSummary.Builder
- java.lang.Object
-
- com.oracle.bmc.goldengate.model.DeploymentSummary.Builder
-
- Enclosing class:
- DeploymentSummary
public static class DeploymentSummary.Builder extends Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DeploymentSummarybuild()DeploymentSummary.BuilderbyolCpuCoreCountLimit(Integer byolCpuCoreCountLimit)The maximum number of CPUs allowed with a ‘Bring Your Own License’ (BYOL) license type.DeploymentSummary.Buildercategory(DeploymentCategory category)The deployment category defines the broad separation of the deployment type into three categories.DeploymentSummary.BuilderclusterPlacementGroupId(String clusterPlacementGroupId)The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.DeploymentSummary.BuildercompartmentId(String compartmentId)The OCID of the compartment being referenced.DeploymentSummary.Buildercopy(DeploymentSummary model)DeploymentSummary.BuildercpuCoreCount(Integer cpuCoreCount)The Minimum number of OCPUs to be made available for this Deployment.DeploymentSummary.BuilderdefinedTags(Map<String,Map<String,Object>> definedTags)Tags defined for this resource.DeploymentSummary.BuilderdeploymentType(DeploymentType deploymentType)The type of deployment, which can be any one of the Allowed values.DeploymentSummary.BuilderdeploymentUrl(String deploymentUrl)The URL of a resource.DeploymentSummary.Builderdescription(String description)Metadata about this specific object.DeploymentSummary.BuilderdisplayName(String displayName)An object’s Display Name.DeploymentSummary.BuilderenvironmentType(EnvironmentType environmentType)Specifies whether the deployment is used in a production or development/testing environment.DeploymentSummary.Builderfqdn(String fqdn)A three-label Fully Qualified Domain Name (FQDN) for a resource.DeploymentSummary.BuilderfreeformTags(Map<String,String> freeformTags)A simple key-value pair that is applied without any predefined name, type, or scope.DeploymentSummary.Builderid(String id)The OCID of the deployment being referenced.DeploymentSummary.BuilderisAutoScalingEnabled(Boolean isAutoScalingEnabled)Indicates if auto scaling is enabled for the Deployment’s CPU core count.DeploymentSummary.BuilderisByolCpuCoreCountLimitEnabled(Boolean isByolCpuCoreCountLimitEnabled)Flag to allow to configure the ‘Bring Your Own License’ (BYOL) license type CPU limit.DeploymentSummary.BuilderisLatestVersion(Boolean isLatestVersion)Indicates if the resource is the the latest available version.DeploymentSummary.BuilderisPublic(Boolean isPublic)True if this object is publicly available.DeploymentSummary.BuilderisStorageUtilizationLimitExceeded(Boolean isStorageUtilizationLimitExceeded)Deprecated: This field is not updated and will be removed in future versions.DeploymentSummary.BuilderlicenseModel(LicenseModel licenseModel)The Oracle license model that applies to a Deployment.DeploymentSummary.BuilderlifecycleDetails(String lifecycleDetails)Describes the object’s current state in detail.DeploymentSummary.BuilderlifecycleState(LifecycleState lifecycleState)Possible lifecycle states.DeploymentSummary.BuilderlifecycleSubState(LifecycleSubState lifecycleSubState)Possible GGS lifecycle sub-states.DeploymentSummary.BuilderloadBalancerId(String loadBalancerId)The OCID of the loadbalancer in the customer’s subnet.DeploymentSummary.BuilderloadBalancerSubnetId(String loadBalancerSubnetId)The OCID of a public subnet in the customer tenancy.DeploymentSummary.Builderlocks(List<ResourceLock> locks)Locks associated with this resource.DeploymentSummary.BuilderprivateIpAddress(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.DeploymentSummary.BuilderpublicIpAddress(String publicIpAddress)The public IP address representing the access point for the Deployment.DeploymentSummary.BuildersecurityAttributes(Map<String,Map<String,Object>> securityAttributes)Security attributes for this resource.DeploymentSummary.BuilderstorageUtilizationInBytes(Long storageUtilizationInBytes)The amount of storage being utilized (in bytes)DeploymentSummary.BuildersubnetId(String subnetId)The OCID of the subnet of the deployment’s private endpoint.DeploymentSummary.BuildersubscriptionId(String subscriptionId)The OCID of the subscription with which resource needs to be associated with.DeploymentSummary.BuildersystemTags(Map<String,Map<String,Object>> systemTags)The system tags associated with this resource, if any.DeploymentSummary.BuildertimeCreated(Date timeCreated)The time the resource was created.DeploymentSummary.BuildertimeUpdated(Date timeUpdated)The time the resource was last updated.DeploymentSummary.BuildertimeUpgradeRequired(Date timeUpgradeRequired)Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records to check, when deployment will be forced to upgrade to a newer version.
-
-
-
Method Detail
-
id
public DeploymentSummary.Builder id(String id)
The OCID of the deployment being referenced.- Parameters:
id- the value to set- Returns:
- this builder
-
displayName
public DeploymentSummary.Builder displayName(String displayName)
An object’s Display Name.- Parameters:
displayName- the value to set- Returns:
- this builder
-
description
public DeploymentSummary.Builder description(String description)
Metadata about this specific object.- Parameters:
description- the value to set- Returns:
- this builder
-
compartmentId
public DeploymentSummary.Builder compartmentId(String compartmentId)
The OCID of the compartment being referenced.- Parameters:
compartmentId- the value to set- Returns:
- this builder
-
timeCreated
public DeploymentSummary.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 DeploymentSummary.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 DeploymentSummary.Builder lifecycleState(LifecycleState lifecycleState)
Possible lifecycle states.- Parameters:
lifecycleState- the value to set- Returns:
- this builder
-
lifecycleSubState
public DeploymentSummary.Builder lifecycleSubState(LifecycleSubState lifecycleSubState)
Possible GGS lifecycle sub-states.- Parameters:
lifecycleSubState- the value to set- Returns:
- this builder
-
lifecycleDetails
public DeploymentSummary.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 DeploymentSummary.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 DeploymentSummary.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
-
subnetId
public DeploymentSummary.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 DeploymentSummary.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 DeploymentSummary.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
-
licenseModel
public DeploymentSummary.Builder licenseModel(LicenseModel licenseModel)
The Oracle license model that applies to a Deployment.- Parameters:
licenseModel- the value to set- Returns:
- this builder
-
isByolCpuCoreCountLimitEnabled
public DeploymentSummary.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 DeploymentSummary.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 DeploymentSummary.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 DeploymentSummary.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
-
fqdn
public DeploymentSummary.Builder fqdn(String fqdn)
A three-label Fully Qualified Domain Name (FQDN) for a resource.- Parameters:
fqdn- the value to set- Returns:
- this builder
-
cpuCoreCount
public DeploymentSummary.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 DeploymentSummary.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
-
isPublic
public DeploymentSummary.Builder isPublic(Boolean isPublic)
True if this object is publicly available.- Parameters:
isPublic- the value to set- Returns:
- this builder
-
publicIpAddress
public DeploymentSummary.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 DeploymentSummary.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 DeploymentSummary.Builder deploymentUrl(String deploymentUrl)
The URL of a resource.- Parameters:
deploymentUrl- the value to set- Returns:
- this builder
-
systemTags
public DeploymentSummary.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 DeploymentSummary.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 DeploymentSummary.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
-
deploymentType
public DeploymentSummary.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
-
storageUtilizationInBytes
public DeploymentSummary.Builder storageUtilizationInBytes(Long storageUtilizationInBytes)
The amount of storage being utilized (in bytes)- Parameters:
storageUtilizationInBytes- the value to set- Returns:
- this builder
-
isStorageUtilizationLimitExceeded
public DeploymentSummary.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
-
subscriptionId
public DeploymentSummary.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 DeploymentSummary.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 DeploymentSummary.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
-
locks
public DeploymentSummary.Builder locks(List<ResourceLock> locks)
Locks associated with this resource.- Parameters:
locks- the value to set- Returns:
- this builder
-
build
public DeploymentSummary build()
-
copy
public DeploymentSummary.Builder copy(DeploymentSummary model)
-
-