Class EmailReturnPath.Builder
- java.lang.Object
-
- com.oracle.bmc.email.model.EmailReturnPath.Builder
-
- Enclosing class:
- EmailReturnPath
public static class EmailReturnPath.Builder extends Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EmailReturnPath
build()
EmailReturnPath.Builder
cnameRecordValue(String cnameRecordValue)
The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).EmailReturnPath.Builder
compartmentId(String compartmentId)
The OCID of the compartment that contains this email return path.EmailReturnPath.Builder
copy(EmailReturnPath model)
EmailReturnPath.Builder
definedTags(Map<String,Map<String,Object>> definedTags)
Defined tags for this resource.EmailReturnPath.Builder
description(String description)
The description of the email return path.EmailReturnPath.Builder
dnsSubdomainName(String dnsSubdomainName)
The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path.EmailReturnPath.Builder
freeformTags(Map<String,String> freeformTags)
Free-form tags for this resource.EmailReturnPath.Builder
id(String id)
The OCID of the email return path.EmailReturnPath.Builder
lifecycleDetails(String lifecycleDetails)
A message describing the current state in more detail.EmailReturnPath.Builder
lifecycleState(EmailReturnPath.LifecycleState lifecycleState)
The current state of the email return path.EmailReturnPath.Builder
name(String name)
The email return path domain in the Internet Domain Name System (DNS).EmailReturnPath.Builder
parentResourceId(String parentResourceId)
The OCID of the EmailDomain that this email return path belongs to.EmailReturnPath.Builder
systemTags(Map<String,Map<String,Object>> systemTags)
Usage of system tag keys.EmailReturnPath.Builder
timeCreated(Date timeCreated)
The time the email return path was created.EmailReturnPath.Builder
timeUpdated(Date timeUpdated)
The time of the last change to the Email Return Path configuration, due to a state change or an update operation.
-
-
-
Method Detail
-
name
public EmailReturnPath.Builder name(String name)
The email return path domain in the Internet Domain Name System (DNS).Example: iad1.rp.example.com
- Parameters:
name
- the value to set- Returns:
- this builder
-
id
public EmailReturnPath.Builder id(String id)
The OCID of the email return path.- Parameters:
id
- the value to set- Returns:
- this builder
-
parentResourceId
public EmailReturnPath.Builder parentResourceId(String parentResourceId)
The OCID of the EmailDomain that this email return path belongs to.- Parameters:
parentResourceId
- the value to set- Returns:
- this builder
-
compartmentId
public EmailReturnPath.Builder compartmentId(String compartmentId)
The OCID of the compartment that contains this email return path.- Parameters:
compartmentId
- the value to set- Returns:
- this builder
-
lifecycleState
public EmailReturnPath.Builder lifecycleState(EmailReturnPath.LifecycleState lifecycleState)
The current state of the email return path.- Parameters:
lifecycleState
- the value to set- Returns:
- this builder
-
lifecycleDetails
public EmailReturnPath.Builder lifecycleDetails(String lifecycleDetails)
A message describing the current state in more detail.For example, can be used to provide actionable information for a resource in ‘Failed’ state.
- Parameters:
lifecycleDetails
- the value to set- Returns:
- this builder
-
description
public EmailReturnPath.Builder description(String description)
The description of the email return path.Avoid entering confidential information.
- Parameters:
description
- the value to set- Returns:
- this builder
-
dnsSubdomainName
public EmailReturnPath.Builder dnsSubdomainName(String dnsSubdomainName)
The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path.It is usually created with a CNAME record set to the cnameRecordValue.
- Parameters:
dnsSubdomainName
- the value to set- Returns:
- this builder
-
cnameRecordValue
public EmailReturnPath.Builder cnameRecordValue(String cnameRecordValue)
The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).- Parameters:
cnameRecordValue
- the value to set- Returns:
- this builder
-
timeCreated
public EmailReturnPath.Builder timeCreated(Date timeCreated)
The time the email return path was created.Times are expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.
Example: 2021-02-12T22:47:12.613Z
- Parameters:
timeCreated
- the value to set- Returns:
- this builder
-
timeUpdated
public EmailReturnPath.Builder timeUpdated(Date timeUpdated)
The time of the last change to the Email Return Path configuration, due to a state change or an update operation.Times are expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.
- Parameters:
timeUpdated
- the value to set- Returns:
- this builder
-
freeformTags
public EmailReturnPath.Builder freeformTags(Map<String,String> freeformTags)
Free-form tags for this resource.Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}
- Parameters:
freeformTags
- the value to set- Returns:
- this builder
-
definedTags
public EmailReturnPath.Builder definedTags(Map<String,Map<String,Object>> definedTags)
Defined tags for this resource.Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
- Parameters:
definedTags
- the value to set- Returns:
- this builder
-
systemTags
public EmailReturnPath.Builder systemTags(Map<String,Map<String,Object>> systemTags)
Usage of system tag keys.These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Parameters:
systemTags
- the value to set- Returns:
- this builder
-
build
public EmailReturnPath build()
-
copy
public EmailReturnPath.Builder copy(EmailReturnPath model)
-
-