icmp_protocol_parameters.go

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

// Network Monitoring API
//
// Use the Network Monitoring API to troubleshoot routing and security issues for resources such as virtual cloud networks (VCNs) and compute instances. For more information, see the console
// documentation for the Network Path Analyzer (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/path_analyzer.htm) tool.
//

package vnmonitoring

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

// IcmpProtocolParameters Defines the configuration for the ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) protocol parameters.
type IcmpProtocolParameters struct {

	// The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type.
	IcmpType *int `mandatory:"true" json:"icmpType"`

	// The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code.
	IcmpCode *int `mandatory:"false" json:"icmpCode"`
}

func (m IcmpProtocolParameters) 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 IcmpProtocolParameters) ValidateEnumValue() (bool, error) {
	errMessage := []string{}

	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

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

	return json.Marshal(&s)
}