api_describe_security_group_attributes.go

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

package vpc

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 opDescribeSecurityGroupAttributesCommon = "DescribeSecurityGroupAttributes"

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

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

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

	return
}

// DescribeSecurityGroupAttributesCommon API operation for VPC.
//
// 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 VPC's
// API operation DescribeSecurityGroupAttributesCommon for usage and error information.
func (c *VPC) DescribeSecurityGroupAttributesCommon(input *map[string]interface{}) (*map[string]interface{}, error) {
	req, out := c.DescribeSecurityGroupAttributesCommonRequest(input)
	return out, req.Send()
}

// DescribeSecurityGroupAttributesCommonWithContext is the same as DescribeSecurityGroupAttributesCommon with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeSecurityGroupAttributesCommon 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 *VPC) DescribeSecurityGroupAttributesCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error) {
	req, out := c.DescribeSecurityGroupAttributesCommonRequest(input)
	req.SetContext(ctx)
	req.ApplyOptions(opts...)
	return out, req.Send()
}

const opDescribeSecurityGroupAttributes = "DescribeSecurityGroupAttributes"

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

	if input == nil {
		input = &DescribeSecurityGroupAttributesInput{}
	}

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

	return
}

// DescribeSecurityGroupAttributes API operation for VPC.
//
// 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 VPC's
// API operation DescribeSecurityGroupAttributes for usage and error information.
func (c *VPC) DescribeSecurityGroupAttributes(input *DescribeSecurityGroupAttributesInput) (*DescribeSecurityGroupAttributesOutput, error) {
	req, out := c.DescribeSecurityGroupAttributesRequest(input)
	return out, req.Send()
}

// DescribeSecurityGroupAttributesWithContext is the same as DescribeSecurityGroupAttributes with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeSecurityGroupAttributes 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 *VPC) DescribeSecurityGroupAttributesWithContext(ctx volcengine.Context, input *DescribeSecurityGroupAttributesInput, opts ...request.Option) (*DescribeSecurityGroupAttributesOutput, error) {
	req, out := c.DescribeSecurityGroupAttributesRequest(input)
	req.SetContext(ctx)
	req.ApplyOptions(opts...)
	return out, req.Send()
}

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

	CidrIp *string `type:"string"`

	Direction *string `type:"string"`

	PrefixListId *string `type:"string"`

	Protocol *string `type:"string"`

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

	SourceGroupId *string `type:"string"`
}

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

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

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

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

// SetCidrIp sets the CidrIp field's value.
func (s *DescribeSecurityGroupAttributesInput) SetCidrIp(v string) *DescribeSecurityGroupAttributesInput {
	s.CidrIp = &v
	return s
}

// SetDirection sets the Direction field's value.
func (s *DescribeSecurityGroupAttributesInput) SetDirection(v string) *DescribeSecurityGroupAttributesInput {
	s.Direction = &v
	return s
}

// SetPrefixListId sets the PrefixListId field's value.
func (s *DescribeSecurityGroupAttributesInput) SetPrefixListId(v string) *DescribeSecurityGroupAttributesInput {
	s.PrefixListId = &v
	return s
}

// SetProtocol sets the Protocol field's value.
func (s *DescribeSecurityGroupAttributesInput) SetProtocol(v string) *DescribeSecurityGroupAttributesInput {
	s.Protocol = &v
	return s
}

// SetSecurityGroupId sets the SecurityGroupId field's value.
func (s *DescribeSecurityGroupAttributesInput) SetSecurityGroupId(v string) *DescribeSecurityGroupAttributesInput {
	s.SecurityGroupId = &v
	return s
}

// SetSourceGroupId sets the SourceGroupId field's value.
func (s *DescribeSecurityGroupAttributesInput) SetSourceGroupId(v string) *DescribeSecurityGroupAttributesInput {
	s.SourceGroupId = &v
	return s
}

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

	Metadata *response.ResponseMetadata

	CreationTime *string `type:"string"`

	Description *string `type:"string"`

	Permissions []*PermissionForDescribeSecurityGroupAttributesOutput `type:"list"`

	ProjectName *string `type:"string"`

	RequestId *string `type:"string"`

	SecurityGroupId *string `type:"string"`

	SecurityGroupName *string `type:"string"`

	ServiceManaged *bool `type:"boolean"`

	Status *string `type:"string"`

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

	Type *string `type:"string"`

	UpdateTime *string `type:"string"`

	VpcId *string `type:"string"`
}

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

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

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

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

// SetPermissions sets the Permissions field's value.
func (s *DescribeSecurityGroupAttributesOutput) SetPermissions(v []*PermissionForDescribeSecurityGroupAttributesOutput) *DescribeSecurityGroupAttributesOutput {
	s.Permissions = v
	return s
}

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

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

// SetSecurityGroupId sets the SecurityGroupId field's value.
func (s *DescribeSecurityGroupAttributesOutput) SetSecurityGroupId(v string) *DescribeSecurityGroupAttributesOutput {
	s.SecurityGroupId = &v
	return s
}

// SetSecurityGroupName sets the SecurityGroupName field's value.
func (s *DescribeSecurityGroupAttributesOutput) SetSecurityGroupName(v string) *DescribeSecurityGroupAttributesOutput {
	s.SecurityGroupName = &v
	return s
}

// SetServiceManaged sets the ServiceManaged field's value.
func (s *DescribeSecurityGroupAttributesOutput) SetServiceManaged(v bool) *DescribeSecurityGroupAttributesOutput {
	s.ServiceManaged = &v
	return s
}

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

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

// SetType sets the Type field's value.
func (s *DescribeSecurityGroupAttributesOutput) SetType(v string) *DescribeSecurityGroupAttributesOutput {
	s.Type = &v
	return s
}

// SetUpdateTime sets the UpdateTime field's value.
func (s *DescribeSecurityGroupAttributesOutput) SetUpdateTime(v string) *DescribeSecurityGroupAttributesOutput {
	s.UpdateTime = &v
	return s
}

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

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

	CidrIp *string `type:"string"`

	CreationTime *string `type:"string"`

	Description *string `type:"string"`

	Direction *string `type:"string"`

	Policy *string `type:"string"`

	PortEnd *int64 `type:"integer"`

	PortStart *int64 `type:"integer"`

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

	PrefixListId *string `type:"string"`

	Priority *int64 `type:"integer"`

	Protocol *string `type:"string"`

	SourceGroupId *string `type:"string"`

	UpdateTime *string `type:"string"`
}

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

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

// SetCidrIp sets the CidrIp field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetCidrIp(v string) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.CidrIp = &v
	return s
}

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

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

// SetDirection sets the Direction field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetDirection(v string) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.Direction = &v
	return s
}

// SetPolicy sets the Policy field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetPolicy(v string) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.Policy = &v
	return s
}

// SetPortEnd sets the PortEnd field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetPortEnd(v int64) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.PortEnd = &v
	return s
}

// SetPortStart sets the PortStart field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetPortStart(v int64) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.PortStart = &v
	return s
}

// SetPrefixListCidrs sets the PrefixListCidrs field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetPrefixListCidrs(v []*string) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.PrefixListCidrs = v
	return s
}

// SetPrefixListId sets the PrefixListId field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetPrefixListId(v string) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.PrefixListId = &v
	return s
}

// SetPriority sets the Priority field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetPriority(v int64) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.Priority = &v
	return s
}

// SetProtocol sets the Protocol field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetProtocol(v string) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.Protocol = &v
	return s
}

// SetSourceGroupId sets the SourceGroupId field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetSourceGroupId(v string) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.SourceGroupId = &v
	return s
}

// SetUpdateTime sets the UpdateTime field's value.
func (s *PermissionForDescribeSecurityGroupAttributesOutput) SetUpdateTime(v string) *PermissionForDescribeSecurityGroupAttributesOutput {
	s.UpdateTime = &v
	return s
}

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

	Key *string `type:"string"`

	Value *string `type:"string"`
}

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

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

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

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