stackresources

package
v0.5.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 3, 2021 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Overview

Package stackresources provides operations for working with stack resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ListOpts

type ListOpts struct {
	// Specifies the logical resource ID of the resource.
	LogicalID string `q:"logical_resource_id"`

	// Name is the human readable name for the Resource.
	Name string `q:"resource_name"`

	// Specifies the Physical resource ID of the resource.
	PhysicalID string `q:"physical_resource_id"`

	// Status indicates whether or not a subnet is currently operational.
	Status string `q:"resource_status"`

	// Specifies the resource type that are defined in the template.
	Type string `q:"resource_type"`
}

ListOpts allows the filtering and sorting of paginated collections through the API. Filtering is achieved by passing in struct field values that map to the rts attributes you want to see returned.

type ListOptsBuilder

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

ListOptsBuilder allows extensions to add additional parameters to the List request.

type Resource

type Resource struct {
	CreationTime time.Time        `json:"-"`
	Links        []golangsdk.Link `json:"links"`
	LogicalID    string           `json:"logical_resource_id"`
	Name         string           `json:"resource_name"`
	PhysicalID   string           `json:"physical_resource_id"`
	RequiredBy   []string         `json:"required_by"`
	Status       string           `json:"resource_status"`
	StatusReason string           `json:"resource_status_reason"`
	Type         string           `json:"resource_type"`
	UpdatedTime  time.Time        `json:"-"`
}

Resource represents a stack resource.

func ExtractResources

func ExtractResources(r pagination.Page) ([]Resource, error)

ExtractResources accepts a Page struct, specifically a ResourcePage struct, and extracts the elements into a slice of Resource structs. In other words, a generic collection is mapped into a relevant slice.

func FilterResources

func FilterResources(resources []Resource, opts ListOpts) ([]Resource, error)

func List

func List(client *golangsdk.ServiceClient, stackName string, opts ListOpts) ([]Resource, error)

List returns collection of resources. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.

Default policy settings return only those resources that are owned by the tenant who submits the request, unless an admin user submits the request.

func (*Resource) UnmarshalJSON

func (r *Resource) UnmarshalJSON(b []byte) error

type ResourcePage

type ResourcePage struct {
	pagination.LinkedPageBase
}

ResourcePage is the page returned by a pager when traversing over a collection of resources.

func (ResourcePage) IsEmpty

func (r ResourcePage) IsEmpty() (bool, error)

IsEmpty returns true if a page contains no Server results.

Directories

Path Synopsis
orchestration_stackresources_v1
orchestration_stackresources_v1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL