endpoints

Documentation

Index

• type CreateOpts
  • func (opts CreateOpts) ToEndpointCreateMap() (map[string]interface{}, error)
• type CreateOptsBuilder
• type CreateResult
  • func Create(c *golangsdk.ServiceClient, opts CreateOptsBuilder) (r CreateResult)
  • func (r CreateResult) Extract() (*Endpoint, error)
• type DeleteResult
  • func Delete(c *golangsdk.ServiceClient, endpointID string) (r DeleteResult)
• type Endpoint
  • func List(client *golangsdk.ServiceClient, opts ListOptsBuilder) ([]Endpoint, error)
• type GetResult
  • func Get(c *golangsdk.ServiceClient, endpointID string) (r GetResult)
  • func (r GetResult) Extract() (*Endpoint, error)
• type ListOpts
  • func (opts ListOpts) ToEndpointListQuery() (string, error)
• type ListOptsBuilder
• type ListResult
  • func (r ListResult) Extract() (*Endpoint, error)
  • func (r ListResult) ExtractEndpoints() ([]Endpoint, error)

Types

type CreateOpts

type CreateOpts struct {
	// Specifies the ID of the VPC endpoint service
	ServiceID string `json:"endpoint_service_id" required:"true"`
	// Specifies the ID of the VPC where the VPC endpoint is to be created
	VpcID string `json:"vpc_id" required:"true"`

	// Specifies the network ID of the subnet created in the VPC specified by vpc_id
	// The parameter is mandatory to create an interface VPC endpoint
	SubnetID string `json:"subnet_id,omitempty"`
	// Specifies the IP address for accessing the associated VPC endpoint service
	PortIP string `json:"port_ip,omitempty"`
	// Specifies whether to create a private domain name
	EnableDNS *bool `json:"enable_dns,omitempty"`
	// Specifies whether to enable access control
	EnableWhitelist *bool `json:"enable_whitelist,omitempty"`
	// Specifies the whitelist for controlling access to the VPC endpoint
	Whitelist []string `json:"whitelist,omitempty"`
	// Specifies the IDs of route tables
	RouteTables []string `json:"routeTables,omitempty"`
	// Specifies the resource tags in key/value format
	Tags []tags.ResourceTag `json:"tags,omitempty"`
}

CreateOpts contains the options for create a VPC endpoint This object is passed to Create().

func (CreateOpts) ToEndpointCreateMap

func (opts CreateOpts) ToEndpointCreateMap() (map[string]interface{}, error)

ToEndpointCreateMap assembles a request body based on the contents of a CreateOpts.

type CreateOptsBuilder

type CreateOptsBuilder interface {
	ToEndpointCreateMap() (map[string]interface{}, error)
}

CreateOptsBuilder allows extensions to add parameters to the Create request.

type CreateResult

type CreateResult struct {
	// contains filtered or unexported fields
}

CreateResult represents the result of a create operation. Call its Extract method to interpret it as a Endpoint.

func Create

func Create(c *golangsdk.ServiceClient, opts CreateOptsBuilder) (r CreateResult)

Create accepts a CreateOpts struct and uses the values to create a new VPC endpoint

func (CreateResult) Extract

func (r CreateResult) Extract() (*Endpoint, error)

Extract is a function that accepts a result and extracts a Endpoint

type DeleteResult

type DeleteResult struct {
	golangsdk.ErrResult
}

DeleteResult represents the result of a delete operation. Call its ExtractErr method to determine if the request succeeded or failed.

func Delete

func Delete(c *golangsdk.ServiceClient, endpointID string) (r DeleteResult)

Delete will permanently delete a particular VPC endpoint based on its unique ID

type Endpoint

type Endpoint struct {
	// the ID of the VPC endpoint
	ID string `json:"id"`
	// the connection status of the VPC endpoint
	Status string `json:"status"`
	// the account status: frozen or active
	ActiveStatus []string `json:"active_status"`
	// the type of the VPC endpoint service that is associated with the VPC endpoint
	ServiceType string `json:"service_type"`
	// the name of the VPC endpoint service
	ServiceName string `json:"endpoint_service_name"`
	// the ID of the VPC endpoint service
	ServiceID string `json:"endpoint_service_id"`
	// the ID of the VPC where the VPC endpoint is to be created
	VpcID string `json:"vpc_id"`
	// the network ID of the subnet in the VPC specified by vpc_id
	SubnetID string `json:"subnet_id"`
	// the IP address for accessing the associated VPC endpoint service
	IPAddr string `json:"ip"`
	// the packet ID of the VPC endpoint
	MarkerID int `json:"marker_id"`
	// whether to create a private domain name
	EnableDNS bool `json:"enable_dns"`
	// the domain name for accessing the associated VPC endpoint service
	DNSNames []string `json:"dns_names"`
	// whether to enable access control
	EnableWhitelist bool `json:"enable_whitelist"`
	// the whitelist for controlling access to the VPC endpoint
	Whitelist []string `json:"whitelist"`
	// the IDs of route tables
	RouteTables []string `json:"routetables"`
	// the resource tags
	Tags []tags.ResourceTag `json:"tags"`
	// the project ID
	ProjectID string `json:"project_id"`
	// the creation time of the VPC endpoint
	Created string `json:"created_at"`
	// the update time of the VPC endpoint
	Updated string `json:"updated_at"`
}

Endpoint contains the response of the VPC endpoint

func List

func List(client *golangsdk.ServiceClient, opts ListOptsBuilder) ([]Endpoint, error)

List makes a request against the API to list VPC endpoints.

type GetResult

type GetResult struct {
	// contains filtered or unexported fields
}

GetResult represents the result of a get operation. Call its Extract method to interpret it as a Endpoint.

func Get

func Get(c *golangsdk.ServiceClient, endpointID string) (r GetResult)

Get retrieves a particular VPC endpoint based on its unique ID

func (GetResult) Extract

func (r GetResult) Extract() (*Endpoint, error)

Extract is a function that accepts a result and extracts a Endpoint

type ListOpts

type ListOpts struct {
	ServiceName string `q:"endpoint_service_name"`
	VPCID       string `q:"vpc_id"`
	ID          string `q:"id"`
}

ListOpts allows the filtering of list data using given parameters.

func (ListOpts) ToEndpointListQuery

func (opts ListOpts) ToEndpointListQuery() (string, error)

ToEndpointListQuery formats a ListOpts into a query string.

type ListOptsBuilder

type ListOptsBuilder interface {
	ToEndpointListQuery() (string, error)
}

ListOptsBuilder allows extensions to add parameters to the List request.

type ListResult

type ListResult struct {
	// contains filtered or unexported fields
}

ListResult represents the result of a list operation. Call its ExtractEndpoints method to interpret it as Endpoints.

func (ListResult) Extract

func (r ListResult) Extract() (*Endpoint, error)

Extract is a function that accepts a result and extracts a Endpoint

func (ListResult) ExtractEndpoints

func (r ListResult) ExtractEndpoints() ([]Endpoint, error)

ExtractEndpoints is a function that accepts a result and extracts the given Endpoints