/
email_domain.go
145 lines (120 loc) · 6.54 KB
/
email_domain.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// Email Delivery API
//
// API for the Email Delivery service. Use this API to send high-volume, application-generated
// emails. For more information, see Overview of the Email Delivery Service (https://docs.cloud.oracle.com/iaas/Content/Email/Concepts/overview.htm).
//
// **Note:** Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API.
// If a subsequent read request fails to reflect your changes, wait a few minutes and try again.
//
package email
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// EmailDomain The properties that define a email domain.
// A Email Domain contains configuration used to assert responsibility for emails sent from that domain.
type EmailDomain struct {
// The name of the email domain in the Internet Domain Name System (DNS).
// Example: `example.net`
Name *string `mandatory:"true" json:"name"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the email domain.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this email domain.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The current state of the email domain.
LifecycleState EmailDomainLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DKIM key
// that will be used to sign mail sent from this email domain.
ActiveDkimId *string `mandatory:"false" json:"activeDkimId"`
// Value of the SPF field. For more information about SPF, please see
// SPF Authentication (https://docs.cloud.oracle.com/iaas/Content/Email/Concepts/overview.htm#components).
IsSpf *bool `mandatory:"false" json:"isSpf"`
// The description of a email domain.
Description *string `mandatory:"false" json:"description"`
// The time the email domain was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format, "YYYY-MM-ddThh:mmZ".
// Example: `2021-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m EmailDomain) String() string {
return common.PointerString(m)
}
// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m EmailDomain) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingEmailDomainLifecycleStateEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetEmailDomainLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// EmailDomainLifecycleStateEnum Enum with underlying type: string
type EmailDomainLifecycleStateEnum string
// Set of constants representing the allowable values for EmailDomainLifecycleStateEnum
const (
EmailDomainLifecycleStateActive EmailDomainLifecycleStateEnum = "ACTIVE"
EmailDomainLifecycleStateCreating EmailDomainLifecycleStateEnum = "CREATING"
EmailDomainLifecycleStateDeleting EmailDomainLifecycleStateEnum = "DELETING"
EmailDomainLifecycleStateDeleted EmailDomainLifecycleStateEnum = "DELETED"
EmailDomainLifecycleStateFailed EmailDomainLifecycleStateEnum = "FAILED"
EmailDomainLifecycleStateUpdating EmailDomainLifecycleStateEnum = "UPDATING"
)
var mappingEmailDomainLifecycleStateEnum = map[string]EmailDomainLifecycleStateEnum{
"ACTIVE": EmailDomainLifecycleStateActive,
"CREATING": EmailDomainLifecycleStateCreating,
"DELETING": EmailDomainLifecycleStateDeleting,
"DELETED": EmailDomainLifecycleStateDeleted,
"FAILED": EmailDomainLifecycleStateFailed,
"UPDATING": EmailDomainLifecycleStateUpdating,
}
var mappingEmailDomainLifecycleStateEnumLowerCase = map[string]EmailDomainLifecycleStateEnum{
"active": EmailDomainLifecycleStateActive,
"creating": EmailDomainLifecycleStateCreating,
"deleting": EmailDomainLifecycleStateDeleting,
"deleted": EmailDomainLifecycleStateDeleted,
"failed": EmailDomainLifecycleStateFailed,
"updating": EmailDomainLifecycleStateUpdating,
}
// GetEmailDomainLifecycleStateEnumValues Enumerates the set of values for EmailDomainLifecycleStateEnum
func GetEmailDomainLifecycleStateEnumValues() []EmailDomainLifecycleStateEnum {
values := make([]EmailDomainLifecycleStateEnum, 0)
for _, v := range mappingEmailDomainLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetEmailDomainLifecycleStateEnumStringValues Enumerates the set of values in String for EmailDomainLifecycleStateEnum
func GetEmailDomainLifecycleStateEnumStringValues() []string {
return []string{
"ACTIVE",
"CREATING",
"DELETING",
"DELETED",
"FAILED",
"UPDATING",
}
}
// GetMappingEmailDomainLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingEmailDomainLifecycleStateEnum(val string) (EmailDomainLifecycleStateEnum, bool) {
enum, ok := mappingEmailDomainLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}