// Copyright (c) 2016, 2018, 2026, Oracle and/or its affiliates.  All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.

// Network Firewall API
//
// Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs.
//

package networkfirewall

import (
	"encoding/json"
	"fmt"
	"github.com/oracle/oci-go-sdk/v65/common"
	"strings"
)

// VxlanInspectionRule Vxlan Tunnel Inspection Rule used on the firewall policy rules.
type VxlanInspectionRule struct {

	// Name for the Tunnel Inspection Rule, must be unique within the policy.
	Name *string `mandatory:"true" json:"name"`

	// OCID of the Network Firewall Policy this Tunnel Inspection Rule belongs to.
	ParentResourceId *string `mandatory:"true" json:"parentResourceId"`

	Condition *VxlanInspectionRuleMatchCriteria `mandatory:"true" json:"condition"`

	Profile *VxlanInspectionRuleProfile `mandatory:"true" json:"profile"`

	// The priority order in which this rule should be evaluated
	PriorityOrder *int64 `mandatory:"false" json:"priorityOrder"`

	Position *RulePosition `mandatory:"false" json:"position"`

	// The description of the tunnel inspect rule. This field can be used to add additional info.
	Description *string `mandatory:"false" json:"description"`

	// Types of Inspect Action on the Traffic flow.
	//   * INSPECT - Inspect the traffic.
	//   * INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic.
	Action InspectActionTypeEnum `mandatory:"false" json:"action,omitempty"`
}

// GetName returns Name
func (m VxlanInspectionRule) GetName() *string {
	return m.Name
}

// GetAction returns Action
func (m VxlanInspectionRule) GetAction() InspectActionTypeEnum {
	return m.Action
}

// GetPriorityOrder returns PriorityOrder
func (m VxlanInspectionRule) GetPriorityOrder() *int64 {
	return m.PriorityOrder
}

// GetPosition returns Position
func (m VxlanInspectionRule) GetPosition() *RulePosition {
	return m.Position
}

// GetParentResourceId returns ParentResourceId
func (m VxlanInspectionRule) GetParentResourceId() *string {
	return m.ParentResourceId
}

// GetDescription returns Description
func (m VxlanInspectionRule) GetDescription() *string {
	return m.Description
}

func (m VxlanInspectionRule) String() string {
	return common.PointerString(m)
}

// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m VxlanInspectionRule) ValidateEnumValue() (bool, error) {
	errMessage := []string{}

	if _, ok := GetMappingInspectActionTypeEnum(string(m.Action)); !ok && m.Action != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Action: %s. Supported values are: %s.", m.Action, strings.Join(GetInspectActionTypeEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf("%s", strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// MarshalJSON marshals to json representation
func (m VxlanInspectionRule) MarshalJSON() (buff []byte, e error) {
	type MarshalTypeVxlanInspectionRule VxlanInspectionRule
	s := struct {
		DiscriminatorParam string `json:"protocol"`
		MarshalTypeVxlanInspectionRule
	}{
		"VXLAN",
		(MarshalTypeVxlanInspectionRule)(m),
	}

	return json.Marshal(&s)
}
