api_describe_nat_gateway_attributes.go

// Code generated by volcengine with private/model/cli/gen-api/main.go. DO NOT EDIT.

package natgateway

import (
	"github.com/volcengine/volcengine-go-sdk/volcengine"
	"github.com/volcengine/volcengine-go-sdk/volcengine/request"
	"github.com/volcengine/volcengine-go-sdk/volcengine/response"
	"github.com/volcengine/volcengine-go-sdk/volcengine/volcengineutil"
)

const opDescribeNatGatewayAttributesCommon = "DescribeNatGatewayAttributes"

// DescribeNatGatewayAttributesCommonRequest generates a "volcengine/request.Request" representing the
// client's request for the DescribeNatGatewayAttributesCommon operation. The "output" return
// value will be populated with the DescribeNatGatewayAttributesCommon request's response once the request completes
// successfully.
//
// Use "Send" method on the returned DescribeNatGatewayAttributesCommon Request to send the API call to the service.
// the "output" return value is not valid until after DescribeNatGatewayAttributesCommon Send returns without error.
//
// See DescribeNatGatewayAttributesCommon for more information on using the DescribeNatGatewayAttributesCommon
// API call, and error handling.
//
//    // Example sending a request using the DescribeNatGatewayAttributesCommonRequest method.
//    req, resp := client.DescribeNatGatewayAttributesCommonRequest(params)
//
//    err := req.Send()
//    if err == nil { // resp is now filled
//        fmt.Println(resp)
//    }
func (c *NATGATEWAY) DescribeNatGatewayAttributesCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{}) {
	op := &request.Operation{
		Name:       opDescribeNatGatewayAttributesCommon,
		HTTPMethod: "GET",
		HTTPPath:   "/",
	}

	if input == nil {
		input = &map[string]interface{}{}
	}

	output = &map[string]interface{}{}
	req = c.newRequest(op, input, output)

	return
}

// DescribeNatGatewayAttributesCommon API operation for NATGATEWAY.
//
// Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions
// with volcengineerr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the VOLCENGINE API reference guide for NATGATEWAY's
// API operation DescribeNatGatewayAttributesCommon for usage and error information.
func (c *NATGATEWAY) DescribeNatGatewayAttributesCommon(input *map[string]interface{}) (*map[string]interface{}, error) {
	req, out := c.DescribeNatGatewayAttributesCommonRequest(input)
	return out, req.Send()
}

// DescribeNatGatewayAttributesCommonWithContext is the same as DescribeNatGatewayAttributesCommon with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeNatGatewayAttributesCommon for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur.
// In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *NATGATEWAY) DescribeNatGatewayAttributesCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error) {
	req, out := c.DescribeNatGatewayAttributesCommonRequest(input)
	req.SetContext(ctx)
	req.ApplyOptions(opts...)
	return out, req.Send()
}

const opDescribeNatGatewayAttributes = "DescribeNatGatewayAttributes"

// DescribeNatGatewayAttributesRequest generates a "volcengine/request.Request" representing the
// client's request for the DescribeNatGatewayAttributes operation. The "output" return
// value will be populated with the DescribeNatGatewayAttributesCommon request's response once the request completes
// successfully.
//
// Use "Send" method on the returned DescribeNatGatewayAttributesCommon Request to send the API call to the service.
// the "output" return value is not valid until after DescribeNatGatewayAttributesCommon Send returns without error.
//
// See DescribeNatGatewayAttributes for more information on using the DescribeNatGatewayAttributes
// API call, and error handling.
//
//    // Example sending a request using the DescribeNatGatewayAttributesRequest method.
//    req, resp := client.DescribeNatGatewayAttributesRequest(params)
//
//    err := req.Send()
//    if err == nil { // resp is now filled
//        fmt.Println(resp)
//    }
func (c *NATGATEWAY) DescribeNatGatewayAttributesRequest(input *DescribeNatGatewayAttributesInput) (req *request.Request, output *DescribeNatGatewayAttributesOutput) {
	op := &request.Operation{
		Name:       opDescribeNatGatewayAttributes,
		HTTPMethod: "GET",
		HTTPPath:   "/",
	}

	if input == nil {
		input = &DescribeNatGatewayAttributesInput{}
	}

	output = &DescribeNatGatewayAttributesOutput{}
	req = c.newRequest(op, input, output)

	return
}

