apiissue

package
v0.20230309.1163107 Latest Latest
Warning

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

Go to latest
Published: Mar 9, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/apiissue Documentation

The apiissue SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2021-08-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/apiissue"

Client Initialization

client := apiissue.NewApiIssueClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiIssueClient.CreateOrUpdate

ctx := context.TODO()
id := apiissue.NewIssueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "issueIdValue")

payload := apiissue.IssueContract{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload, apiissue.DefaultCreateOrUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ApiIssueClient.Delete

ctx := context.TODO()
id := apiissue.NewIssueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "issueIdValue")

read, err := client.Delete(ctx, id, apiissue.DefaultDeleteOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ApiIssueClient.Get

ctx := context.TODO()
id := apiissue.NewIssueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "issueIdValue")

read, err := client.Get(ctx, id, apiissue.DefaultGetOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ApiIssueClient.GetEntityTag

ctx := context.TODO()
id := apiissue.NewIssueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "issueIdValue")

read, err := client.GetEntityTag(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ApiIssueClient.ListByService

ctx := context.TODO()
id := apiissue.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue")

// alternatively `client.ListByService(ctx, id, apiissue.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, apiissue.DefaultListByServiceOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ApiIssueClient.Update

ctx := context.TODO()
id := apiissue.NewIssueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "issueIdValue")

payload := apiissue.IssueUpdateContract{
	// ...
}


read, err := client.Update(ctx, id, payload, apiissue.DefaultUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForState

func PossibleValuesForState() []string

func ValidateApiID

func ValidateApiID(input interface{}, key string) (warnings []string, errors []error)

ValidateApiID checks that 'input' can be parsed as a Api ID

func ValidateIssueID

func ValidateIssueID(input interface{}, key string) (warnings []string, errors []error)

ValidateIssueID checks that 'input' can be parsed as a Issue ID

Types

type ApiId

type ApiId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ApiId             string
}

ApiId is a struct representing the Resource ID for a Api

func NewApiID

func NewApiID(subscriptionId string, resourceGroupName string, serviceName string, apiId string) ApiId

NewApiID returns a new ApiId struct

func ParseApiID

func ParseApiID(input string) (*ApiId, error)

ParseApiID parses 'input' into a ApiId

func ParseApiIDInsensitively

func ParseApiIDInsensitively(input string) (*ApiId, error)

ParseApiIDInsensitively parses 'input' case-insensitively into a ApiId note: this method should only be used for API response data and not user input

func (ApiId) ID

func (id ApiId) ID() string

ID returns the formatted Api ID

func (ApiId) Segments

func (id ApiId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Api ID

func (ApiId) String

func (id ApiId) String() string

String returns a human-readable description of this Api ID

type ApiIssueClient

type ApiIssueClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewApiIssueClientWithBaseURI

func NewApiIssueClientWithBaseURI(endpoint string) ApiIssueClient

func (ApiIssueClient) CreateOrUpdate

CreateOrUpdate ...

func (ApiIssueClient) Delete

Delete ...

func (ApiIssueClient) Get

func (c ApiIssueClient) Get(ctx context.Context, id IssueId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (ApiIssueClient) GetEntityTag

func (c ApiIssueClient) GetEntityTag(ctx context.Context, id IssueId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (ApiIssueClient) ListByService

ListByService ...

func (ApiIssueClient) ListByServiceComplete

ListByServiceComplete retrieves all of the results into a single object

func (ApiIssueClient) ListByServiceCompleteMatchingPredicate

func (c ApiIssueClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiId, options ListByServiceOperationOptions, predicate IssueContractOperationPredicate) (resp ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ApiIssueClient) Update

Update ...

type CreateOrUpdateOperationOptions

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *IssueContract
}

type DeleteOperationOptions

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions

func DefaultDeleteOperationOptions() DeleteOperationOptions

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetEntityTagOperationResponse

type GetEntityTagOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationOptions

type GetOperationOptions struct {
	ExpandCommentsAttachments *bool
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *IssueContract
}

type IssueContract

type IssueContract struct {
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *IssueContractProperties `json:"properties,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type IssueContractOperationPredicate

type IssueContractOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (IssueContractOperationPredicate) Matches

type IssueContractProperties

type IssueContractProperties struct {
	ApiId       *string `json:"apiId,omitempty"`
	CreatedDate *string `json:"createdDate,omitempty"`
	Description string  `json:"description"`
	State       *State  `json:"state,omitempty"`
	Title       string  `json:"title"`
	UserId      string  `json:"userId"`
}

func (*IssueContractProperties) GetCreatedDateAsTime

func (o *IssueContractProperties) GetCreatedDateAsTime() (*time.Time, error)

func (*IssueContractProperties) SetCreatedDateAsTime

func (o *IssueContractProperties) SetCreatedDateAsTime(input time.Time)

type IssueId

type IssueId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	IssueId           string
}

IssueId is a struct representing the Resource ID for a Issue

func NewIssueID

func NewIssueID(subscriptionId string, resourceGroupName string, serviceName string, issueId string) IssueId

NewIssueID returns a new IssueId struct

func ParseIssueID

func ParseIssueID(input string) (*IssueId, error)

ParseIssueID parses 'input' into a IssueId

func ParseIssueIDInsensitively

func ParseIssueIDInsensitively(input string) (*IssueId, error)

ParseIssueIDInsensitively parses 'input' case-insensitively into a IssueId note: this method should only be used for API response data and not user input

func (IssueId) ID

func (id IssueId) ID() string

ID returns the formatted Issue ID

func (IssueId) Segments

func (id IssueId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Issue ID

func (IssueId) String

func (id IssueId) String() string

String returns a human-readable description of this Issue ID

type IssueUpdateContract

type IssueUpdateContract struct {
	Properties *IssueUpdateContractProperties `json:"properties,omitempty"`
}

type IssueUpdateContractProperties

type IssueUpdateContractProperties struct {
	ApiId       *string `json:"apiId,omitempty"`
	CreatedDate *string `json:"createdDate,omitempty"`
	Description *string `json:"description,omitempty"`
	State       *State  `json:"state,omitempty"`
	Title       *string `json:"title,omitempty"`
	UserId      *string `json:"userId,omitempty"`
}

func (*IssueUpdateContractProperties) GetCreatedDateAsTime

func (o *IssueUpdateContractProperties) GetCreatedDateAsTime() (*time.Time, error)

func (*IssueUpdateContractProperties) SetCreatedDateAsTime

func (o *IssueUpdateContractProperties) SetCreatedDateAsTime(input time.Time)

type ListByServiceCompleteResult

type ListByServiceCompleteResult struct {
	Items []IssueContract
}

type ListByServiceOperationOptions

type ListByServiceOperationOptions struct {
	ExpandCommentsAttachments *bool
	Filter                    *string
	Skip                      *int64
	Top                       *int64
}

func DefaultListByServiceOperationOptions

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

type ListByServiceOperationResponse

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]IssueContract
	// contains filtered or unexported fields
}

func (ListByServiceOperationResponse) HasMore

func (ListByServiceOperationResponse) LoadMore

type State

type State string
const (
	StateClosed   State = "closed"
	StateOpen     State = "open"
	StateProposed State = "proposed"
	StateRemoved  State = "removed"
	StateResolved State = "resolved"
)

type UpdateOperationOptions

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *IssueContract
}

Jump to

Keyboard shortcuts

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