euprop

Documentation

Overview

Generated API client customizations

Package euprop provides the client and types for making API requests to Eucalyptus Properties.

See https://docs.aws.amazon.com/goto/WebAPI/euprop-2010-01-01 for more information on this service.

See euprop package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/euprop/

Using the Client

To use Eucalyptus Properties with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Eucalyptus Properties client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/euprop/#New

Index

• Constants
• type Client
  • func New(config aws.Config) *Client
  • func (c *Client) DescribePropertiesRequest(input *DescribePropertiesInput) DescribePropertiesRequest
  • func (c *Client) ModifyPropertyValueRequest(input *ModifyPropertyValueInput) ModifyPropertyValueRequest
• type DescribePropertiesInput
  • func (s DescribePropertiesInput) String() string
• type DescribePropertiesOutput
  • func (s DescribePropertiesOutput) String() string
• type DescribePropertiesRequest
  • func (r DescribePropertiesRequest) Send(ctx context.Context) (*DescribePropertiesResponse, error)
• type DescribePropertiesResponse
  • func (r *DescribePropertiesResponse) SDKResponseMetdata() *aws.Response
• type ModifyPropertyValueInput
  • func (s ModifyPropertyValueInput) String() string
  • func (s *ModifyPropertyValueInput) Validate() error
• type ModifyPropertyValueOutput
  • func (s ModifyPropertyValueOutput) String() string
• type ModifyPropertyValueRequest
  • func (r ModifyPropertyValueRequest) Send(ctx context.Context) (*ModifyPropertyValueResponse, error)
• type ModifyPropertyValueResponse
  • func (r *ModifyPropertyValueResponse) SDKResponseMetdata() *aws.Response
• type Property
  • func (s Property) String() string

Constants

const (
	ServiceName = "Eucalyptus Properties" // Service's name
	ServiceID   = "Euprop"                // Service's identifier
	EndpointsID = "properties"            // Service's Endpoint identifier
)

const (

	// ErrCodeModifyPropertyException for service response error code
	// "ModifyPropertyValueType".
	ErrCodeModifyPropertyException = "ModifyPropertyValueType"

	// ErrCodeServiceFailureException for service response error code
	// "ServiceFailure".
	ErrCodeServiceFailureException = "ServiceFailure"
)

Types

type Client

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Eucalyptus Properties. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := euprop.New(myConfig)

func (*Client) DescribePropertiesRequest

func (c *Client) DescribePropertiesRequest(input *DescribePropertiesInput) DescribePropertiesRequest

DescribePropertiesRequest returns a request value for making API operation for Eucalyptus Cloud Properties Service.

// Example sending a request using DescribePropertiesRequest.
req := client.DescribePropertiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/euprop-2010-01-01/DescribeProperties

func (*Client) ModifyPropertyValueRequest

func (c *Client) ModifyPropertyValueRequest(input *ModifyPropertyValueInput) ModifyPropertyValueRequest

ModifyPropertyValueRequest returns a request value for making API operation for Eucalyptus Cloud Properties Service.

// Example sending a request using ModifyPropertyValueRequest.
req := client.ModifyPropertyValueRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/euprop-2010-01-01/ModifyPropertyValue

type DescribePropertiesInput

type DescribePropertiesInput struct {
	Properties []string `locationName:"Property" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

func (DescribePropertiesInput) String

func (s DescribePropertiesInput) String() string

String returns the string representation

type DescribePropertiesOutput

type DescribePropertiesOutput struct {
	Properties []Property `locationName:"properties" locationNameList:"item" type:"list"`
	// contains filtered or unexported fields
}

func (DescribePropertiesOutput) String

func (s DescribePropertiesOutput) String() string

String returns the string representation

type DescribePropertiesRequest

type DescribePropertiesRequest struct {
	*aws.Request
	Input *DescribePropertiesInput
	Copy  func(*DescribePropertiesInput) DescribePropertiesRequest
}

DescribePropertiesRequest is the request type for the DescribeProperties API operation.

func (DescribePropertiesRequest) Send

func (r DescribePropertiesRequest) Send(ctx context.Context) (*DescribePropertiesResponse, error)

Send marshals and sends the DescribeProperties API request.

type DescribePropertiesResponse

type DescribePropertiesResponse struct {
	*DescribePropertiesOutput
	// contains filtered or unexported fields
}

DescribePropertiesResponse is the response type for the DescribeProperties API operation.

func (*DescribePropertiesResponse) SDKResponseMetdata

func (r *DescribePropertiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeProperties request.

type ModifyPropertyValueInput

type ModifyPropertyValueInput struct {

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

	Reset *bool `locationName:"Reset" type:"boolean"`

	Value *string `locationName:"Value" type:"string"`
	// contains filtered or unexported fields
}

func (ModifyPropertyValueInput) String

func (s ModifyPropertyValueInput) String() string

String returns the string representation

func (*ModifyPropertyValueInput) Validate

func (s *ModifyPropertyValueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyPropertyValueOutput

type ModifyPropertyValueOutput struct {
	Name *string `locationName:"name" type:"string"`

	OldValue *string `locationName:"oldValue" type:"string"`

	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

func (ModifyPropertyValueOutput) String

func (s ModifyPropertyValueOutput) String() string

String returns the string representation

type ModifyPropertyValueRequest

type ModifyPropertyValueRequest struct {
	*aws.Request
	Input *ModifyPropertyValueInput
	Copy  func(*ModifyPropertyValueInput) ModifyPropertyValueRequest
}

ModifyPropertyValueRequest is the request type for the ModifyPropertyValue API operation.

func (ModifyPropertyValueRequest) Send

func (r ModifyPropertyValueRequest) Send(ctx context.Context) (*ModifyPropertyValueResponse, error)

Send marshals and sends the ModifyPropertyValue API request.

type ModifyPropertyValueResponse

type ModifyPropertyValueResponse struct {
	*ModifyPropertyValueOutput
	// contains filtered or unexported fields
}

ModifyPropertyValueResponse is the response type for the ModifyPropertyValue API operation.

func (*ModifyPropertyValueResponse) SDKResponseMetdata

func (r *ModifyPropertyValueResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyPropertyValue request.

type Property

type Property struct {
	DefaultValue *string `locationName:"defaultValue" type:"string"`

	Description *string `locationName:"description" type:"string"`

	Name *string `locationName:"name" type:"string"`

	ReadOnly *bool `locationName:"readOnly" type:"boolean"`

	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

func (Property) String

func (s Property) String() string

String returns the string representation