// DescribeNatGatewayAttributes API operation for NATGATEWAY.
//
// Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions
// with volcengineerr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the VOLCENGINE API reference guide for NATGATEWAY's
// API operation DescribeNatGatewayAttributes for usage and error information.
func (c *NATGATEWAY) DescribeNatGatewayAttributes(input *DescribeNatGatewayAttributesInput) (*DescribeNatGatewayAttributesOutput, error) {
	req, out := c.DescribeNatGatewayAttributesRequest(input)
	return out, req.Send()
}

// DescribeNatGatewayAttributesWithContext is the same as DescribeNatGatewayAttributes with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeNatGatewayAttributes for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. Ifthe context is nil a panic will occur.
// In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *NATGATEWAY) DescribeNatGatewayAttributesWithContext(ctx volcengine.Context, input *DescribeNatGatewayAttributesInput, opts ...request.Option) (*DescribeNatGatewayAttributesOutput, error) {
	req, out := c.DescribeNatGatewayAttributesRequest(input)
	req.SetContext(ctx)
	req.ApplyOptions(opts...)
	return out, req.Send()
}

type DescribeNatGatewayAttributesInput struct {
	_ struct{} `type:"structure"`

	// NatGatewayId is a required field
	NatGatewayId *string `type:"string" required:"true"`
}

// String returns the string representation
func (s DescribeNatGatewayAttributesInput) String() string {
	return volcengineutil.Prettify(s)
}

// GoString returns the string representation
func (s DescribeNatGatewayAttributesInput) GoString() string {
	return s.String()
}

// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeNatGatewayAttributesInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "DescribeNatGatewayAttributesInput"}
	if s.NatGatewayId == nil {
		invalidParams.Add(request.NewErrParamRequired("NatGatewayId"))
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}

// SetNatGatewayId sets the NatGatewayId field's value.
func (s *DescribeNatGatewayAttributesInput) SetNatGatewayId(v string) *DescribeNatGatewayAttributesInput {
	s.NatGatewayId = &v
	return s
}

type DescribeNatGatewayAttributesOutput struct {
	_ struct{} `type:"structure"`

	Metadata *response.ResponseMetadata

	BillingType *int64 `type:"integer"`

	BusinessStatus *string `type:"string"`

	CreationTime *string `type:"string"`

	DeletedTime *string `type:"string"`

	Description *string `type:"string"`

	DnatEntryIds []*string `type:"list"`

	EipAddresses []*EipAddressForDescribeNatGatewayAttributesOutput `type:"list"`

	ExpiredTime *string `type:"string"`

	LockReason *string `type:"string"`

	NatGatewayId *string `type:"string"`

	NatGatewayName *string `type:"string"`

	NetworkInterfaceId *string `type:"string"`

	NetworkType *string `type:"string"`

	OverdueTime *string `type:"string"`

	ProjectName *string `type:"string"`

	RequestId *string `type:"string"`

	SnatEntryIds []*string `type:"list"`

	Spec *string `type:"string"`

	Status *string `type:"string"`

	SubnetId *string `type:"string"`

	Tags []*TagForDescribeNatGatewayAttributesOutput `type:"list"`

	UpdatedAt *string `type:"string"`

	VpcId *string `type:"string"`

	ZoneId *string `type:"string"`
}

// String returns the string representation
func (s DescribeNatGatewayAttributesOutput) String() string {
	return volcengineutil.Prettify(s)
}

// GoString returns the string representation
func (s DescribeNatGatewayAttributesOutput) GoString() string {
	return s.String()
}

