developer

Documentation

Index

• type DPGClient
  • func NewDPGClient(pl runtime.Pipeline) *DPGClient
  • func (client *DPGClient) BeginLro(ctx context.Context, mode string, options *DPGClientBeginLroOptions) (*runtime.Poller[DPGClientLroResponse], error)
  • func (client *DPGClient) GetModel(ctx context.Context, mode string, options *DPGClientGetModelOptions) (DPGClientGetModelResponse, error)
  • func (client *DPGClient) NewGetPagesPager(mode string, options *DPGClientGetPagesOptions) *runtime.Pager[DPGClientGetPagesResponse]
  • func (client *DPGClient) PostModel(ctx context.Context, mode string, input Input, ...) (DPGClientPostModelResponse, error)
• type DPGClientBeginLroOptions
• type DPGClientGetModelOptions
• type DPGClientGetModelResponse
• type DPGClientGetPagesOptions
• type DPGClientGetPagesResponse
• type DPGClientLroResponse
• type DPGClientPostModelOptions
• type DPGClientPostModelResponse
• type Input
  • func (i Input) MarshalJSON() ([]byte, error)
  • func (i *Input) UnmarshalJSON(data []byte) error
• type LROProduct
  • func (l LROProduct) MarshalJSON() ([]byte, error)
  • func (l *LROProduct) UnmarshalJSON(data []byte) error
• type Product
  • func (p Product) MarshalJSON() ([]byte, error)
  • func (p *Product) UnmarshalJSON(data []byte) error
• type ProductReceived
  • func PossibleProductReceivedValues() []ProductReceived
• type ProductResult
  • func (p ProductResult) MarshalJSON() ([]byte, error)
  • func (p *ProductResult) UnmarshalJSON(data []byte) error

Types

type DPGClient

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

func NewDPGClient

func NewDPGClient(pl runtime.Pipeline) *DPGClient

NewDPGClient creates a new instance of DPGClient with the specified values. pl - the pipeline used for sending requests and handling responses.

func (*DPGClient) BeginLro

func (client *DPGClient) BeginLro(ctx context.Context, mode string, options *DPGClientBeginLroOptions) (*runtime.Poller[DPGClientLroResponse], error)

BeginLro - Long running put request that will either return to end users a final payload of a raw body, or a final payload of a model after the SDK has grown up. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 1.0.0 mode - The mode with which you'll be handling your returned body. 'raw' for just dealing with the raw body, and 'model' if you are going to convert the raw body to a customized body before returning to users. options - DPGClientBeginLroOptions contains the optional parameters for the DPGClient.BeginLro method.

func (*DPGClient) GetModel

func (client *DPGClient) GetModel(ctx context.Context, mode string, options *DPGClientGetModelOptions) (DPGClientGetModelResponse, error)

GetModel - Get models that you will either return to end users as a raw body, or with a model added during grow up. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 1.0.0 mode - The mode with which you'll be handling your returned body. 'raw' for just dealing with the raw body, and 'model' if you are going to convert the raw body to a customized body before returning to users. options - DPGClientGetModelOptions contains the optional parameters for the DPGClient.GetModel method.

func (*DPGClient) NewGetPagesPager

func (client *DPGClient) NewGetPagesPager(mode string, options *DPGClientGetPagesOptions) *runtime.Pager[DPGClientGetPagesResponse]

NewGetPagesPager - Get pages that you will either return to users in pages of raw bodies, or pages of models following growup. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 1.0.0 mode - The mode with which you'll be handling your returned body. 'raw' for just dealing with the raw body, and 'model' if you are going to convert the raw body to a customized body before returning to users. options - DPGClientGetPagesOptions contains the optional parameters for the DPGClient.GetPages method.

func (*DPGClient) PostModel

func (client *DPGClient) PostModel(ctx context.Context, mode string, input Input, options *DPGClientPostModelOptions) (DPGClientPostModelResponse, error)

PostModel - Post either raw response as a model and pass in 'raw' for mode, or grow up your operation to take a model instead, and put in 'model' as mode. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 1.0.0 mode - The mode with which you'll be handling your returned body. 'raw' for just dealing with the raw body, and 'model' if you are going to convert the raw body to a customized body before returning to users. input - Please put {'hello': 'world!'} options - DPGClientPostModelOptions contains the optional parameters for the DPGClient.PostModel method.

type DPGClientBeginLroOptions

type DPGClientBeginLroOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DPGClientBeginLroOptions contains the optional parameters for the DPGClient.BeginLro method.

type DPGClientGetModelOptions

type DPGClientGetModelOptions struct {
}

DPGClientGetModelOptions contains the optional parameters for the DPGClient.GetModel method.

type DPGClientGetModelResponse

type DPGClientGetModelResponse struct {
	Product
}

DPGClientGetModelResponse contains the response from method DPGClient.GetModel.

type DPGClientGetPagesOptions

type DPGClientGetPagesOptions struct {
}

DPGClientGetPagesOptions contains the optional parameters for the DPGClient.GetPages method.

type DPGClientGetPagesResponse

type DPGClientGetPagesResponse struct {
	ProductResult
}

DPGClientGetPagesResponse contains the response from method DPGClient.GetPages.

type DPGClientLroResponse

type DPGClientLroResponse struct {
	LROProduct
}

DPGClientLroResponse contains the response from method DPGClient.Lro.

type DPGClientPostModelOptions

type DPGClientPostModelOptions struct {
}

DPGClientPostModelOptions contains the optional parameters for the DPGClient.PostModel method.

type DPGClientPostModelResponse

type DPGClientPostModelResponse struct {
	Product
}

DPGClientPostModelResponse contains the response from method DPGClient.PostModel.

type Input

type Input struct {
	// REQUIRED
	Hello *string `json:"hello,omitempty"`
}

func (Input) MarshalJSON

func (i Input) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Input.

func (*Input) UnmarshalJSON

func (i *Input) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Input.

type LROProduct

type LROProduct struct {
	// REQUIRED
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// REQUIRED
	Received *ProductReceived `json:"received,omitempty"`
}

func (LROProduct) MarshalJSON

func (l LROProduct) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LROProduct.

func (*LROProduct) UnmarshalJSON

func (l *LROProduct) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LROProduct.

type Product

type Product struct {
	// REQUIRED
	Received *ProductReceived `json:"received,omitempty"`
}

func (Product) MarshalJSON

func (p Product) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Product.

func (*Product) UnmarshalJSON

func (p *Product) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Product.

type ProductReceived

type ProductReceived string

const (
	ProductReceivedModel ProductReceived = "model"
	ProductReceivedRaw   ProductReceived = "raw"
)

func PossibleProductReceivedValues

func PossibleProductReceivedValues() []ProductReceived

PossibleProductReceivedValues returns the possible values for the ProductReceived const type.

type ProductResult

type ProductResult struct {
	NextLink *string    `json:"nextLink,omitempty"`
	Values   []*Product `json:"values,omitempty"`
}

func (ProductResult) MarshalJSON

func (p ProductResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProductResult.

func (*ProductResult) UnmarshalJSON

func (p *ProductResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProductResult.