issue

package
v0.20240612.1122027 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/issue Documentation

The issue SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2022-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/2022-08-01/issue"

Client Initialization

client := issue.NewIssueClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IssueClient.Get

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

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

Example Usage: IssueClient.ListByService

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForState 

func PossibleValuesForState() []string

func ValidateIssueID 

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

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

func ValidateServiceID 

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type GetOperationResponse 

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

type IssueClient 

type IssueClient struct {
	Client *resourcemanager.Client
}

func NewIssueClientWithBaseURI 

func NewIssueClientWithBaseURI(sdkApi sdkEnv.Api) (*IssueClient, error)

func (IssueClient) Get 

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

Get ...

func (IssueClient) ListByService 

func (c IssueClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)

ListByService ...

func (IssueClient) ListByServiceComplete 

func (c IssueClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (IssueClient) ListByServiceCompleteMatchingPredicate 

func (c IssueClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate IssueContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 

func (p IssueContractOperationPredicate) Matches(input IssueContract) bool

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) FromParseResult 

func (id *IssueId) FromParseResult(input resourceids.ParseResult) error

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 ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IssueContract
}

type ListByServiceOperationOptions 

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

func DefaultListByServiceOperationOptions 

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

func (ListByServiceOperationOptions) ToHeaders 

func (o ListByServiceOperationOptions) ToHeaders() *client.Headers

func (ListByServiceOperationOptions) ToOData 

func (o ListByServiceOperationOptions) ToOData() *odata.Query

func (ListByServiceOperationOptions) ToQuery 

func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams

type ListByServiceOperationResponse 

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IssueContract
}

type ServiceId 

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID 

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID 

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively 

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult 

func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error

func (ServiceId) ID 

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments 

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

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

func (ServiceId) String 

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type State 

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

func (*State) UnmarshalJSON 

func (s *State) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.