ChangeSteeringPolicyCompartmentDetails The representation of ChangeSteeringPolicyCompartmentDetails
type ChangeSteeringPolicyCompartmentDetails struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment // into which the steering policy should be moved. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeSteeringPolicyCompartmentDetails) String() string
ChangeSteeringPolicyCompartmentRequest wrapper for the ChangeSteeringPolicyCompartment operation
type ChangeSteeringPolicyCompartmentRequest struct { // The OCID of the target steering policy. SteeringPolicyId *string `mandatory:"true" contributesTo:"path" name:"steeringPolicyId"` // Details for moving a steering policy into a different compartment. ChangeSteeringPolicyCompartmentDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated before // then due to conflicting operations (for example, if a resource has been // deleted and purged from the system, then a retry of the original creation // request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ChangeSteeringPolicyCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSteeringPolicyCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSteeringPolicyCompartmentRequest) String() string
ChangeSteeringPolicyCompartmentResponse wrapper for the ChangeSteeringPolicyCompartment operation
type ChangeSteeringPolicyCompartmentResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ChangeSteeringPolicyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSteeringPolicyCompartmentResponse) String() string
ChangeTsigKeyCompartmentDetails The representation of ChangeTsigKeyCompartmentDetails
type ChangeTsigKeyCompartmentDetails struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment // into which the TSIG key should be moved. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeTsigKeyCompartmentDetails) String() string
ChangeTsigKeyCompartmentRequest wrapper for the ChangeTsigKeyCompartment operation
type ChangeTsigKeyCompartmentRequest struct { // The OCID of the target TSIG key. TsigKeyId *string `mandatory:"true" contributesTo:"path" name:"tsigKeyId"` // Details for moving a TSIG key into a different compartment. ChangeTsigKeyCompartmentDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated before // then due to conflicting operations (for example, if a resource has been // deleted and purged from the system, then a retry of the original creation // request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ChangeTsigKeyCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeTsigKeyCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeTsigKeyCompartmentRequest) String() string
ChangeTsigKeyCompartmentResponse wrapper for the ChangeTsigKeyCompartment operation
type ChangeTsigKeyCompartmentResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ChangeTsigKeyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeTsigKeyCompartmentResponse) String() string
ChangeZoneCompartmentDetails The representation of ChangeZoneCompartmentDetails
type ChangeZoneCompartmentDetails struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment // into which the zone should be moved. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeZoneCompartmentDetails) String() string
ChangeZoneCompartmentRequest wrapper for the ChangeZoneCompartment operation
type ChangeZoneCompartmentRequest struct { // The OCID of the target zone. ZoneId *string `mandatory:"true" contributesTo:"path" name:"zoneId"` // Details for moving a zone into a different compartment. ChangeZoneCompartmentDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated before // then due to conflicting operations (for example, if a resource has been // deleted and purged from the system, then a retry of the original creation // request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ChangeZoneCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeZoneCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeZoneCompartmentRequest) String() string
ChangeZoneCompartmentResponse wrapper for the ChangeZoneCompartment operation
type ChangeZoneCompartmentResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ChangeZoneCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeZoneCompartmentResponse) String() string
CreateMigratedDynectZoneDetails The body for migrating a zone from DynECT. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateMigratedDynectZoneDetails struct { // The name of the zone. Name *string `mandatory:"true" json:"name"` // The OCID of the compartment containing the zone. CompartmentId *string `mandatory:"true" json:"compartmentId"` // 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"` DynectMigrationDetails *DynectMigrationDetails `mandatory:"false" json:"dynectMigrationDetails"` }
func (m CreateMigratedDynectZoneDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateMigratedDynectZoneDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateMigratedDynectZoneDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateMigratedDynectZoneDetails) GetName() *string
GetName returns Name
func (m CreateMigratedDynectZoneDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateMigratedDynectZoneDetails) String() string
CreateSteeringPolicyAttachmentDetails The body for defining an attachment between a steering policy and a domain.
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateSteeringPolicyAttachmentDetails struct { // The OCID of the attached steering policy. SteeringPolicyId *string `mandatory:"true" json:"steeringPolicyId"` // The OCID of the attached zone. ZoneId *string `mandatory:"true" json:"zoneId"` // The attached domain within the attached zone. DomainName *string `mandatory:"true" json:"domainName"` // A user-friendly name for the steering policy attachment. // Does not have to be unique and can be changed. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` }
func (m CreateSteeringPolicyAttachmentDetails) String() string
CreateSteeringPolicyAttachmentRequest wrapper for the CreateSteeringPolicyAttachment operation
type CreateSteeringPolicyAttachmentRequest struct { // Details for creating a new steering policy attachment. CreateSteeringPolicyAttachmentDetails `contributesTo:"body"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated before // then due to conflicting operations (for example, if a resource has been // deleted and purged from the system, then a retry of the original creation // request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateSteeringPolicyAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSteeringPolicyAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSteeringPolicyAttachmentRequest) String() string
CreateSteeringPolicyAttachmentResponse wrapper for the CreateSteeringPolicyAttachment operation
type CreateSteeringPolicyAttachmentResponse struct { // The underlying http response RawResponse *http.Response // The SteeringPolicyAttachment instance SteeringPolicyAttachment `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response CreateSteeringPolicyAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSteeringPolicyAttachmentResponse) String() string
CreateSteeringPolicyDetails The body for defining a new steering policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateSteeringPolicyDetails struct { // The OCID of the compartment containing the steering policy. CompartmentId *string `mandatory:"true" json:"compartmentId"` // A user-friendly name for the steering policy. Does not have to be unique and can be changed. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // A set of predefined rules based on the desired purpose of the steering policy. Each // template utilizes Traffic Management's rules in a different order to produce the desired // results when answering DNS queries. // // **Example:** The `FAILOVER` template determines answers by filtering the policy's answers // using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, // and `LIMIT`. This gives the domain dynamic failover capability. // // It is **strongly recommended** to use a template other than `CUSTOM` when creating // a steering policy. // // All templates require the rule order to begin with an unconditional `FILTER` rule that keeps // answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined // `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. // The last rule of a template must must be a `LIMIT` rule. For more information about templates // and code examples, see Traffic Management API Guide (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). // **Template Types** // * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers // to serve. If an endpoint fails a health check, the answer for that endpoint will be removed // from the list of available answers until the endpoint is detected as healthy. // // * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. // // * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic // locations to route by, see Traffic Management Geographic Locations (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). // // * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN. // // * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address. // // * `CUSTOM` - Allows a customized configuration of rules. Template CreateSteeringPolicyDetailsTemplateEnum `mandatory:"true" json:"template"` // The Time To Live (TTL) for responses from the steering policy, in seconds. // If not specified during creation, a value of 30 seconds will be used. Ttl *int `mandatory:"false" json:"ttl"` // The OCID of the health check monitor providing health data about the answers of the // steering policy. A steering policy answer with `rdata` matching a monitored endpoint // will use the health data of that endpoint. A steering policy answer with `rdata` not // matching any monitored endpoint will be assumed healthy. // // **Note:** To use the Health Check monitoring feature in a steering policy, a monitor // must be created using the Health Checks service first. For more information on how to // create a monitor, please see Managing Health Checks (https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). HealthCheckMonitorId *string `mandatory:"false" json:"healthCheckMonitorId"` // 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"` // The set of all answers that can potentially issue from the steering policy. Answers []SteeringPolicyAnswer `mandatory:"false" json:"answers"` // The series of rules that will be processed in sequence to reduce the pool of answers // to a response for any given request. // // The first rule receives a shuffled list of all answers, and every other rule receives // the list of answers emitted by the one preceding it. The last rule populates the // response. Rules []SteeringPolicyRule `mandatory:"false" json:"rules"` }
func (m CreateSteeringPolicyDetails) String() string
func (m *CreateSteeringPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
CreateSteeringPolicyDetailsTemplateEnum Enum with underlying type: string
type CreateSteeringPolicyDetailsTemplateEnum string
Set of constants representing the allowable values for CreateSteeringPolicyDetailsTemplateEnum
const ( CreateSteeringPolicyDetailsTemplateFailover CreateSteeringPolicyDetailsTemplateEnum = "FAILOVER" CreateSteeringPolicyDetailsTemplateLoadBalance CreateSteeringPolicyDetailsTemplateEnum = "LOAD_BALANCE" CreateSteeringPolicyDetailsTemplateRouteByGeo CreateSteeringPolicyDetailsTemplateEnum = "ROUTE_BY_GEO" CreateSteeringPolicyDetailsTemplateRouteByAsn CreateSteeringPolicyDetailsTemplateEnum = "ROUTE_BY_ASN" CreateSteeringPolicyDetailsTemplateRouteByIp CreateSteeringPolicyDetailsTemplateEnum = "ROUTE_BY_IP" CreateSteeringPolicyDetailsTemplateCustom CreateSteeringPolicyDetailsTemplateEnum = "CUSTOM" )
func GetCreateSteeringPolicyDetailsTemplateEnumValues() []CreateSteeringPolicyDetailsTemplateEnum
GetCreateSteeringPolicyDetailsTemplateEnumValues Enumerates the set of values for CreateSteeringPolicyDetailsTemplateEnum
CreateSteeringPolicyRequest wrapper for the CreateSteeringPolicy operation
type CreateSteeringPolicyRequest struct { // Details for creating a new steering policy. CreateSteeringPolicyDetails `contributesTo:"body"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated before // then due to conflicting operations (for example, if a resource has been // deleted and purged from the system, then a retry of the original creation // request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateSteeringPolicyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSteeringPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSteeringPolicyRequest) String() string
CreateSteeringPolicyResponse wrapper for the CreateSteeringPolicy operation
type CreateSteeringPolicyResponse struct { // The underlying http response RawResponse *http.Response // The SteeringPolicy instance SteeringPolicy `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response CreateSteeringPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSteeringPolicyResponse) String() string
CreateTsigKeyDetails The body for defining a TSIG key. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateTsigKeyDetails struct { // TSIG key algorithms are encoded as domain names, but most consist of only one // non-empty label, which is not required to be explicitly absolute. // Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, // hmac-sha512. For more information on these algorithms, see RFC 4635 (https://tools.ietf.org/html/rfc4635#section-2). Algorithm *string `mandatory:"true" json:"algorithm"` // A globally unique domain name identifying the key for a given pair of hosts. Name *string `mandatory:"true" json:"name"` // The OCID of the compartment containing the TSIG key. CompartmentId *string `mandatory:"true" json:"compartmentId"` // A base64 string encoding the binary shared secret. Secret *string `mandatory:"true" json:"secret"` // 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"` }
func (m CreateTsigKeyDetails) String() string
CreateTsigKeyRequest wrapper for the CreateTsigKey operation
type CreateTsigKeyRequest struct { // Details for creating a new TSIG key. CreateTsigKeyDetails `contributesTo:"body"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateTsigKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTsigKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTsigKeyRequest) String() string
CreateTsigKeyResponse wrapper for the CreateTsigKey operation
type CreateTsigKeyResponse struct { // The underlying http response RawResponse *http.Response // The TsigKey instance TsigKey `presentIn:"body"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateTsigKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTsigKeyResponse) String() string
CreateZoneBaseDetails The body for either defining a new zone or migrating a zone from migrationSource. This is determined by the migrationSource discriminator. NONE indicates creation of a new zone (default). DYNECT indicates migration from a DynECT zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateZoneBaseDetails interface { // The name of the zone. GetName() *string // The OCID of the compartment containing the zone. GetCompartmentId() *string // 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"}` GetFreeformTags() map[string]string // 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"}}` GetDefinedTags() map[string]map[string]interface{} }
CreateZoneBaseDetailsMigrationSourceEnum Enum with underlying type: string
type CreateZoneBaseDetailsMigrationSourceEnum string
Set of constants representing the allowable values for CreateZoneBaseDetailsMigrationSourceEnum
const ( CreateZoneBaseDetailsMigrationSourceNone CreateZoneBaseDetailsMigrationSourceEnum = "NONE" CreateZoneBaseDetailsMigrationSourceDynect CreateZoneBaseDetailsMigrationSourceEnum = "DYNECT" )
func GetCreateZoneBaseDetailsMigrationSourceEnumValues() []CreateZoneBaseDetailsMigrationSourceEnum
GetCreateZoneBaseDetailsMigrationSourceEnumValues Enumerates the set of values for CreateZoneBaseDetailsMigrationSourceEnum
CreateZoneDetails The body for defining a new zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateZoneDetails struct { // The name of the zone. Name *string `mandatory:"true" json:"name"` // The OCID of the compartment containing the zone. CompartmentId *string `mandatory:"true" json:"compartmentId"` // 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"` // External master servers for the zone. `externalMasters` becomes a // required parameter when the `zoneType` value is `SECONDARY`. ExternalMasters []ExternalMaster `mandatory:"false" json:"externalMasters"` // The type of the zone. Must be either `PRIMARY` or `SECONDARY`. ZoneType CreateZoneDetailsZoneTypeEnum `mandatory:"false" json:"zoneType,omitempty"` }
func (m CreateZoneDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateZoneDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateZoneDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateZoneDetails) GetName() *string
GetName returns Name
func (m CreateZoneDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateZoneDetails) String() string
CreateZoneDetailsZoneTypeEnum Enum with underlying type: string
type CreateZoneDetailsZoneTypeEnum string
Set of constants representing the allowable values for CreateZoneDetailsZoneTypeEnum
const ( CreateZoneDetailsZoneTypePrimary CreateZoneDetailsZoneTypeEnum = "PRIMARY" CreateZoneDetailsZoneTypeSecondary CreateZoneDetailsZoneTypeEnum = "SECONDARY" )
func GetCreateZoneDetailsZoneTypeEnumValues() []CreateZoneDetailsZoneTypeEnum
GetCreateZoneDetailsZoneTypeEnumValues Enumerates the set of values for CreateZoneDetailsZoneTypeEnum
CreateZoneRequest wrapper for the CreateZone operation
type CreateZoneRequest struct { // Details for creating a new zone. CreateZoneDetails CreateZoneBaseDetails `contributesTo:"body"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateZoneRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateZoneRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateZoneRequest) String() string
CreateZoneResponse wrapper for the CreateZone operation
type CreateZoneResponse struct { // The underlying http response RawResponse *http.Response // The Zone instance Zone `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the zone, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response CreateZoneResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateZoneResponse) String() string
DeleteDomainRecordsRequest wrapper for the DeleteDomainRecords operation
type DeleteDomainRecordsRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The target fully-qualified domain name (FQDN) within the target zone. Domain *string `mandatory:"true" contributesTo:"path" name:"domain"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteDomainRecordsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDomainRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDomainRecordsRequest) String() string
DeleteDomainRecordsResponse wrapper for the DeleteDomainRecords operation
type DeleteDomainRecordsResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteDomainRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDomainRecordsResponse) String() string
DeleteRRSetRequest wrapper for the DeleteRRSet operation
type DeleteRRSetRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The target fully-qualified domain name (FQDN) within the target zone. Domain *string `mandatory:"true" contributesTo:"path" name:"domain"` // The type of the target RRSet within the target zone. Rtype *string `mandatory:"true" contributesTo:"path" name:"rtype"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteRRSetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRRSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRRSetRequest) String() string
DeleteRRSetResponse wrapper for the DeleteRRSet operation
type DeleteRRSetResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteRRSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRRSetResponse) String() string
DeleteSteeringPolicyAttachmentRequest wrapper for the DeleteSteeringPolicyAttachment operation
type DeleteSteeringPolicyAttachmentRequest struct { // The OCID of the target steering policy attachment. SteeringPolicyAttachmentId *string `mandatory:"true" contributesTo:"path" name:"steeringPolicyAttachmentId"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteSteeringPolicyAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSteeringPolicyAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSteeringPolicyAttachmentRequest) String() string
DeleteSteeringPolicyAttachmentResponse wrapper for the DeleteSteeringPolicyAttachment operation
type DeleteSteeringPolicyAttachmentResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteSteeringPolicyAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSteeringPolicyAttachmentResponse) String() string
DeleteSteeringPolicyRequest wrapper for the DeleteSteeringPolicy operation
type DeleteSteeringPolicyRequest struct { // The OCID of the target steering policy. SteeringPolicyId *string `mandatory:"true" contributesTo:"path" name:"steeringPolicyId"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteSteeringPolicyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSteeringPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSteeringPolicyRequest) String() string
DeleteSteeringPolicyResponse wrapper for the DeleteSteeringPolicy operation
type DeleteSteeringPolicyResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteSteeringPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSteeringPolicyResponse) String() string
DeleteTsigKeyRequest wrapper for the DeleteTsigKey operation
type DeleteTsigKeyRequest struct { // The OCID of the target TSIG key. TsigKeyId *string `mandatory:"true" contributesTo:"path" name:"tsigKeyId"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteTsigKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteTsigKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteTsigKeyRequest) String() string
DeleteTsigKeyResponse wrapper for the DeleteTsigKey operation
type DeleteTsigKeyResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Unique Oracle-assigned identifier for the asynchronous request. // You can use this to query status of the asynchronous operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` }
func (response DeleteTsigKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteTsigKeyResponse) String() string
DeleteZoneRequest wrapper for the DeleteZone operation
type DeleteZoneRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteZoneRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteZoneRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteZoneRequest) String() string
DeleteZoneResponse wrapper for the DeleteZone operation
type DeleteZoneResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteZoneResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteZoneResponse) String() string
DnsClient a client for Dns
type DnsClient struct { common.BaseClient // contains filtered or unexported fields }
func NewDnsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DnsClient, err error)
NewDnsClientWithConfigurationProvider Creates a new default Dns client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDnsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DnsClient, err error)
NewDnsClientWithOboToken Creates a new default Dns client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client DnsClient) ChangeSteeringPolicyCompartment(ctx context.Context, request ChangeSteeringPolicyCompartmentRequest) (response ChangeSteeringPolicyCompartmentResponse, err error)
ChangeSteeringPolicyCompartment Moves a steering policy into a different compartment.
func (client DnsClient) ChangeTsigKeyCompartment(ctx context.Context, request ChangeTsigKeyCompartmentRequest) (response ChangeTsigKeyCompartmentResponse, err error)
ChangeTsigKeyCompartment Moves a TSIG key into a different compartment.
func (client DnsClient) ChangeZoneCompartment(ctx context.Context, request ChangeZoneCompartmentRequest) (response ChangeZoneCompartmentResponse, err error)
ChangeZoneCompartment Moves a zone into a different compartment. **Note:** All SteeringPolicyAttachment objects associated with this zone will also be moved into the provided compartment.
func (client *DnsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DnsClient) CreateSteeringPolicy(ctx context.Context, request CreateSteeringPolicyRequest) (response CreateSteeringPolicyResponse, err error)
CreateSteeringPolicy Creates a new steering policy in the specified compartment. For more information on creating policies with templates, see Traffic Management API Guide (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm).
func (client DnsClient) CreateSteeringPolicyAttachment(ctx context.Context, request CreateSteeringPolicyAttachmentRequest) (response CreateSteeringPolicyAttachmentResponse, err error)
CreateSteeringPolicyAttachment Creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain. A steering policy must be attached to a domain for the policy to answer DNS queries for that domain. For the purposes of access control, the attachment is automatically placed into the same compartment as the domain's zone.
func (client DnsClient) CreateTsigKey(ctx context.Context, request CreateTsigKeyRequest) (response CreateTsigKeyResponse, err error)
CreateTsigKey Creates a new TSIG key in the specified compartment. There is no `opc-retry-token` header since TSIG key names must be globally unique.
func (client DnsClient) CreateZone(ctx context.Context, request CreateZoneRequest) (response CreateZoneResponse, err error)
CreateZone Creates a new zone in the specified compartment. The `compartmentId` query parameter is required if the `Content-Type` header for the request is `text/dns`.
func (client DnsClient) DeleteDomainRecords(ctx context.Context, request DeleteDomainRecordsRequest) (response DeleteDomainRecordsResponse, err error)
DeleteDomainRecords Deletes all records at the specified zone and domain.
func (client DnsClient) DeleteRRSet(ctx context.Context, request DeleteRRSetRequest) (response DeleteRRSetResponse, err error)
DeleteRRSet Deletes all records in the specified RRSet.
func (client DnsClient) DeleteSteeringPolicy(ctx context.Context, request DeleteSteeringPolicyRequest) (response DeleteSteeringPolicyResponse, err error)
DeleteSteeringPolicy Deletes the specified steering policy. A `204` response indicates that the delete has been successful. Deletion will fail if the policy is attached to any zones. To detach a policy from a zone, see `DeleteSteeringPolicyAttachment`.
func (client DnsClient) DeleteSteeringPolicyAttachment(ctx context.Context, request DeleteSteeringPolicyAttachmentRequest) (response DeleteSteeringPolicyAttachmentResponse, err error)
DeleteSteeringPolicyAttachment Deletes the specified steering policy attachment. A `204` response indicates that the delete has been successful.
func (client DnsClient) DeleteTsigKey(ctx context.Context, request DeleteTsigKeyRequest) (response DeleteTsigKeyResponse, err error)
DeleteTsigKey Deletes the specified TSIG key.
func (client DnsClient) DeleteZone(ctx context.Context, request DeleteZoneRequest) (response DeleteZoneResponse, err error)
DeleteZone Deletes the specified zone and all its steering policy attachments. A `204` response indicates that zone has been successfully deleted.
func (client DnsClient) GetDomainRecords(ctx context.Context, request GetDomainRecordsRequest) (response GetDomainRecordsResponse, err error)
GetDomainRecords Gets a list of all records at the specified zone and domain. The results are sorted by `rtype` in alphabetical order by default. You can optionally filter and/or sort the results using the listed parameters.
func (client DnsClient) GetRRSet(ctx context.Context, request GetRRSetRequest) (response GetRRSetResponse, err error)
GetRRSet Gets a list of all records in the specified RRSet. The results are sorted by `recordHash` by default.
func (client DnsClient) GetSteeringPolicy(ctx context.Context, request GetSteeringPolicyRequest) (response GetSteeringPolicyResponse, err error)
GetSteeringPolicy Gets information about the specified steering policy.
func (client DnsClient) GetSteeringPolicyAttachment(ctx context.Context, request GetSteeringPolicyAttachmentRequest) (response GetSteeringPolicyAttachmentResponse, err error)
GetSteeringPolicyAttachment Gets information about the specified steering policy attachment.
func (client DnsClient) GetTsigKey(ctx context.Context, request GetTsigKeyRequest) (response GetTsigKeyResponse, err error)
GetTsigKey Gets information about the specified TSIG key.
func (client DnsClient) GetZone(ctx context.Context, request GetZoneRequest) (response GetZoneResponse, err error)
GetZone Gets information about the specified zone, including its creation date, zone type, and serial.
func (client DnsClient) GetZoneRecords(ctx context.Context, request GetZoneRecordsRequest) (response GetZoneRecordsResponse, err error)
GetZoneRecords Gets all records in the specified zone. The results are sorted by `domain` in alphabetical order by default. For more information about records, see Resource Record (RR) TYPEs (https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4).
func (client DnsClient) ListSteeringPolicies(ctx context.Context, request ListSteeringPoliciesRequest) (response ListSteeringPoliciesResponse, err error)
ListSteeringPolicies Gets a list of all steering policies in the specified compartment.
func (client DnsClient) ListSteeringPolicyAttachments(ctx context.Context, request ListSteeringPolicyAttachmentsRequest) (response ListSteeringPolicyAttachmentsResponse, err error)
ListSteeringPolicyAttachments Lists the steering policy attachments in the specified compartment.
func (client DnsClient) ListTsigKeys(ctx context.Context, request ListTsigKeysRequest) (response ListTsigKeysResponse, err error)
ListTsigKeys Gets a list of all TSIG keys in the specified compartment.
func (client DnsClient) ListZones(ctx context.Context, request ListZonesRequest) (response ListZonesResponse, err error)
ListZones Gets a list of all zones in the specified compartment. The collection can be filtered by name, time created, and zone type.
func (client DnsClient) PatchDomainRecords(ctx context.Context, request PatchDomainRecordsRequest) (response PatchDomainRecordsResponse, err error)
PatchDomainRecords Updates records in the specified zone at a domain. You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function.
func (client DnsClient) PatchRRSet(ctx context.Context, request PatchRRSetRequest) (response PatchRRSetResponse, err error)
PatchRRSet Updates records in the specified RRSet.
func (client DnsClient) PatchZoneRecords(ctx context.Context, request PatchZoneRecordsRequest) (response PatchZoneRecordsResponse, err error)
PatchZoneRecords Updates a collection of records in the specified zone. You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function.
func (client *DnsClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DnsClient) UpdateDomainRecords(ctx context.Context, request UpdateDomainRecordsRequest) (response UpdateDomainRecordsResponse, err error)
UpdateDomainRecords Replaces records in the specified zone at a domain with the records specified in the request body. If a specified record does not exist, it will be created. If the record exists, then it will be updated to represent the record in the body of the request. If a record in the zone does not exist in the request body, the record will be removed from the zone.
func (client DnsClient) UpdateRRSet(ctx context.Context, request UpdateRRSetRequest) (response UpdateRRSetResponse, err error)
UpdateRRSet Replaces records in the specified RRSet.
func (client DnsClient) UpdateSteeringPolicy(ctx context.Context, request UpdateSteeringPolicyRequest) (response UpdateSteeringPolicyResponse, err error)
UpdateSteeringPolicy Updates the configuration of the specified steering policy.
func (client DnsClient) UpdateSteeringPolicyAttachment(ctx context.Context, request UpdateSteeringPolicyAttachmentRequest) (response UpdateSteeringPolicyAttachmentResponse, err error)
UpdateSteeringPolicyAttachment Updates the specified steering policy attachment with your new information.
func (client DnsClient) UpdateTsigKey(ctx context.Context, request UpdateTsigKeyRequest) (response UpdateTsigKeyResponse, err error)
UpdateTsigKey Updates the specified TSIG key.
func (client DnsClient) UpdateZone(ctx context.Context, request UpdateZoneRequest) (response UpdateZoneResponse, err error)
UpdateZone Updates the specified secondary zone with your new external master server information. For more information about secondary zone, see Manage DNS Service Zone (https://docs.cloud.oracle.com/iaas/Content/DNS/Tasks/managingdnszones.htm).
func (client DnsClient) UpdateZoneRecords(ctx context.Context, request UpdateZoneRecordsRequest) (response UpdateZoneRecordsResponse, err error)
UpdateZoneRecords Replaces records in the specified zone with the records specified in the request body. If a specified record does not exist, it will be created. If the record exists, then it will be updated to represent the record in the body of the request. If a record in the zone does not exist in the request body, the record will be removed from the zone.
DynectMigrationDetails Details specific to performing a DynECT zone migration.
type DynectMigrationDetails struct { // DynECT customer name the zone belongs to. CustomerName *string `mandatory:"true" json:"customerName"` // DynECT API username to perform the migration with. Username *string `mandatory:"true" json:"username"` // DynECT API password for the provided username. Password *string `mandatory:"true" json:"password"` // A map of fully-qualified domain names (FQDNs) to an array of `MigrationReplacement` objects. HttpRedirectReplacements map[string][]MigrationReplacement `mandatory:"false" json:"httpRedirectReplacements"` }
func (m DynectMigrationDetails) String() string
ExternalMaster An external master name server used as the source of zone data. May either have a zone-embedded TSIG or reference a TSIG key by OCID, but not both.
type ExternalMaster struct { // The server's IP address (IPv4 or IPv6). Address *string `mandatory:"true" json:"address"` // The server's port. Port value must be a value of 53, otherwise omit // the port value. Port *int `mandatory:"false" json:"port"` Tsig *Tsig `mandatory:"false" json:"tsig"` // The OCID of the TSIG key. TsigKeyId *string `mandatory:"false" json:"tsigKeyId"` }
func (m ExternalMaster) String() string
GetDomainRecordsRequest wrapper for the GetDomainRecords operation
type GetDomainRecordsRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The target fully-qualified domain name (FQDN) within the target zone. Domain *string `mandatory:"true" contributesTo:"path" name:"domain"` // The `If-None-Match` header field makes the request method conditional on // the absence of any current representation of the target resource, when // the field-value is `*`, or having a selected representation with an // entity-tag that does not match any of those listed in the field-value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"If-None-Match"` // The `If-Modified-Since` header field makes a GET or HEAD request method // conditional on the selected representation's modification date being more // recent than the date provided in the field-value. Transfer of the // selected representation's data is avoided if that data has not changed. IfModifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Modified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The maximum number of items to return in a page of the collection. Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The version of the zone for which data is requested. ZoneVersion *string `mandatory:"false" contributesTo:"query" name:"zoneVersion"` // Search by record type. // Will match any record whose type (https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value. Rtype *string `mandatory:"false" contributesTo:"query" name:"rtype"` // The field by which to sort records. SortBy GetDomainRecordsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The order to sort the resources. SortOrder GetDomainRecordsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetDomainRecordsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDomainRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDomainRecordsRequest) String() string
GetDomainRecordsResponse wrapper for the GetDomainRecords operation
type GetDomainRecordsResponse struct { // The underlying http response RawResponse *http.Response // A list of RecordCollection instances RecordCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response GetDomainRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDomainRecordsResponse) String() string
GetDomainRecordsSortByEnum Enum with underlying type: string
type GetDomainRecordsSortByEnum string
Set of constants representing the allowable values for GetDomainRecordsSortByEnum
const ( GetDomainRecordsSortByRtype GetDomainRecordsSortByEnum = "rtype" GetDomainRecordsSortByTtl GetDomainRecordsSortByEnum = "ttl" )
func GetGetDomainRecordsSortByEnumValues() []GetDomainRecordsSortByEnum
GetGetDomainRecordsSortByEnumValues Enumerates the set of values for GetDomainRecordsSortByEnum
GetDomainRecordsSortOrderEnum Enum with underlying type: string
type GetDomainRecordsSortOrderEnum string
Set of constants representing the allowable values for GetDomainRecordsSortOrderEnum
const ( GetDomainRecordsSortOrderAsc GetDomainRecordsSortOrderEnum = "ASC" GetDomainRecordsSortOrderDesc GetDomainRecordsSortOrderEnum = "DESC" )
func GetGetDomainRecordsSortOrderEnumValues() []GetDomainRecordsSortOrderEnum
GetGetDomainRecordsSortOrderEnumValues Enumerates the set of values for GetDomainRecordsSortOrderEnum
GetRRSetRequest wrapper for the GetRRSet operation
type GetRRSetRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The target fully-qualified domain name (FQDN) within the target zone. Domain *string `mandatory:"true" contributesTo:"path" name:"domain"` // The type of the target RRSet within the target zone. Rtype *string `mandatory:"true" contributesTo:"path" name:"rtype"` // The `If-None-Match` header field makes the request method conditional on // the absence of any current representation of the target resource, when // the field-value is `*`, or having a selected representation with an // entity-tag that does not match any of those listed in the field-value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"If-None-Match"` // The `If-Modified-Since` header field makes a GET or HEAD request method // conditional on the selected representation's modification date being more // recent than the date provided in the field-value. Transfer of the // selected representation's data is avoided if that data has not changed. IfModifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Modified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The maximum number of items to return in a page of the collection. Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The version of the zone for which data is requested. ZoneVersion *string `mandatory:"false" contributesTo:"query" name:"zoneVersion"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetRRSetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRRSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRRSetRequest) String() string
GetRRSetResponse wrapper for the GetRRSet operation
type GetRRSetResponse struct { // The underlying http response RawResponse *http.Response // A list of RrSet instances RrSet `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response GetRRSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRRSetResponse) String() string
GetSteeringPolicyAttachmentRequest wrapper for the GetSteeringPolicyAttachment operation
type GetSteeringPolicyAttachmentRequest struct { // The OCID of the target steering policy attachment. SteeringPolicyAttachmentId *string `mandatory:"true" contributesTo:"path" name:"steeringPolicyAttachmentId"` // The `If-None-Match` header field makes the request method conditional on // the absence of any current representation of the target resource, when // the field-value is `*`, or having a selected representation with an // entity-tag that does not match any of those listed in the field-value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"If-None-Match"` // The `If-Modified-Since` header field makes a GET or HEAD request method // conditional on the selected representation's modification date being more // recent than the date provided in the field-value. Transfer of the // selected representation's data is avoided if that data has not changed. IfModifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Modified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetSteeringPolicyAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSteeringPolicyAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSteeringPolicyAttachmentRequest) String() string
GetSteeringPolicyAttachmentResponse wrapper for the GetSteeringPolicyAttachment operation
type GetSteeringPolicyAttachmentResponse struct { // The underlying http response RawResponse *http.Response // The SteeringPolicyAttachment instance SteeringPolicyAttachment `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` // Flag to indicate whether or not the object was modified. If this is true, // the getter for the object itself will return null. Callers should check this // if they specified one of the request params that might result in a conditional // response (like 'if-match'/'if-none-match'). IsNotModified bool }
func (response GetSteeringPolicyAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSteeringPolicyAttachmentResponse) String() string
GetSteeringPolicyRequest wrapper for the GetSteeringPolicy operation
type GetSteeringPolicyRequest struct { // The OCID of the target steering policy. SteeringPolicyId *string `mandatory:"true" contributesTo:"path" name:"steeringPolicyId"` // The `If-None-Match` header field makes the request method conditional on // the absence of any current representation of the target resource, when // the field-value is `*`, or having a selected representation with an // entity-tag that does not match any of those listed in the field-value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"If-None-Match"` // The `If-Modified-Since` header field makes a GET or HEAD request method // conditional on the selected representation's modification date being more // recent than the date provided in the field-value. Transfer of the // selected representation's data is avoided if that data has not changed. IfModifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Modified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetSteeringPolicyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSteeringPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSteeringPolicyRequest) String() string
GetSteeringPolicyResponse wrapper for the GetSteeringPolicy operation
type GetSteeringPolicyResponse struct { // The underlying http response RawResponse *http.Response // The SteeringPolicy instance SteeringPolicy `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` // Flag to indicate whether or not the object was modified. If this is true, // the getter for the object itself will return null. Callers should check this // if they specified one of the request params that might result in a conditional // response (like 'if-match'/'if-none-match'). IsNotModified bool }
func (response GetSteeringPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSteeringPolicyResponse) String() string
GetTsigKeyRequest wrapper for the GetTsigKey operation
type GetTsigKeyRequest struct { // The OCID of the target TSIG key. TsigKeyId *string `mandatory:"true" contributesTo:"path" name:"tsigKeyId"` // The `If-None-Match` header field makes the request method conditional on // the absence of any current representation of the target resource, when // the field-value is `*`, or having a selected representation with an // entity-tag that does not match any of those listed in the field-value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"If-None-Match"` // The `If-Modified-Since` header field makes a GET or HEAD request method // conditional on the selected representation's modification date being more // recent than the date provided in the field-value. Transfer of the // selected representation's data is avoided if that data has not changed. IfModifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Modified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetTsigKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTsigKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTsigKeyRequest) String() string
GetTsigKeyResponse wrapper for the GetTsigKey operation
type GetTsigKeyResponse struct { // The underlying http response RawResponse *http.Response // The TsigKey instance TsigKey `presentIn:"body"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Flag to indicate whether or not the object was modified. If this is true, // the getter for the object itself will return null. Callers should check this // if they specified one of the request params that might result in a conditional // response (like 'if-match'/'if-none-match'). IsNotModified bool }
func (response GetTsigKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTsigKeyResponse) String() string
GetZoneRecordsRequest wrapper for the GetZoneRecords operation
type GetZoneRecordsRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The `If-None-Match` header field makes the request method conditional on // the absence of any current representation of the target resource, when // the field-value is `*`, or having a selected representation with an // entity-tag that does not match any of those listed in the field-value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"If-None-Match"` // The `If-Modified-Since` header field makes a GET or HEAD request method // conditional on the selected representation's modification date being more // recent than the date provided in the field-value. Transfer of the // selected representation's data is avoided if that data has not changed. IfModifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Modified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The maximum number of items to return in a page of the collection. Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The version of the zone for which data is requested. ZoneVersion *string `mandatory:"false" contributesTo:"query" name:"zoneVersion"` // Search by domain. // Will match any record whose domain (case-insensitive) equals the provided value. Domain *string `mandatory:"false" contributesTo:"query" name:"domain"` // Search by domain. // Will match any record whose domain (case-insensitive) contains the provided value. DomainContains *string `mandatory:"false" contributesTo:"query" name:"domainContains"` // Search by record type. // Will match any record whose type (https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value. Rtype *string `mandatory:"false" contributesTo:"query" name:"rtype"` // The field by which to sort records. SortBy GetZoneRecordsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The order to sort the resources. SortOrder GetZoneRecordsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetZoneRecordsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetZoneRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetZoneRecordsRequest) String() string
GetZoneRecordsResponse wrapper for the GetZoneRecords operation
type GetZoneRecordsResponse struct { // The underlying http response RawResponse *http.Response // A list of RecordCollection instances RecordCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response GetZoneRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetZoneRecordsResponse) String() string
GetZoneRecordsSortByEnum Enum with underlying type: string
type GetZoneRecordsSortByEnum string
Set of constants representing the allowable values for GetZoneRecordsSortByEnum
const ( GetZoneRecordsSortByDomain GetZoneRecordsSortByEnum = "domain" GetZoneRecordsSortByRtype GetZoneRecordsSortByEnum = "rtype" GetZoneRecordsSortByTtl GetZoneRecordsSortByEnum = "ttl" )
func GetGetZoneRecordsSortByEnumValues() []GetZoneRecordsSortByEnum
GetGetZoneRecordsSortByEnumValues Enumerates the set of values for GetZoneRecordsSortByEnum
GetZoneRecordsSortOrderEnum Enum with underlying type: string
type GetZoneRecordsSortOrderEnum string
Set of constants representing the allowable values for GetZoneRecordsSortOrderEnum
const ( GetZoneRecordsSortOrderAsc GetZoneRecordsSortOrderEnum = "ASC" GetZoneRecordsSortOrderDesc GetZoneRecordsSortOrderEnum = "DESC" )
func GetGetZoneRecordsSortOrderEnumValues() []GetZoneRecordsSortOrderEnum
GetGetZoneRecordsSortOrderEnumValues Enumerates the set of values for GetZoneRecordsSortOrderEnum
GetZoneRequest wrapper for the GetZone operation
type GetZoneRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The `If-None-Match` header field makes the request method conditional on // the absence of any current representation of the target resource, when // the field-value is `*`, or having a selected representation with an // entity-tag that does not match any of those listed in the field-value. IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"If-None-Match"` // The `If-Modified-Since` header field makes a GET or HEAD request method // conditional on the selected representation's modification date being more // recent than the date provided in the field-value. Transfer of the // selected representation's data is avoided if that data has not changed. IfModifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Modified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetZoneRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetZoneRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetZoneRequest) String() string
GetZoneResponse wrapper for the GetZone operation
type GetZoneResponse struct { // The underlying http response RawResponse *http.Response // The Zone instance Zone `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the zone, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response GetZoneResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetZoneResponse) String() string
ListSteeringPoliciesRequest wrapper for the ListSteeringPolicies operation
type ListSteeringPoliciesRequest struct { // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The maximum number of items to return in a page of the collection. Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The OCID of a resource. Id *string `mandatory:"false" contributesTo:"query" name:"id"` // The displayName of a resource. DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"` // The partial displayName of a resource. Will match any resource whose name // (case-insensitive) contains the provided value. DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"` // Search by health check monitor OCID. // Will match any resource whose health check monitor ID matches the provided value. HealthCheckMonitorId *string `mandatory:"false" contributesTo:"query" name:"healthCheckMonitorId"` // An RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) timestamp that states // all returned resources were created on or after the indicated time. TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"` // An RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) timestamp that states // all returned resources were created before the indicated time. TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"` // Search by steering template type. // Will match any resource whose template type matches the provided value. Template *string `mandatory:"false" contributesTo:"query" name:"template"` // The state of a resource. LifecycleState SteeringPolicySummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // The field by which to sort steering policies. If unspecified, defaults to `timeCreated`. SortBy ListSteeringPoliciesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The order to sort the resources. SortOrder ListSteeringPoliciesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListSteeringPoliciesRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSteeringPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSteeringPoliciesRequest) String() string
ListSteeringPoliciesResponse wrapper for the ListSteeringPolicies operation
type ListSteeringPoliciesResponse struct { // The underlying http response RawResponse *http.Response // A list of []SteeringPolicySummary instances Items []SteeringPolicySummary `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListSteeringPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSteeringPoliciesResponse) String() string
ListSteeringPoliciesSortByEnum Enum with underlying type: string
type ListSteeringPoliciesSortByEnum string
Set of constants representing the allowable values for ListSteeringPoliciesSortByEnum
const ( ListSteeringPoliciesSortByDisplayname ListSteeringPoliciesSortByEnum = "displayName" ListSteeringPoliciesSortByTimecreated ListSteeringPoliciesSortByEnum = "timeCreated" ListSteeringPoliciesSortByTemplate ListSteeringPoliciesSortByEnum = "template" )
func GetListSteeringPoliciesSortByEnumValues() []ListSteeringPoliciesSortByEnum
GetListSteeringPoliciesSortByEnumValues Enumerates the set of values for ListSteeringPoliciesSortByEnum
ListSteeringPoliciesSortOrderEnum Enum with underlying type: string
type ListSteeringPoliciesSortOrderEnum string
Set of constants representing the allowable values for ListSteeringPoliciesSortOrderEnum
const ( ListSteeringPoliciesSortOrderAsc ListSteeringPoliciesSortOrderEnum = "ASC" ListSteeringPoliciesSortOrderDesc ListSteeringPoliciesSortOrderEnum = "DESC" )
func GetListSteeringPoliciesSortOrderEnumValues() []ListSteeringPoliciesSortOrderEnum
GetListSteeringPoliciesSortOrderEnumValues Enumerates the set of values for ListSteeringPoliciesSortOrderEnum
ListSteeringPolicyAttachmentsRequest wrapper for the ListSteeringPolicyAttachments operation
type ListSteeringPolicyAttachmentsRequest struct { // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The maximum number of items to return in a page of the collection. Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The OCID of a resource. Id *string `mandatory:"false" contributesTo:"query" name:"id"` // The displayName of a resource. DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"` // Search by steering policy OCID. // Will match any resource whose steering policy ID matches the provided value. SteeringPolicyId *string `mandatory:"false" contributesTo:"query" name:"steeringPolicyId"` // Search by zone OCID. // Will match any resource whose zone ID matches the provided value. ZoneId *string `mandatory:"false" contributesTo:"query" name:"zoneId"` // Search by domain. // Will match any record whose domain (case-insensitive) equals the provided value. Domain *string `mandatory:"false" contributesTo:"query" name:"domain"` // Search by domain. // Will match any record whose domain (case-insensitive) contains the provided value. DomainContains *string `mandatory:"false" contributesTo:"query" name:"domainContains"` // An RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) timestamp that states // all returned resources were created on or after the indicated time. TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"` // An RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) timestamp that states // all returned resources were created before the indicated time. TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"` // The state of a resource. LifecycleState SteeringPolicyAttachmentSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`. SortBy ListSteeringPolicyAttachmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The order to sort the resources. SortOrder ListSteeringPolicyAttachmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListSteeringPolicyAttachmentsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSteeringPolicyAttachmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSteeringPolicyAttachmentsRequest) String() string
ListSteeringPolicyAttachmentsResponse wrapper for the ListSteeringPolicyAttachments operation
type ListSteeringPolicyAttachmentsResponse struct { // The underlying http response RawResponse *http.Response // A list of []SteeringPolicyAttachmentSummary instances Items []SteeringPolicyAttachmentSummary `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListSteeringPolicyAttachmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSteeringPolicyAttachmentsResponse) String() string
ListSteeringPolicyAttachmentsSortByEnum Enum with underlying type: string
type ListSteeringPolicyAttachmentsSortByEnum string
Set of constants representing the allowable values for ListSteeringPolicyAttachmentsSortByEnum
const ( ListSteeringPolicyAttachmentsSortByDisplayname ListSteeringPolicyAttachmentsSortByEnum = "displayName" ListSteeringPolicyAttachmentsSortByTimecreated ListSteeringPolicyAttachmentsSortByEnum = "timeCreated" ListSteeringPolicyAttachmentsSortByDomainname ListSteeringPolicyAttachmentsSortByEnum = "domainName" )
func GetListSteeringPolicyAttachmentsSortByEnumValues() []ListSteeringPolicyAttachmentsSortByEnum
GetListSteeringPolicyAttachmentsSortByEnumValues Enumerates the set of values for ListSteeringPolicyAttachmentsSortByEnum
ListSteeringPolicyAttachmentsSortOrderEnum Enum with underlying type: string
type ListSteeringPolicyAttachmentsSortOrderEnum string
Set of constants representing the allowable values for ListSteeringPolicyAttachmentsSortOrderEnum
const ( ListSteeringPolicyAttachmentsSortOrderAsc ListSteeringPolicyAttachmentsSortOrderEnum = "ASC" ListSteeringPolicyAttachmentsSortOrderDesc ListSteeringPolicyAttachmentsSortOrderEnum = "DESC" )
func GetListSteeringPolicyAttachmentsSortOrderEnumValues() []ListSteeringPolicyAttachmentsSortOrderEnum
GetListSteeringPolicyAttachmentsSortOrderEnumValues Enumerates the set of values for ListSteeringPolicyAttachmentsSortOrderEnum
ListTsigKeysRequest wrapper for the ListTsigKeys operation
type ListTsigKeysRequest struct { // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The maximum number of items to return in a page of the collection. Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The OCID of a resource. Id *string `mandatory:"false" contributesTo:"query" name:"id"` // The name of a resource. Name *string `mandatory:"false" contributesTo:"query" name:"name"` // The state of a resource. LifecycleState TsigKeySummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // The field by which to sort TSIG keys. If unspecified, defaults to `timeCreated`. SortBy ListTsigKeysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The order to sort the resources. SortOrder ListTsigKeysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListTsigKeysRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTsigKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTsigKeysRequest) String() string
ListTsigKeysResponse wrapper for the ListTsigKeys operation
type ListTsigKeysResponse struct { // The underlying http response RawResponse *http.Response // A list of []TsigKeySummary instances Items []TsigKeySummary `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListTsigKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTsigKeysResponse) String() string
ListTsigKeysSortByEnum Enum with underlying type: string
type ListTsigKeysSortByEnum string
Set of constants representing the allowable values for ListTsigKeysSortByEnum
const ( ListTsigKeysSortByName ListTsigKeysSortByEnum = "name" ListTsigKeysSortByTimecreated ListTsigKeysSortByEnum = "timeCreated" )
func GetListTsigKeysSortByEnumValues() []ListTsigKeysSortByEnum
GetListTsigKeysSortByEnumValues Enumerates the set of values for ListTsigKeysSortByEnum
ListTsigKeysSortOrderEnum Enum with underlying type: string
type ListTsigKeysSortOrderEnum string
Set of constants representing the allowable values for ListTsigKeysSortOrderEnum
const ( ListTsigKeysSortOrderAsc ListTsigKeysSortOrderEnum = "ASC" ListTsigKeysSortOrderDesc ListTsigKeysSortOrderEnum = "DESC" )
func GetListTsigKeysSortOrderEnumValues() []ListTsigKeysSortOrderEnum
GetListTsigKeysSortOrderEnumValues Enumerates the set of values for ListTsigKeysSortOrderEnum
ListZonesLifecycleStateEnum Enum with underlying type: string
type ListZonesLifecycleStateEnum string
Set of constants representing the allowable values for ListZonesLifecycleStateEnum
const ( ListZonesLifecycleStateActive ListZonesLifecycleStateEnum = "ACTIVE" ListZonesLifecycleStateCreating ListZonesLifecycleStateEnum = "CREATING" ListZonesLifecycleStateDeleted ListZonesLifecycleStateEnum = "DELETED" ListZonesLifecycleStateDeleting ListZonesLifecycleStateEnum = "DELETING" ListZonesLifecycleStateFailed ListZonesLifecycleStateEnum = "FAILED" )
func GetListZonesLifecycleStateEnumValues() []ListZonesLifecycleStateEnum
GetListZonesLifecycleStateEnumValues Enumerates the set of values for ListZonesLifecycleStateEnum
ListZonesRequest wrapper for the ListZones operation
type ListZonesRequest struct { // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The maximum number of items to return in a page of the collection. Limit *int64 `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // A case-sensitive filter for zone names. // Will match any zone with a name that equals the provided value. Name *string `mandatory:"false" contributesTo:"query" name:"name"` // Search by zone name. // Will match any zone whose name (case-insensitive) contains the provided value. NameContains *string `mandatory:"false" contributesTo:"query" name:"nameContains"` // Search by zone type, `PRIMARY` or `SECONDARY`. // Will match any zone whose type equals the provided value. ZoneType ListZonesZoneTypeEnum `mandatory:"false" contributesTo:"query" name:"zoneType" omitEmpty:"true"` // An RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) timestamp that states // all returned resources were created on or after the indicated time. TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"` // An RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) timestamp that states // all returned resources were created before the indicated time. TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"` // The state of a resource. LifecycleState ListZonesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // The field by which to sort zones. SortBy ListZonesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The order to sort the resources. SortOrder ListZonesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListZonesRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListZonesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListZonesRequest) String() string
ListZonesResponse wrapper for the ListZones operation
type ListZonesResponse struct { // The underlying http response RawResponse *http.Response // A list of []ZoneSummary instances Items []ZoneSummary `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListZonesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListZonesResponse) String() string
ListZonesSortByEnum Enum with underlying type: string
type ListZonesSortByEnum string
Set of constants representing the allowable values for ListZonesSortByEnum
const ( ListZonesSortByName ListZonesSortByEnum = "name" ListZonesSortByZonetype ListZonesSortByEnum = "zoneType" ListZonesSortByTimecreated ListZonesSortByEnum = "timeCreated" )
func GetListZonesSortByEnumValues() []ListZonesSortByEnum
GetListZonesSortByEnumValues Enumerates the set of values for ListZonesSortByEnum
ListZonesSortOrderEnum Enum with underlying type: string
type ListZonesSortOrderEnum string
Set of constants representing the allowable values for ListZonesSortOrderEnum
const ( ListZonesSortOrderAsc ListZonesSortOrderEnum = "ASC" ListZonesSortOrderDesc ListZonesSortOrderEnum = "DESC" )
func GetListZonesSortOrderEnumValues() []ListZonesSortOrderEnum
GetListZonesSortOrderEnumValues Enumerates the set of values for ListZonesSortOrderEnum
ListZonesZoneTypeEnum Enum with underlying type: string
type ListZonesZoneTypeEnum string
Set of constants representing the allowable values for ListZonesZoneTypeEnum
const ( ListZonesZoneTypePrimary ListZonesZoneTypeEnum = "PRIMARY" ListZonesZoneTypeSecondary ListZonesZoneTypeEnum = "SECONDARY" )
func GetListZonesZoneTypeEnumValues() []ListZonesZoneTypeEnum
GetListZonesZoneTypeEnumValues Enumerates the set of values for ListZonesZoneTypeEnum
MigrationReplacement A record to add to a zone in replacement of contents that cannot be migrated.
type MigrationReplacement struct { // The canonical name for the type of the replacement record, such as A or CNAME. Rtype *string `mandatory:"true" json:"rtype"` // The Time To Live of the replacement record, in seconds. Ttl *int `mandatory:"true" json:"ttl"` // The record data of the replacement record, as whitespace-delimited tokens in // type-specific presentation format. Rdata *string `mandatory:"true" json:"rdata"` // The canonical name for a substitute type of the replacement record to be used if the specified `rtype` is not allowed at the domain. The specified `ttl` and `rdata` will still apply with the substitute type. SubstituteRtype *string `mandatory:"false" json:"substituteRtype"` }
func (m MigrationReplacement) String() string
Nameserver A server that has been set up to answer DNS queries for a zone.
type Nameserver struct { // The hostname of the nameserver. Hostname *string `mandatory:"true" json:"hostname"` }
func (m Nameserver) String() string
PatchDomainRecordsDetails The representation of PatchDomainRecordsDetails
type PatchDomainRecordsDetails struct { Items []RecordOperation `mandatory:"false" json:"items"` }
func (m PatchDomainRecordsDetails) String() string
PatchDomainRecordsRequest wrapper for the PatchDomainRecords operation
type PatchDomainRecordsRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The target fully-qualified domain name (FQDN) within the target zone. Domain *string `mandatory:"true" contributesTo:"path" name:"domain"` // Operations describing how to modify the collection of records. PatchDomainRecordsDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request PatchDomainRecordsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PatchDomainRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PatchDomainRecordsRequest) String() string
PatchDomainRecordsResponse wrapper for the PatchDomainRecords operation
type PatchDomainRecordsResponse struct { // The underlying http response RawResponse *http.Response // The RecordCollection instance RecordCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response PatchDomainRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PatchDomainRecordsResponse) String() string
PatchRRSetRequest wrapper for the PatchRRSet operation
type PatchRRSetRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The target fully-qualified domain name (FQDN) within the target zone. Domain *string `mandatory:"true" contributesTo:"path" name:"domain"` // The type of the target RRSet within the target zone. Rtype *string `mandatory:"true" contributesTo:"path" name:"rtype"` // Operations describing how to modify the collection of records. PatchRrSetDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request PatchRRSetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PatchRRSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PatchRRSetRequest) String() string
PatchRRSetResponse wrapper for the PatchRRSet operation
type PatchRRSetResponse struct { // The underlying http response RawResponse *http.Response // The RecordCollection instance RecordCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response PatchRRSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PatchRRSetResponse) String() string
PatchRrSetDetails The representation of PatchRrSetDetails
type PatchRrSetDetails struct { Items []RecordOperation `mandatory:"false" json:"items"` }
func (m PatchRrSetDetails) String() string
PatchZoneRecordsDetails The representation of PatchZoneRecordsDetails
type PatchZoneRecordsDetails struct { Items []RecordOperation `mandatory:"false" json:"items"` }
func (m PatchZoneRecordsDetails) String() string
PatchZoneRecordsRequest wrapper for the PatchZoneRecords operation
type PatchZoneRecordsRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The operations describing how to modify the collection of records. PatchZoneRecordsDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request PatchZoneRecordsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PatchZoneRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PatchZoneRecordsRequest) String() string
PatchZoneRecordsResponse wrapper for the PatchZoneRecords operation
type PatchZoneRecordsResponse struct { // The underlying http response RawResponse *http.Response // The RecordCollection instance RecordCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response PatchZoneRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PatchZoneRecordsResponse) String() string
Record A DNS resource record. For more information, see Supported DNS Resource Record Types (https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm).
type Record struct { // The fully qualified domain name where the record can be located. Domain *string `mandatory:"false" json:"domain"` // A unique identifier for the record within its zone. RecordHash *string `mandatory:"false" json:"recordHash"` // A Boolean flag indicating whether or not parts of the record // are unable to be explicitly managed. IsProtected *bool `mandatory:"false" json:"isProtected"` // The record's data, as whitespace-delimited tokens in // type-specific presentation format. All RDATA is normalized and the // returned presentation of your RDATA may differ from its initial input. // For more information about RDATA, see Supported DNS Resource Record Types (https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) Rdata *string `mandatory:"false" json:"rdata"` // The latest version of the record's zone in which its RRSet differs // from the preceding version. RrsetVersion *string `mandatory:"false" json:"rrsetVersion"` // The canonical name for the record's type, such as A or CNAME. For more // information, see Resource Record (RR) TYPEs (https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). Rtype *string `mandatory:"false" json:"rtype"` // The Time To Live for the record, in seconds. Ttl *int `mandatory:"false" json:"ttl"` }
func (m Record) String() string
RecordCollection A collection of DNS resource records.
type RecordCollection struct { Items []Record `mandatory:"false" json:"items"` }
func (m RecordCollection) String() string
RecordDetails A DNS resource record. For more information about records, see RFC 1034 (https://tools.ietf.org/html/rfc1034#section-3.6).
type RecordDetails struct { // The fully qualified domain name where the record can be located. Domain *string `mandatory:"true" json:"domain"` // The record's data, as whitespace-delimited tokens in // type-specific presentation format. All RDATA is normalized and the // returned presentation of your RDATA may differ from its initial input. // For more information about RDATA, see Supported DNS Resource Record Types (https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) Rdata *string `mandatory:"true" json:"rdata"` // The canonical name for the record's type, such as A or CNAME. For more // information, see Resource Record (RR) TYPEs (https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). Rtype *string `mandatory:"true" json:"rtype"` // The Time To Live for the record, in seconds. Ttl *int `mandatory:"true" json:"ttl"` // A unique identifier for the record within its zone. RecordHash *string `mandatory:"false" json:"recordHash"` // A Boolean flag indicating whether or not parts of the record // are unable to be explicitly managed. IsProtected *bool `mandatory:"false" json:"isProtected"` // The latest version of the record's zone in which its RRSet differs // from the preceding version. RrsetVersion *string `mandatory:"false" json:"rrsetVersion"` }
func (m RecordDetails) String() string
RecordOperation An extension of the existing record resource, describing either a precondition, an add, or a remove. Preconditions check all fields, including read-only data like `recordHash` and `rrsetVersion`.
type RecordOperation struct { // The fully qualified domain name where the record can be located. Domain *string `mandatory:"false" json:"domain"` // A unique identifier for the record within its zone. RecordHash *string `mandatory:"false" json:"recordHash"` // A Boolean flag indicating whether or not parts of the record // are unable to be explicitly managed. IsProtected *bool `mandatory:"false" json:"isProtected"` // The record's data, as whitespace-delimited tokens in // type-specific presentation format. All RDATA is normalized and the // returned presentation of your RDATA may differ from its initial input. // For more information about RDATA, see Supported DNS Resource Record Types (https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) Rdata *string `mandatory:"false" json:"rdata"` // The latest version of the record's zone in which its RRSet differs // from the preceding version. RrsetVersion *string `mandatory:"false" json:"rrsetVersion"` // The canonical name for the record's type, such as A or CNAME. For more // information, see Resource Record (RR) TYPEs (https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). Rtype *string `mandatory:"false" json:"rtype"` // The Time To Live for the record, in seconds. Ttl *int `mandatory:"false" json:"ttl"` // A description of how a record relates to a PATCH operation. // // - `REQUIRE` indicates a precondition that record data **must** already exist. // - `PROHIBIT` indicates a precondition that record data **must not** already exist. // - `ADD` indicates that record data **must** exist after successful application. // - `REMOVE` indicates that record data **must not** exist after successful application. // // **Note:** `ADD` and `REMOVE` operations can succeed even if // they require no changes when applied, such as when the described // records are already present or absent. // // **Note:** `ADD` and `REMOVE` operations can describe changes for // more than one record. // // **Example:** `{ "domain": "www.example.com", "rtype": "AAAA", "ttl": 60 }` // specifies a new TTL for every record in the www.example.com AAAA RRSet. Operation RecordOperationOperationEnum `mandatory:"false" json:"operation,omitempty"` }
func (m RecordOperation) String() string
RecordOperationOperationEnum Enum with underlying type: string
type RecordOperationOperationEnum string
Set of constants representing the allowable values for RecordOperationOperationEnum
const ( RecordOperationOperationRequire RecordOperationOperationEnum = "REQUIRE" RecordOperationOperationProhibit RecordOperationOperationEnum = "PROHIBIT" RecordOperationOperationAdd RecordOperationOperationEnum = "ADD" RecordOperationOperationRemove RecordOperationOperationEnum = "REMOVE" )
func GetRecordOperationOperationEnumValues() []RecordOperationOperationEnum
GetRecordOperationOperationEnumValues Enumerates the set of values for RecordOperationOperationEnum
RrSet A collection of DNS records of the same domain and type. For more information about record types, see Resource Record (RR) TYPEs (https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4).
type RrSet struct { Items []Record `mandatory:"false" json:"items"` }
func (m RrSet) String() string
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const ( SortOrderAsc SortOrderEnum = "ASC" SortOrderDesc SortOrderEnum = "DESC" )
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
SteeringPolicy A DNS steering policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type SteeringPolicy struct { // The OCID of the compartment containing the steering policy. CompartmentId *string `mandatory:"false" json:"compartmentId"` // A user-friendly name for the steering policy. Does not have to be unique and can be changed. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // The Time To Live (TTL) for responses from the steering policy, in seconds. // If not specified during creation, a value of 30 seconds will be used. Ttl *int `mandatory:"false" json:"ttl"` // The OCID of the health check monitor providing health data about the answers of the // steering policy. A steering policy answer with `rdata` matching a monitored endpoint // will use the health data of that endpoint. A steering policy answer with `rdata` not // matching any monitored endpoint will be assumed healthy. // // **Note:** To use the Health Check monitoring feature in a steering policy, a monitor // must be created using the Health Checks service first. For more information on how to // create a monitor, please see Managing Health Checks (https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). HealthCheckMonitorId *string `mandatory:"false" json:"healthCheckMonitorId"` // A set of predefined rules based on the desired purpose of the steering policy. Each // template utilizes Traffic Management's rules in a different order to produce the desired // results when answering DNS queries. // // **Example:** The `FAILOVER` template determines answers by filtering the policy's answers // using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, // and `LIMIT`. This gives the domain dynamic failover capability. // // It is **strongly recommended** to use a template other than `CUSTOM` when creating // a steering policy. // // All templates require the rule order to begin with an unconditional `FILTER` rule that keeps // answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined // `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. // The last rule of a template must must be a `LIMIT` rule. For more information about templates // and code examples, see Traffic Management API Guide (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). // **Template Types** // * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers // to serve. If an endpoint fails a health check, the answer for that endpoint will be removed // from the list of available answers until the endpoint is detected as healthy. // // * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. // // * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic // locations to route by, see Traffic Management Geographic Locations (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). // // * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN. // // * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address. // // * `CUSTOM` - Allows a customized configuration of rules. Template SteeringPolicyTemplateEnum `mandatory:"false" json:"template,omitempty"` // 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"` // The set of all answers that can potentially issue from the steering policy. Answers []SteeringPolicyAnswer `mandatory:"false" json:"answers"` // The series of rules that will be processed in sequence to reduce the pool of answers // to a response for any given request. // // The first rule receives a shuffled list of all answers, and every other rule receives // the list of answers emitted by the one preceding it. The last rule populates the // response. Rules []SteeringPolicyRule `mandatory:"false" json:"rules"` // The canonical absolute URL of the resource. Self *string `mandatory:"false" json:"self"` // The OCID of the resource. Id *string `mandatory:"false" json:"id"` // The date and time the resource was created, expressed in RFC 3339 timestamp format. // **Example:** `2016-07-22T17:23:59:60Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The current state of the resource. LifecycleState SteeringPolicyLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m SteeringPolicy) String() string
func (m *SteeringPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
SteeringPolicyAnswer DNS record data with metadata for processing in a steering policy.
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type SteeringPolicyAnswer struct { // A user-friendly name for the answer, unique within the steering policy. // An answer's `name` property can be referenced in `answerCondition` properties // of rules using `answer.name`. // **Example:** // "rules": [ // { // "ruleType": "FILTER", // "defaultAnswerData": [ // { // "answerCondition": "answer.name == 'server 1'", // "shouldKeep": true // } // ] // } // ] Name *string `mandatory:"true" json:"name"` // The canonical name for the record's type. Only A, AAAA, and CNAME are supported. For more // information, see Supported DNS Resource Record Types (https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). Rtype *string `mandatory:"true" json:"rtype"` // The record's data, as whitespace-delimited tokens in // type-specific presentation format. All RDATA is normalized and the // returned presentation of your RDATA may differ from its initial input. // For more information about RDATA, see Supported DNS Resource Record Types (https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). Rdata *string `mandatory:"true" json:"rdata"` // The freeform name of a group of one or more records in which this record is included, // such as "LAX data center". An answer's `pool` property can be referenced in `answerCondition` // properties of rules using `answer.pool`. // **Example:** // "rules": [ // { // "ruleType": "FILTER", // "defaultAnswerData": [ // { // "answerCondition": "answer.pool == 'US East Servers'", // "shouldKeep": true // } // ] // } // ] Pool *string `mandatory:"false" json:"pool"` // Set this property to `true` to indicate that the answer is administratively disabled, // such as when the corresponding server is down for maintenance. An answer's `isDisabled` // property can be referenced in `answerCondition` properties in rules using `answer.isDisabled`. // **Example:** // "rules": [ // { // "ruleType": "FILTER", // "defaultAnswerData": [ // { // "answerCondition": "answer.isDisabled != true", // "shouldKeep": true // } // ] // }, IsDisabled *bool `mandatory:"false" json:"isDisabled"` }
func (m SteeringPolicyAnswer) String() string
SteeringPolicyAttachment An attachment between a steering policy and a domain. An attachment constructs DNS responses using its steering policy instead of the records at its defined domain. Only records of the policy's covered rtype are blocked at the domain. A domain can have a maximum of one attachment covering any given rtype. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type SteeringPolicyAttachment struct { // The OCID of the attached steering policy. SteeringPolicyId *string `mandatory:"false" json:"steeringPolicyId"` // The OCID of the attached zone. ZoneId *string `mandatory:"false" json:"zoneId"` // The attached domain within the attached zone. DomainName *string `mandatory:"false" json:"domainName"` // A user-friendly name for the steering policy attachment. // Does not have to be unique and can be changed. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // The record types covered by the attachment at the domain. The set of record types is // determined by aggregating the record types from the answers defined in the steering // policy. Rtypes []string `mandatory:"false" json:"rtypes"` // The OCID of the compartment containing the steering policy attachment. CompartmentId *string `mandatory:"false" json:"compartmentId"` // The canonical absolute URL of the resource. Self *string `mandatory:"false" json:"self"` // The OCID of the resource. Id *string `mandatory:"false" json:"id"` // The date and time the resource was created, expressed in RFC 3339 timestamp format. // **Example:** `2016-07-22T17:23:59:60Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The current state of the resource. LifecycleState SteeringPolicyAttachmentLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m SteeringPolicyAttachment) String() string
SteeringPolicyAttachmentLifecycleStateEnum Enum with underlying type: string
type SteeringPolicyAttachmentLifecycleStateEnum string
Set of constants representing the allowable values for SteeringPolicyAttachmentLifecycleStateEnum
const ( SteeringPolicyAttachmentLifecycleStateCreating SteeringPolicyAttachmentLifecycleStateEnum = "CREATING" SteeringPolicyAttachmentLifecycleStateActive SteeringPolicyAttachmentLifecycleStateEnum = "ACTIVE" SteeringPolicyAttachmentLifecycleStateDeleting SteeringPolicyAttachmentLifecycleStateEnum = "DELETING" )
func GetSteeringPolicyAttachmentLifecycleStateEnumValues() []SteeringPolicyAttachmentLifecycleStateEnum
GetSteeringPolicyAttachmentLifecycleStateEnumValues Enumerates the set of values for SteeringPolicyAttachmentLifecycleStateEnum
SteeringPolicyAttachmentSummary An attachment between a steering policy and a domain.
type SteeringPolicyAttachmentSummary struct { // The OCID of the attached steering policy. SteeringPolicyId *string `mandatory:"false" json:"steeringPolicyId"` // The OCID of the attached zone. ZoneId *string `mandatory:"false" json:"zoneId"` // The attached domain within the attached zone. DomainName *string `mandatory:"false" json:"domainName"` // A user-friendly name for the steering policy attachment. // Does not have to be unique and can be changed. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // The record types covered by the attachment at the domain. The set of record types is // determined by aggregating the record types from the answers defined in the steering // policy. Rtypes []string `mandatory:"false" json:"rtypes"` // The OCID of the compartment containing the steering policy attachment. CompartmentId *string `mandatory:"false" json:"compartmentId"` // The canonical absolute URL of the resource. Self *string `mandatory:"false" json:"self"` // The OCID of the resource. Id *string `mandatory:"false" json:"id"` // The date and time the resource was created, expressed in RFC 3339 timestamp format. // **Example:** `2016-07-22T17:23:59:60Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The current state of the resource. LifecycleState SteeringPolicyAttachmentSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m SteeringPolicyAttachmentSummary) String() string
SteeringPolicyAttachmentSummaryLifecycleStateEnum Enum with underlying type: string
type SteeringPolicyAttachmentSummaryLifecycleStateEnum string
Set of constants representing the allowable values for SteeringPolicyAttachmentSummaryLifecycleStateEnum
const ( SteeringPolicyAttachmentSummaryLifecycleStateCreating SteeringPolicyAttachmentSummaryLifecycleStateEnum = "CREATING" SteeringPolicyAttachmentSummaryLifecycleStateActive SteeringPolicyAttachmentSummaryLifecycleStateEnum = "ACTIVE" SteeringPolicyAttachmentSummaryLifecycleStateDeleting SteeringPolicyAttachmentSummaryLifecycleStateEnum = "DELETING" )
func GetSteeringPolicyAttachmentSummaryLifecycleStateEnumValues() []SteeringPolicyAttachmentSummaryLifecycleStateEnum
GetSteeringPolicyAttachmentSummaryLifecycleStateEnumValues Enumerates the set of values for SteeringPolicyAttachmentSummaryLifecycleStateEnum
SteeringPolicyFilterAnswerData The representation of SteeringPolicyFilterAnswerData
type SteeringPolicyFilterAnswerData struct { // An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. AnswerCondition *string `mandatory:"false" json:"answerCondition"` // Keeps the answer only if the value is `true`. ShouldKeep *bool `mandatory:"false" json:"shouldKeep"` }
func (m SteeringPolicyFilterAnswerData) String() string
SteeringPolicyFilterRule The representation of SteeringPolicyFilterRule
type SteeringPolicyFilterRule struct { // A user-defined description of the rule's purpose or behavior. Description *string `mandatory:"false" json:"description"` // An array of `caseConditions`. A rule may optionally include a sequence of cases defining alternate // configurations for how it should behave during processing for any given DNS query. When a rule has // no sequence of `cases`, it is always evaluated with the same configuration during processing. When // a rule has an empty sequence of `cases`, it is always ignored during processing. When a rule has a // non-empty sequence of `cases`, its behavior during processing is configured by the first matching // `case` in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no // `caseCondition` always matches. A rule case with a `caseCondition` matches only when that expression // evaluates to true for the given query. Cases []SteeringPolicyFilterRuleCase `mandatory:"false" json:"cases"` // Defines a default set of answer conditions and values that are applied to an answer when // `cases` is not defined for the rule, or a matching case does not have any matching // `answerCondition`s in its `answerData`. `defaultAnswerData` is not applied if `cases` is // defined and there are no matching cases. In this scenario, the next rule will be processed. DefaultAnswerData []SteeringPolicyFilterAnswerData `mandatory:"false" json:"defaultAnswerData"` }
func (m SteeringPolicyFilterRule) GetDescription() *string
GetDescription returns Description
func (m SteeringPolicyFilterRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SteeringPolicyFilterRule) String() string
SteeringPolicyFilterRuleCase The representation of SteeringPolicyFilterRuleCase
type SteeringPolicyFilterRuleCase struct { // An expression that uses conditions at the time of a DNS query to indicate // whether a case matches. Conditions may include the geographical location, IP // subnet, or ASN the DNS query originated. **Example:** If you have an // office that uses the subnet `192.0.2.0/24` you could use a `caseCondition` // expression `query.client.subnet in ('192.0.2.0/24')` to define a case that // matches queries from that office. CaseCondition *string `mandatory:"false" json:"caseCondition"` // An array of `SteeringPolicyFilterAnswerData` objects. AnswerData []SteeringPolicyFilterAnswerData `mandatory:"false" json:"answerData"` }
func (m SteeringPolicyFilterRuleCase) String() string
SteeringPolicyHealthRule The representation of SteeringPolicyHealthRule
type SteeringPolicyHealthRule struct { // A user-defined description of the rule's purpose or behavior. Description *string `mandatory:"false" json:"description"` // An array of `caseConditions`. A rule may optionally include a sequence of cases defining alternate // configurations for how it should behave during processing for any given DNS query. When a rule has // no sequence of `cases`, it is always evaluated with the same configuration during processing. When // a rule has an empty sequence of `cases`, it is always ignored during processing. When a rule has a // non-empty sequence of `cases`, its behavior during processing is configured by the first matching // `case` in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no // `caseCondition` always matches. A rule case with a `caseCondition` matches only when that expression // evaluates to true for the given query. Cases []SteeringPolicyHealthRuleCase `mandatory:"false" json:"cases"` }
func (m SteeringPolicyHealthRule) GetDescription() *string
GetDescription returns Description
func (m SteeringPolicyHealthRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SteeringPolicyHealthRule) String() string
SteeringPolicyHealthRuleCase The representation of SteeringPolicyHealthRuleCase
type SteeringPolicyHealthRuleCase struct { // An expression that uses conditions at the time of a DNS query to indicate // whether a case matches. Conditions may include the geographical location, IP // subnet, or ASN the DNS query originated. **Example:** If you have an // office that uses the subnet `192.0.2.0/24` you could use a `caseCondition` // expression `query.client.subnet in ('192.0.2.0/24')` to define a case that // matches queries from that office. CaseCondition *string `mandatory:"false" json:"caseCondition"` }
func (m SteeringPolicyHealthRuleCase) String() string
SteeringPolicyLifecycleStateEnum Enum with underlying type: string
type SteeringPolicyLifecycleStateEnum string
Set of constants representing the allowable values for SteeringPolicyLifecycleStateEnum
const ( SteeringPolicyLifecycleStateActive SteeringPolicyLifecycleStateEnum = "ACTIVE" SteeringPolicyLifecycleStateCreating SteeringPolicyLifecycleStateEnum = "CREATING" SteeringPolicyLifecycleStateDeleted SteeringPolicyLifecycleStateEnum = "DELETED" SteeringPolicyLifecycleStateDeleting SteeringPolicyLifecycleStateEnum = "DELETING" )
func GetSteeringPolicyLifecycleStateEnumValues() []SteeringPolicyLifecycleStateEnum
GetSteeringPolicyLifecycleStateEnumValues Enumerates the set of values for SteeringPolicyLifecycleStateEnum
SteeringPolicyLimitRule The representation of SteeringPolicyLimitRule
type SteeringPolicyLimitRule struct { // A user-defined description of the rule's purpose or behavior. Description *string `mandatory:"false" json:"description"` // An array of `caseConditions`. A rule may optionally include a sequence of cases defining alternate // configurations for how it should behave during processing for any given DNS query. When a rule has // no sequence of `cases`, it is always evaluated with the same configuration during processing. When // a rule has an empty sequence of `cases`, it is always ignored during processing. When a rule has a // non-empty sequence of `cases`, its behavior during processing is configured by the first matching // `case` in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no // `caseCondition` always matches. A rule case with a `caseCondition` matches only when that expression // evaluates to true for the given query. Cases []SteeringPolicyLimitRuleCase `mandatory:"false" json:"cases"` // Defines a default count if `cases` is not defined for the rule or a matching case does // not define `count`. `defaultCount` is **not** applied if `cases` is defined and there // are no matching cases. In this scenario, the next rule will be processed. If no rules // remain to be processed, the answer will be chosen from the remaining list of answers. DefaultCount *int `mandatory:"false" json:"defaultCount"` }
func (m SteeringPolicyLimitRule) GetDescription() *string
GetDescription returns Description
func (m SteeringPolicyLimitRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SteeringPolicyLimitRule) String() string
SteeringPolicyLimitRuleCase The representation of SteeringPolicyLimitRuleCase
type SteeringPolicyLimitRuleCase struct { // The number of answers allowed to remain after the limit rule has been processed, keeping only the // first of the remaining answers in the list. Example: If the `count` property is set to `2` and // four answers remain before the limit rule is processed, only the first two answers in the list will // remain after the limit rule has been processed. Count *int `mandatory:"true" json:"count"` // An expression that uses conditions at the time of a DNS query to indicate // whether a case matches. Conditions may include the geographical location, IP // subnet, or ASN the DNS query originated. **Example:** If you have an // office that uses the subnet `192.0.2.0/24` you could use a `caseCondition` // expression `query.client.subnet in ('192.0.2.0/24')` to define a case that // matches queries from that office. CaseCondition *string `mandatory:"false" json:"caseCondition"` }
func (m SteeringPolicyLimitRuleCase) String() string
SteeringPolicyPriorityAnswerData The representation of SteeringPolicyPriorityAnswerData
type SteeringPolicyPriorityAnswerData struct { // The rank assigned to the set of answers that match the expression in `answerCondition`. // Answers with the lowest values move to the beginning of the list without changing the // relative order of those with the same value. Answers can be given a value between `0` and `255`. Value *int `mandatory:"true" json:"value"` // An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. AnswerCondition *string `mandatory:"false" json:"answerCondition"` }
func (m SteeringPolicyPriorityAnswerData) String() string
SteeringPolicyPriorityRule The representation of SteeringPolicyPriorityRule
type SteeringPolicyPriorityRule struct { // A user-defined description of the rule's purpose or behavior. Description *string `mandatory:"false" json:"description"` // An array of `caseConditions`. A rule may optionally include a sequence of cases defining alternate // configurations for how it should behave during processing for any given DNS query. When a rule has // no sequence of `cases`, it is always evaluated with the same configuration during processing. When // a rule has an empty sequence of `cases`, it is always ignored during processing. When a rule has a // non-empty sequence of `cases`, its behavior during processing is configured by the first matching // `case` in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no // `caseCondition` always matches. A rule case with a `caseCondition` matches only when that expression // evaluates to true for the given query. Cases []SteeringPolicyPriorityRuleCase `mandatory:"false" json:"cases"` // Defines a default set of answer conditions and values that are applied to an answer when // `cases` is not defined for the rule or a matching case does not have any matching // `answerCondition`s in its `answerData`. `defaultAnswerData` is not applied if `cases` is // defined and there are no matching cases. In this scenario, the next rule will be processed. DefaultAnswerData []SteeringPolicyPriorityAnswerData `mandatory:"false" json:"defaultAnswerData"` }
func (m SteeringPolicyPriorityRule) GetDescription() *string
GetDescription returns Description
func (m SteeringPolicyPriorityRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SteeringPolicyPriorityRule) String() string
SteeringPolicyPriorityRuleCase The representation of SteeringPolicyPriorityRuleCase
type SteeringPolicyPriorityRuleCase struct { // An expression that uses conditions at the time of a DNS query to indicate // whether a case matches. Conditions may include the geographical location, IP // subnet, or ASN the DNS query originated. **Example:** If you have an // office that uses the subnet `192.0.2.0/24` you could use a `caseCondition` // expression `query.client.subnet in ('192.0.2.0/24')` to define a case that // matches queries from that office. CaseCondition *string `mandatory:"false" json:"caseCondition"` // An array of `SteeringPolicyPriorityAnswerData` objects. AnswerData []SteeringPolicyPriorityAnswerData `mandatory:"false" json:"answerData"` }
func (m SteeringPolicyPriorityRuleCase) String() string
SteeringPolicyRule The configuration of the sorting and filtering behaviors in a steering policy. Rules can filter and sort answers based on weight, priority, endpoint health, and other data.
A rule may optionally include a sequence of cases, each with an optional `caseCondition` expression. Cases allow a sequence of conditions to be defined that will apply different parameters to the rule when the conditions are met. For more information about cases, see Traffic Management API Guide (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm).
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type SteeringPolicyRule interface { // A user-defined description of the rule's purpose or behavior. GetDescription() *string }
SteeringPolicyRuleRuleTypeEnum Enum with underlying type: string
type SteeringPolicyRuleRuleTypeEnum string
Set of constants representing the allowable values for SteeringPolicyRuleRuleTypeEnum
const ( SteeringPolicyRuleRuleTypeFilter SteeringPolicyRuleRuleTypeEnum = "FILTER" SteeringPolicyRuleRuleTypeHealth SteeringPolicyRuleRuleTypeEnum = "HEALTH" SteeringPolicyRuleRuleTypeWeighted SteeringPolicyRuleRuleTypeEnum = "WEIGHTED" SteeringPolicyRuleRuleTypePriority SteeringPolicyRuleRuleTypeEnum = "PRIORITY" SteeringPolicyRuleRuleTypeLimit SteeringPolicyRuleRuleTypeEnum = "LIMIT" )
func GetSteeringPolicyRuleRuleTypeEnumValues() []SteeringPolicyRuleRuleTypeEnum
GetSteeringPolicyRuleRuleTypeEnumValues Enumerates the set of values for SteeringPolicyRuleRuleTypeEnum
SteeringPolicySummary A DNS steering policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type SteeringPolicySummary struct { // The OCID of the compartment containing the steering policy. CompartmentId *string `mandatory:"false" json:"compartmentId"` // A user-friendly name for the steering policy. Does not have to be unique and can be changed. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // The Time To Live (TTL) for responses from the steering policy, in seconds. // If not specified during creation, a value of 30 seconds will be used. Ttl *int `mandatory:"false" json:"ttl"` // The OCID of the health check monitor providing health data about the answers of the // steering policy. A steering policy answer with `rdata` matching a monitored endpoint // will use the health data of that endpoint. A steering policy answer with `rdata` not // matching any monitored endpoint will be assumed healthy. // // **Note:** To use the Health Check monitoring feature in a steering policy, a monitor // must be created using the Health Checks service first. For more information on how to // create a monitor, please see Managing Health Checks (https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). HealthCheckMonitorId *string `mandatory:"false" json:"healthCheckMonitorId"` // A set of predefined rules based on the desired purpose of the steering policy. Each // template utilizes Traffic Management's rules in a different order to produce the desired // results when answering DNS queries. // // **Example:** The `FAILOVER` template determines answers by filtering the policy's answers // using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, // and `LIMIT`. This gives the domain dynamic failover capability. // // It is **strongly recommended** to use a template other than `CUSTOM` when creating // a steering policy. // // All templates require the rule order to begin with an unconditional `FILTER` rule that keeps // answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined // `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. // The last rule of a template must must be a `LIMIT` rule. For more information about templates // and code examples, see Traffic Management API Guide (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). // **Template Types** // * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers // to serve. If an endpoint fails a health check, the answer for that endpoint will be removed // from the list of available answers until the endpoint is detected as healthy. // // * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. // // * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic // locations to route by, see Traffic Management Geographic Locations (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). // // * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN. // // * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address. // // * `CUSTOM` - Allows a customized configuration of rules. Template SteeringPolicySummaryTemplateEnum `mandatory:"false" json:"template,omitempty"` // 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"` // The canonical absolute URL of the resource. Self *string `mandatory:"false" json:"self"` // The OCID of the resource. Id *string `mandatory:"false" json:"id"` // The date and time the resource was created, expressed in RFC 3339 timestamp format. // **Example:** `2016-07-22T17:23:59:60Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The current state of the resource. LifecycleState SteeringPolicySummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m SteeringPolicySummary) String() string
SteeringPolicySummaryLifecycleStateEnum Enum with underlying type: string
type SteeringPolicySummaryLifecycleStateEnum string
Set of constants representing the allowable values for SteeringPolicySummaryLifecycleStateEnum
const ( SteeringPolicySummaryLifecycleStateActive SteeringPolicySummaryLifecycleStateEnum = "ACTIVE" SteeringPolicySummaryLifecycleStateCreating SteeringPolicySummaryLifecycleStateEnum = "CREATING" SteeringPolicySummaryLifecycleStateDeleted SteeringPolicySummaryLifecycleStateEnum = "DELETED" SteeringPolicySummaryLifecycleStateDeleting SteeringPolicySummaryLifecycleStateEnum = "DELETING" )
func GetSteeringPolicySummaryLifecycleStateEnumValues() []SteeringPolicySummaryLifecycleStateEnum
GetSteeringPolicySummaryLifecycleStateEnumValues Enumerates the set of values for SteeringPolicySummaryLifecycleStateEnum
SteeringPolicySummaryTemplateEnum Enum with underlying type: string
type SteeringPolicySummaryTemplateEnum string
Set of constants representing the allowable values for SteeringPolicySummaryTemplateEnum
const ( SteeringPolicySummaryTemplateFailover SteeringPolicySummaryTemplateEnum = "FAILOVER" SteeringPolicySummaryTemplateLoadBalance SteeringPolicySummaryTemplateEnum = "LOAD_BALANCE" SteeringPolicySummaryTemplateRouteByGeo SteeringPolicySummaryTemplateEnum = "ROUTE_BY_GEO" SteeringPolicySummaryTemplateRouteByAsn SteeringPolicySummaryTemplateEnum = "ROUTE_BY_ASN" SteeringPolicySummaryTemplateRouteByIp SteeringPolicySummaryTemplateEnum = "ROUTE_BY_IP" SteeringPolicySummaryTemplateCustom SteeringPolicySummaryTemplateEnum = "CUSTOM" )
func GetSteeringPolicySummaryTemplateEnumValues() []SteeringPolicySummaryTemplateEnum
GetSteeringPolicySummaryTemplateEnumValues Enumerates the set of values for SteeringPolicySummaryTemplateEnum
SteeringPolicyTemplateEnum Enum with underlying type: string
type SteeringPolicyTemplateEnum string
Set of constants representing the allowable values for SteeringPolicyTemplateEnum
const ( SteeringPolicyTemplateFailover SteeringPolicyTemplateEnum = "FAILOVER" SteeringPolicyTemplateLoadBalance SteeringPolicyTemplateEnum = "LOAD_BALANCE" SteeringPolicyTemplateRouteByGeo SteeringPolicyTemplateEnum = "ROUTE_BY_GEO" SteeringPolicyTemplateRouteByAsn SteeringPolicyTemplateEnum = "ROUTE_BY_ASN" SteeringPolicyTemplateRouteByIp SteeringPolicyTemplateEnum = "ROUTE_BY_IP" SteeringPolicyTemplateCustom SteeringPolicyTemplateEnum = "CUSTOM" )
func GetSteeringPolicyTemplateEnumValues() []SteeringPolicyTemplateEnum
GetSteeringPolicyTemplateEnumValues Enumerates the set of values for SteeringPolicyTemplateEnum
SteeringPolicyWeightedAnswerData The representation of SteeringPolicyWeightedAnswerData
type SteeringPolicyWeightedAnswerData struct { // The weight assigned to the set of selected answers. Answers with a higher weight will be served // more frequently. Answers can be given a value between `0` and `255`. Value *int `mandatory:"true" json:"value"` // An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. AnswerCondition *string `mandatory:"false" json:"answerCondition"` }
func (m SteeringPolicyWeightedAnswerData) String() string
SteeringPolicyWeightedRule The representation of SteeringPolicyWeightedRule
type SteeringPolicyWeightedRule struct { // A user-defined description of the rule's purpose or behavior. Description *string `mandatory:"false" json:"description"` // An array of `caseConditions`. A rule may optionally include a sequence of cases defining alternate // configurations for how it should behave during processing for any given DNS query. When a rule has // no sequence of `cases`, it is always evaluated with the same configuration during processing. When // a rule has an empty sequence of `cases`, it is always ignored during processing. When a rule has a // non-empty sequence of `cases`, its behavior during processing is configured by the first matching // `case` in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no // `caseCondition` always matches. A rule case with a `caseCondition` matches only when that expression // evaluates to true for the given query. Cases []SteeringPolicyWeightedRuleCase `mandatory:"false" json:"cases"` // Defines a default set of answer conditions and values that are applied to an answer when // `cases` is not defined for the rule or a matching case does not have any matching // `answerCondition`s in its `answerData`. `defaultAnswerData` is not applied if `cases` is // defined and there are no matching cases. In this scenario, the next rule will be processed. DefaultAnswerData []SteeringPolicyWeightedAnswerData `mandatory:"false" json:"defaultAnswerData"` }
func (m SteeringPolicyWeightedRule) GetDescription() *string
GetDescription returns Description
func (m SteeringPolicyWeightedRule) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SteeringPolicyWeightedRule) String() string
SteeringPolicyWeightedRuleCase The representation of SteeringPolicyWeightedRuleCase
type SteeringPolicyWeightedRuleCase struct { // An expression that uses conditions at the time of a DNS query to indicate // whether a case matches. Conditions may include the geographical location, IP // subnet, or ASN the DNS query originated. **Example:** If you have an // office that uses the subnet `192.0.2.0/24` you could use a `caseCondition` // expression `query.client.subnet in ('192.0.2.0/24')` to define a case that // matches queries from that office. CaseCondition *string `mandatory:"false" json:"caseCondition"` // An array of `SteeringPolicyWeightedAnswerData` objects. AnswerData []SteeringPolicyWeightedAnswerData `mandatory:"false" json:"answerData"` }
func (m SteeringPolicyWeightedRuleCase) String() string
Tsig A TSIG (https://tools.ietf.org/html/rfc2845) key.
type Tsig struct { // A domain name identifying the key for a given pair of hosts. Name *string `mandatory:"true" json:"name"` // A base64 string encoding the binary shared secret. Secret *string `mandatory:"true" json:"secret"` // TSIG Algorithms are encoded as domain names, but most consist of only one // non-empty label, which is not required to be explicitly absolute. // Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, // hmac-sha512. For more information on these algorithms, see RFC 4635 (https://tools.ietf.org/html/rfc4635#section-2). Algorithm *string `mandatory:"true" json:"algorithm"` }
func (m Tsig) String() string
TsigKey A TSIG key. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type TsigKey struct { // TSIG key algorithms are encoded as domain names, but most consist of only one // non-empty label, which is not required to be explicitly absolute. // Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, // hmac-sha512. For more information on these algorithms, see RFC 4635 (https://tools.ietf.org/html/rfc4635#section-2). Algorithm *string `mandatory:"false" json:"algorithm"` // A globally unique domain name identifying the key for a given pair of hosts. Name *string `mandatory:"false" json:"name"` // The OCID of the compartment containing the TSIG key. CompartmentId *string `mandatory:"false" json:"compartmentId"` // A base64 string encoding the binary shared secret. Secret *string `mandatory:"false" json:"secret"` // 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"` // The OCID of the resource. Id *string `mandatory:"false" json:"id"` // The canonical absolute URL of the resource. Self *string `mandatory:"false" json:"self"` // The date and time the resource was created, expressed in RFC 3339 timestamp format. // **Example:** `2016-07-22T17:23:59:60Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The current state of the resource. LifecycleState TsigKeyLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` // The date and time the resource was last updated, expressed in RFC 3339 timestamp format. // **Example:** `2016-07-22T17:23:59:60Z` TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` }
func (m TsigKey) String() string
TsigKeyLifecycleStateEnum Enum with underlying type: string
type TsigKeyLifecycleStateEnum string
Set of constants representing the allowable values for TsigKeyLifecycleStateEnum
const ( TsigKeyLifecycleStateActive TsigKeyLifecycleStateEnum = "ACTIVE" TsigKeyLifecycleStateCreating TsigKeyLifecycleStateEnum = "CREATING" )
func GetTsigKeyLifecycleStateEnumValues() []TsigKeyLifecycleStateEnum
GetTsigKeyLifecycleStateEnumValues Enumerates the set of values for TsigKeyLifecycleStateEnum
TsigKeySummary A TSIG key.
type TsigKeySummary struct { // TSIG key algorithms are encoded as domain names, but most consist of only one // non-empty label, which is not required to be explicitly absolute. // Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, // hmac-sha512. For more information on these algorithms, see RFC 4635 (https://tools.ietf.org/html/rfc4635#section-2). Algorithm *string `mandatory:"false" json:"algorithm"` // A globally unique domain name identifying the key for a given pair of hosts. Name *string `mandatory:"false" json:"name"` // The OCID of the compartment containing the TSIG key. CompartmentId *string `mandatory:"false" json:"compartmentId"` // 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"` // The OCID of the resource. Id *string `mandatory:"false" json:"id"` // The canonical absolute URL of the resource. Self *string `mandatory:"false" json:"self"` // The date and time the resource was created, expressed in RFC 3339 timestamp format. // **Example:** `2016-07-22T17:23:59:60Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The current state of the resource. LifecycleState TsigKeySummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m TsigKeySummary) String() string
TsigKeySummaryLifecycleStateEnum Enum with underlying type: string
type TsigKeySummaryLifecycleStateEnum string
Set of constants representing the allowable values for TsigKeySummaryLifecycleStateEnum
const ( TsigKeySummaryLifecycleStateActive TsigKeySummaryLifecycleStateEnum = "ACTIVE" TsigKeySummaryLifecycleStateCreating TsigKeySummaryLifecycleStateEnum = "CREATING" )
func GetTsigKeySummaryLifecycleStateEnumValues() []TsigKeySummaryLifecycleStateEnum
GetTsigKeySummaryLifecycleStateEnumValues Enumerates the set of values for TsigKeySummaryLifecycleStateEnum
UpdateDomainRecordsDetails The representation of UpdateDomainRecordsDetails
type UpdateDomainRecordsDetails struct { Items []RecordDetails `mandatory:"false" json:"items"` }
func (m UpdateDomainRecordsDetails) String() string
UpdateDomainRecordsRequest wrapper for the UpdateDomainRecords operation
type UpdateDomainRecordsRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The target fully-qualified domain name (FQDN) within the target zone. Domain *string `mandatory:"true" contributesTo:"path" name:"domain"` // A full list of records for the domain. UpdateDomainRecordsDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateDomainRecordsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDomainRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDomainRecordsRequest) String() string
UpdateDomainRecordsResponse wrapper for the UpdateDomainRecords operation
type UpdateDomainRecordsResponse struct { // The underlying http response RawResponse *http.Response // The RecordCollection instance RecordCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response UpdateDomainRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDomainRecordsResponse) String() string
UpdateRRSetRequest wrapper for the UpdateRRSet operation
type UpdateRRSetRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // The target fully-qualified domain name (FQDN) within the target zone. Domain *string `mandatory:"true" contributesTo:"path" name:"domain"` // The type of the target RRSet within the target zone. Rtype *string `mandatory:"true" contributesTo:"path" name:"rtype"` // A full list of records for the RRSet. UpdateRrSetDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateRRSetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRRSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRRSetRequest) String() string
UpdateRRSetResponse wrapper for the UpdateRRSet operation
type UpdateRRSetResponse struct { // The underlying http response RawResponse *http.Response // The RecordCollection instance RecordCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response UpdateRRSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRRSetResponse) String() string
UpdateRrSetDetails The representation of UpdateRrSetDetails
type UpdateRrSetDetails struct { Items []RecordDetails `mandatory:"false" json:"items"` }
func (m UpdateRrSetDetails) String() string
UpdateSteeringPolicyAttachmentDetails The body for updating a steering policy attachment.
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateSteeringPolicyAttachmentDetails struct { // A user-friendly name for the steering policy attachment. // Does not have to be unique and can be changed. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` }
func (m UpdateSteeringPolicyAttachmentDetails) String() string
UpdateSteeringPolicyAttachmentRequest wrapper for the UpdateSteeringPolicyAttachment operation
type UpdateSteeringPolicyAttachmentRequest struct { // The OCID of the target steering policy attachment. SteeringPolicyAttachmentId *string `mandatory:"true" contributesTo:"path" name:"steeringPolicyAttachmentId"` // New data for the steering policy attachment. UpdateSteeringPolicyAttachmentDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateSteeringPolicyAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSteeringPolicyAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSteeringPolicyAttachmentRequest) String() string
UpdateSteeringPolicyAttachmentResponse wrapper for the UpdateSteeringPolicyAttachment operation
type UpdateSteeringPolicyAttachmentResponse struct { // The underlying http response RawResponse *http.Response // The SteeringPolicyAttachment instance SteeringPolicyAttachment `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response UpdateSteeringPolicyAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSteeringPolicyAttachmentResponse) String() string
UpdateSteeringPolicyDetails The body for updating a steering policy. New rules and answers provided in the request will replace the existing rules and answers in the policy.
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateSteeringPolicyDetails struct { // A user-friendly name for the steering policy. Does not have to be unique and can be changed. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // The Time To Live (TTL) for responses from the steering policy, in seconds. // If not specified during creation, a value of 30 seconds will be used. Ttl *int `mandatory:"false" json:"ttl"` // The OCID of the health check monitor providing health data about the answers of the // steering policy. A steering policy answer with `rdata` matching a monitored endpoint // will use the health data of that endpoint. A steering policy answer with `rdata` not // matching any monitored endpoint will be assumed healthy. // // **Note:** To use the Health Check monitoring feature in a steering policy, a monitor // must be created using the Health Checks service first. For more information on how to // create a monitor, please see Managing Health Checks (https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). HealthCheckMonitorId *string `mandatory:"false" json:"healthCheckMonitorId"` // A set of predefined rules based on the desired purpose of the steering policy. Each // template utilizes Traffic Management's rules in a different order to produce the desired // results when answering DNS queries. // // **Example:** The `FAILOVER` template determines answers by filtering the policy's answers // using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, // and `LIMIT`. This gives the domain dynamic failover capability. // // It is **strongly recommended** to use a template other than `CUSTOM` when creating // a steering policy. // // All templates require the rule order to begin with an unconditional `FILTER` rule that keeps // answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined // `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. // The last rule of a template must must be a `LIMIT` rule. For more information about templates // and code examples, see Traffic Management API Guide (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). // **Template Types** // * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers // to serve. If an endpoint fails a health check, the answer for that endpoint will be removed // from the list of available answers until the endpoint is detected as healthy. // // * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. // // * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic // locations to route by, see Traffic Management Geographic Locations (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). // // * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN. // // * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address. // // * `CUSTOM` - Allows a customized configuration of rules. Template UpdateSteeringPolicyDetailsTemplateEnum `mandatory:"false" json:"template,omitempty"` // 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"` // The set of all answers that can potentially issue from the steering policy. Answers []SteeringPolicyAnswer `mandatory:"false" json:"answers"` // The series of rules that will be processed in sequence to reduce the pool of answers // to a response for any given request. // // The first rule receives a shuffled list of all answers, and every other rule receives // the list of answers emitted by the one preceding it. The last rule populates the // response. Rules []SteeringPolicyRule `mandatory:"false" json:"rules"` }
func (m UpdateSteeringPolicyDetails) String() string
func (m *UpdateSteeringPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
UpdateSteeringPolicyDetailsTemplateEnum Enum with underlying type: string
type UpdateSteeringPolicyDetailsTemplateEnum string
Set of constants representing the allowable values for UpdateSteeringPolicyDetailsTemplateEnum
const ( UpdateSteeringPolicyDetailsTemplateFailover UpdateSteeringPolicyDetailsTemplateEnum = "FAILOVER" UpdateSteeringPolicyDetailsTemplateLoadBalance UpdateSteeringPolicyDetailsTemplateEnum = "LOAD_BALANCE" UpdateSteeringPolicyDetailsTemplateRouteByGeo UpdateSteeringPolicyDetailsTemplateEnum = "ROUTE_BY_GEO" UpdateSteeringPolicyDetailsTemplateRouteByAsn UpdateSteeringPolicyDetailsTemplateEnum = "ROUTE_BY_ASN" UpdateSteeringPolicyDetailsTemplateRouteByIp UpdateSteeringPolicyDetailsTemplateEnum = "ROUTE_BY_IP" UpdateSteeringPolicyDetailsTemplateCustom UpdateSteeringPolicyDetailsTemplateEnum = "CUSTOM" )
func GetUpdateSteeringPolicyDetailsTemplateEnumValues() []UpdateSteeringPolicyDetailsTemplateEnum
GetUpdateSteeringPolicyDetailsTemplateEnumValues Enumerates the set of values for UpdateSteeringPolicyDetailsTemplateEnum
UpdateSteeringPolicyRequest wrapper for the UpdateSteeringPolicy operation
type UpdateSteeringPolicyRequest struct { // The OCID of the target steering policy. SteeringPolicyId *string `mandatory:"true" contributesTo:"path" name:"steeringPolicyId"` // New data for the steering policy. UpdateSteeringPolicyDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateSteeringPolicyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSteeringPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSteeringPolicyRequest) String() string
UpdateSteeringPolicyResponse wrapper for the UpdateSteeringPolicy operation
type UpdateSteeringPolicyResponse struct { // The underlying http response RawResponse *http.Response // The SteeringPolicy instance SteeringPolicy `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response UpdateSteeringPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSteeringPolicyResponse) String() string
UpdateTsigKeyDetails The body for updating a TSIG key. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateTsigKeyDetails struct { // 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"` }
func (m UpdateTsigKeyDetails) String() string
UpdateTsigKeyRequest wrapper for the UpdateTsigKey operation
type UpdateTsigKeyRequest struct { // The OCID of the target TSIG key. TsigKeyId *string `mandatory:"true" contributesTo:"path" name:"tsigKeyId"` // New data for the TSIG key. UpdateTsigKeyDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateTsigKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTsigKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTsigKeyRequest) String() string
UpdateTsigKeyResponse wrapper for the UpdateTsigKey operation
type UpdateTsigKeyResponse struct { // The underlying http response RawResponse *http.Response // The TsigKey instance TsigKey `presentIn:"body"` // The current version of the resource, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request // ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateTsigKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTsigKeyResponse) String() string
UpdateZoneDetails The body for updating a zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateZoneDetails struct { // 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"` // External master servers for the zone. `externalMasters` becomes a // required parameter when the `zoneType` value is `SECONDARY`. ExternalMasters []ExternalMaster `mandatory:"false" json:"externalMasters"` }
func (m UpdateZoneDetails) String() string
UpdateZoneRecordsDetails The representation of UpdateZoneRecordsDetails
type UpdateZoneRecordsDetails struct { Items []RecordDetails `mandatory:"false" json:"items"` }
func (m UpdateZoneRecordsDetails) String() string
UpdateZoneRecordsRequest wrapper for the UpdateZoneRecords operation
type UpdateZoneRecordsRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // A full list of records for the zone. UpdateZoneRecordsDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateZoneRecordsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateZoneRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateZoneRecordsRequest) String() string
UpdateZoneRecordsResponse wrapper for the UpdateZoneRecords operation
type UpdateZoneRecordsResponse struct { // The underlying http response RawResponse *http.Response // The RecordCollection instance RecordCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, // see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // The total number of items that match the query. OpcTotalItems *int `presentIn:"header" name:"opc-total-items"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the record collection, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response UpdateZoneRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateZoneRecordsResponse) String() string
UpdateZoneRequest wrapper for the UpdateZone operation
type UpdateZoneRequest struct { // The name or OCID of the target zone. ZoneNameOrId *string `mandatory:"true" contributesTo:"path" name:"zoneNameOrId"` // New data for the zone. UpdateZoneDetails `contributesTo:"body"` // The `If-Match` header field makes the request method conditional on the // existence of at least one current representation of the target resource, // when the field-value is `*`, or having a current representation of the // target resource that has an entity-tag matching a member of the list of // entity-tags provided in the field-value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"If-Match"` // The `If-Unmodified-Since` header field makes the request method // conditional on the selected representation's last modification date being // earlier than or equal to the date provided in the field-value. This // field accomplishes the same purpose as If-Match for cases where the user // agent does not have an entity-tag for the representation. IfUnmodifiedSince *string `mandatory:"false" contributesTo:"header" name:"If-Unmodified-Since"` // Unique Oracle-assigned identifier for the request. If you need // to contact Oracle about a particular request, please provide // the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The OCID of the compartment the resource belongs to. CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateZoneRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateZoneRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateZoneRequest) String() string
UpdateZoneResponse wrapper for the UpdateZone operation
type UpdateZoneResponse struct { // The underlying http response RawResponse *http.Response // The Zone instance Zone `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to // contact Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // The current version of the zone, ending with a // representation-specific suffix. This value may be used in If-Match // and If-None-Match headers for later requests of the same resource. ETag *string `presentIn:"header" name:"etag"` }
func (response UpdateZoneResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateZoneResponse) String() string
Zone A DNS zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type Zone struct { // The name of the zone. Name *string `mandatory:"false" json:"name"` // The type of the zone. Must be either `PRIMARY` or `SECONDARY`. ZoneType ZoneZoneTypeEnum `mandatory:"false" json:"zoneType,omitempty"` // The OCID of the compartment containing the zone. CompartmentId *string `mandatory:"false" json:"compartmentId"` // 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"` // External master servers for the zone. `externalMasters` becomes a // required parameter when the `zoneType` value is `SECONDARY`. ExternalMasters []ExternalMaster `mandatory:"false" json:"externalMasters"` // The canonical absolute URL of the resource. Self *string `mandatory:"false" json:"self"` // The OCID of the zone. Id *string `mandatory:"false" json:"id"` // The date and time the resource was created in "YYYY-MM-ddThh:mmZ" format // with a Z offset, as defined by RFC 3339. // **Example:** `2016-07-22T17:23:59:60Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Version is the never-repeating, totally-orderable, version of the // zone, from which the serial field of the zone's SOA record is // derived. Version *string `mandatory:"false" json:"version"` // The current serial of the zone. As seen in the zone's SOA record. Serial *int64 `mandatory:"false" json:"serial"` // The current state of the zone resource. LifecycleState ZoneLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` // The authoritative nameservers for the zone. Nameservers []Nameserver `mandatory:"false" json:"nameservers"` }
func (m Zone) String() string
ZoneLifecycleStateEnum Enum with underlying type: string
type ZoneLifecycleStateEnum string
Set of constants representing the allowable values for ZoneLifecycleStateEnum
const ( ZoneLifecycleStateActive ZoneLifecycleStateEnum = "ACTIVE" ZoneLifecycleStateCreating ZoneLifecycleStateEnum = "CREATING" ZoneLifecycleStateDeleted ZoneLifecycleStateEnum = "DELETED" ZoneLifecycleStateDeleting ZoneLifecycleStateEnum = "DELETING" ZoneLifecycleStateFailed ZoneLifecycleStateEnum = "FAILED" )
func GetZoneLifecycleStateEnumValues() []ZoneLifecycleStateEnum
GetZoneLifecycleStateEnumValues Enumerates the set of values for ZoneLifecycleStateEnum
ZoneSummary A DNS zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type ZoneSummary struct { // The name of the zone. Name *string `mandatory:"false" json:"name"` // The type of the zone. Must be either `PRIMARY` or `SECONDARY`. ZoneType ZoneSummaryZoneTypeEnum `mandatory:"false" json:"zoneType,omitempty"` // The OCID of the compartment containing the zone. CompartmentId *string `mandatory:"false" json:"compartmentId"` // 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"` // The canonical absolute URL of the resource. Self *string `mandatory:"false" json:"self"` // The OCID of the zone. Id *string `mandatory:"false" json:"id"` // The date and time the resource was created in "YYYY-MM-ddThh:mmZ" format // with a Z offset, as defined by RFC 3339. // **Example:** `2016-07-22T17:23:59:60Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Version is the never-repeating, totally-orderable, version of the // zone, from which the serial field of the zone's SOA record is // derived. Version *string `mandatory:"false" json:"version"` // The current serial of the zone. As seen in the zone's SOA record. Serial *int64 `mandatory:"false" json:"serial"` // The current state of the zone resource. LifecycleState ZoneSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m ZoneSummary) String() string
ZoneSummaryLifecycleStateEnum Enum with underlying type: string
type ZoneSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ZoneSummaryLifecycleStateEnum
const ( ZoneSummaryLifecycleStateActive ZoneSummaryLifecycleStateEnum = "ACTIVE" ZoneSummaryLifecycleStateCreating ZoneSummaryLifecycleStateEnum = "CREATING" ZoneSummaryLifecycleStateDeleted ZoneSummaryLifecycleStateEnum = "DELETED" ZoneSummaryLifecycleStateDeleting ZoneSummaryLifecycleStateEnum = "DELETING" ZoneSummaryLifecycleStateFailed ZoneSummaryLifecycleStateEnum = "FAILED" )
func GetZoneSummaryLifecycleStateEnumValues() []ZoneSummaryLifecycleStateEnum
GetZoneSummaryLifecycleStateEnumValues Enumerates the set of values for ZoneSummaryLifecycleStateEnum
ZoneSummaryZoneTypeEnum Enum with underlying type: string
type ZoneSummaryZoneTypeEnum string
Set of constants representing the allowable values for ZoneSummaryZoneTypeEnum
const ( ZoneSummaryZoneTypePrimary ZoneSummaryZoneTypeEnum = "PRIMARY" ZoneSummaryZoneTypeSecondary ZoneSummaryZoneTypeEnum = "SECONDARY" )
func GetZoneSummaryZoneTypeEnumValues() []ZoneSummaryZoneTypeEnum
GetZoneSummaryZoneTypeEnumValues Enumerates the set of values for ZoneSummaryZoneTypeEnum
ZoneZoneTypeEnum Enum with underlying type: string
type ZoneZoneTypeEnum string
Set of constants representing the allowable values for ZoneZoneTypeEnum
const ( ZoneZoneTypePrimary ZoneZoneTypeEnum = "PRIMARY" ZoneZoneTypeSecondary ZoneZoneTypeEnum = "SECONDARY" )
func GetZoneZoneTypeEnumValues() []ZoneZoneTypeEnum
GetZoneZoneTypeEnumValues Enumerates the set of values for ZoneZoneTypeEnum