// SetBillingType sets the BillingType field's value.
func (s *DescribeNatGatewayAttributesOutput) SetBillingType(v int64) *DescribeNatGatewayAttributesOutput {
	s.BillingType = &v
	return s
}

// SetBusinessStatus sets the BusinessStatus field's value.
func (s *DescribeNatGatewayAttributesOutput) SetBusinessStatus(v string) *DescribeNatGatewayAttributesOutput {
	s.BusinessStatus = &v
	return s
}

// SetCreationTime sets the CreationTime field's value.
func (s *DescribeNatGatewayAttributesOutput) SetCreationTime(v string) *DescribeNatGatewayAttributesOutput {
	s.CreationTime = &v
	return s
}

// SetDeletedTime sets the DeletedTime field's value.
func (s *DescribeNatGatewayAttributesOutput) SetDeletedTime(v string) *DescribeNatGatewayAttributesOutput {
	s.DeletedTime = &v
	return s
}

// SetDescription sets the Description field's value.
func (s *DescribeNatGatewayAttributesOutput) SetDescription(v string) *DescribeNatGatewayAttributesOutput {
	s.Description = &v
	return s
}

// SetDnatEntryIds sets the DnatEntryIds field's value.
func (s *DescribeNatGatewayAttributesOutput) SetDnatEntryIds(v []*string) *DescribeNatGatewayAttributesOutput {
	s.DnatEntryIds = v
	return s
}

// SetEipAddresses sets the EipAddresses field's value.
func (s *DescribeNatGatewayAttributesOutput) SetEipAddresses(v []*EipAddressForDescribeNatGatewayAttributesOutput) *DescribeNatGatewayAttributesOutput {
	s.EipAddresses = v
	return s
}

// SetExpiredTime sets the ExpiredTime field's value.
func (s *DescribeNatGatewayAttributesOutput) SetExpiredTime(v string) *DescribeNatGatewayAttributesOutput {
	s.ExpiredTime = &v
	return s
}

// SetLockReason sets the LockReason field's value.
func (s *DescribeNatGatewayAttributesOutput) SetLockReason(v string) *DescribeNatGatewayAttributesOutput {
	s.LockReason = &v
	return s
}

// SetNatGatewayId sets the NatGatewayId field's value.
func (s *DescribeNatGatewayAttributesOutput) SetNatGatewayId(v string) *DescribeNatGatewayAttributesOutput {
	s.NatGatewayId = &v
	return s
}

// SetNatGatewayName sets the NatGatewayName field's value.
func (s *DescribeNatGatewayAttributesOutput) SetNatGatewayName(v string) *DescribeNatGatewayAttributesOutput {
	s.NatGatewayName = &v
	return s
}

// SetNetworkInterfaceId sets the NetworkInterfaceId field's value.
func (s *DescribeNatGatewayAttributesOutput) SetNetworkInterfaceId(v string) *DescribeNatGatewayAttributesOutput {
	s.NetworkInterfaceId = &v
	return s
}

// SetNetworkType sets the NetworkType field's value.
func (s *DescribeNatGatewayAttributesOutput) SetNetworkType(v string) *DescribeNatGatewayAttributesOutput {
	s.NetworkType = &v
	return s
}

// SetOverdueTime sets the OverdueTime field's value.
func (s *DescribeNatGatewayAttributesOutput) SetOverdueTime(v string) *DescribeNatGatewayAttributesOutput {
	s.OverdueTime = &v
	return s
}

// SetProjectName sets the ProjectName field's value.
func (s *DescribeNatGatewayAttributesOutput) SetProjectName(v string) *DescribeNatGatewayAttributesOutput {
	s.ProjectName = &v
	return s
}

// SetRequestId sets the RequestId field's value.
func (s *DescribeNatGatewayAttributesOutput) SetRequestId(v string) *DescribeNatGatewayAttributesOutput {
	s.RequestId = &v
	return s
}

// SetSnatEntryIds sets the SnatEntryIds field's value.
func (s *DescribeNatGatewayAttributesOutput) SetSnatEntryIds(v []*string) *DescribeNatGatewayAttributesOutput {
	s.SnatEntryIds = v
	return s
}

// SetSpec sets the Spec field's value.
func (s *DescribeNatGatewayAttributesOutput) SetSpec(v string) *DescribeNatGatewayAttributesOutput {
	s.Spec = &v
	return s
}

// SetStatus sets the Status field's value.
func (s *DescribeNatGatewayAttributesOutput) SetStatus(v string) *DescribeNatGatewayAttributesOutput {
	s.Status = &v
	return s
}

// SetSubnetId sets the SubnetId field's value.
func (s *DescribeNatGatewayAttributesOutput) SetSubnetId(v string) *DescribeNatGatewayAttributesOutput {
	s.SubnetId = &v
	return s
}

// SetTags sets the Tags field's value.
func (s *DescribeNatGatewayAttributesOutput) SetTags(v []*TagForDescribeNatGatewayAttributesOutput) *DescribeNatGatewayAttributesOutput {
	s.Tags = v
	return s
}

// SetUpdatedAt sets the UpdatedAt field's value.
func (s *DescribeNatGatewayAttributesOutput) SetUpdatedAt(v string) *DescribeNatGatewayAttributesOutput {
	s.UpdatedAt = &v
	return s
}

// SetVpcId sets the VpcId field's value.
func (s *DescribeNatGatewayAttributesOutput) SetVpcId(v string) *DescribeNatGatewayAttributesOutput {
	s.VpcId = &v
	return s
}

// SetZoneId sets the ZoneId field's value.
func (s *DescribeNatGatewayAttributesOutput) SetZoneId(v string) *DescribeNatGatewayAttributesOutput {
	s.ZoneId = &v
	return s
}

type EipAddressForDescribeNatGatewayAttributesOutput struct {
	_ struct{} `type:"structure"`

	AllocationId *string `type:"string"`

	EipAddress *string `type:"string"`

	UsingStatus *string `type:"string"`
}

// String returns the string representation
func (s EipAddressForDescribeNatGatewayAttributesOutput) String() string {
	return volcengineutil.Prettify(s)
}

// GoString returns the string representation
func (s EipAddressForDescribeNatGatewayAttributesOutput) GoString() string {
	return s.String()
}

// SetAllocationId sets the AllocationId field's value.
func (s *EipAddressForDescribeNatGatewayAttributesOutput) SetAllocationId(v string) *EipAddressForDescribeNatGatewayAttributesOutput {
	s.AllocationId = &v
	return s
}

// SetEipAddress sets the EipAddress field's value.
func (s *EipAddressForDescribeNatGatewayAttributesOutput) SetEipAddress(v string) *EipAddressForDescribeNatGatewayAttributesOutput {
	s.EipAddress = &v
	return s
}

// SetUsingStatus sets the UsingStatus field's value.
func (s *EipAddressForDescribeNatGatewayAttributesOutput) SetUsingStatus(v string) *EipAddressForDescribeNatGatewayAttributesOutput {
	s.UsingStatus = &v
	return s
}

type TagForDescribeNatGatewayAttributesOutput struct {
	_ struct{} `type:"structure"`

	Key *string `type:"string"`

	Value *string `type:"string"`
}

// String returns the string representation
func (s TagForDescribeNatGatewayAttributesOutput) String() string {
	return volcengineutil.Prettify(s)
}

// GoString returns the string representation
func (s TagForDescribeNatGatewayAttributesOutput) GoString() string {
	return s.String()
}

// SetKey sets the Key field's value.
func (s *TagForDescribeNatGatewayAttributesOutput) SetKey(v string) *TagForDescribeNatGatewayAttributesOutput {
	s.Key = &v
	return s
}

// SetValue sets the Value field's value.
func (s *TagForDescribeNatGatewayAttributesOutput) SetValue(v string) *TagForDescribeNatGatewayAttributesOutput {
	s.Value = &v
	return s
}