apiissuecomment

package
v0.20240712.1173055 Latest Latest
Warning

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

 Go to latest Published: Jul 12, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README ¶

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

The apiissuecomment 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/apiissuecomment"

Client Initialization

client := apiissuecomment.NewApiIssueCommentClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiIssueCommentClient.CreateOrUpdate

ctx := context.TODO()
id := apiissuecomment.NewCommentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue", "commentIdValue")

payload := apiissuecomment.IssueCommentContract{
	// ...
}


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

Example Usage: ApiIssueCommentClient.Delete

ctx := context.TODO()
id := apiissuecomment.NewCommentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue", "commentIdValue")

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

Example Usage: ApiIssueCommentClient.Get

ctx := context.TODO()
id := apiissuecomment.NewCommentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue", "commentIdValue")

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: ApiIssueCommentClient.GetEntityTag

ctx := context.TODO()
id := apiissuecomment.NewCommentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue", "commentIdValue")

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: ApiIssueCommentClient.ListByService

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

// alternatively `client.ListByService(ctx, id, apiissuecomment.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, apiissuecomment.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 ValidateApiIssueID ¶ 

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

ValidateApiIssueID checks that 'input' can be parsed as a Api Issue ID

func ValidateCommentID ¶ 

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

ValidateCommentID checks that 'input' can be parsed as a Comment ID

Types ¶

type ApiIssueCommentClient ¶ 

type ApiIssueCommentClient struct {
	Client *resourcemanager.Client
}

func NewApiIssueCommentClientWithBaseURI ¶ 

func NewApiIssueCommentClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiIssueCommentClient, error)

func (ApiIssueCommentClient) CreateOrUpdate ¶ 

func (c ApiIssueCommentClient) CreateOrUpdate(ctx context.Context, id CommentId, input IssueCommentContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApiIssueCommentClient) Delete ¶ 

func (c ApiIssueCommentClient) Delete(ctx context.Context, id CommentId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (ApiIssueCommentClient) Get ¶ 

func (c ApiIssueCommentClient) Get(ctx context.Context, id CommentId) (result GetOperationResponse, err error)

Get ...

func (ApiIssueCommentClient) GetEntityTag ¶ 

func (c ApiIssueCommentClient) GetEntityTag(ctx context.Context, id CommentId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (ApiIssueCommentClient) ListByService ¶ 

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

ListByService ...

func (ApiIssueCommentClient) ListByServiceComplete ¶ 

func (c ApiIssueCommentClient) ListByServiceComplete(ctx context.Context, id ApiIssueId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (ApiIssueCommentClient) ListByServiceCompleteMatchingPredicate ¶ 

func (c ApiIssueCommentClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiIssueId, options ListByServiceOperationOptions, predicate IssueCommentContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ApiIssueId ¶ 

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

ApiIssueId is a struct representing the Resource ID for a Api Issue

func NewApiIssueID ¶ 

func NewApiIssueID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, issueId string) ApiIssueId

NewApiIssueID returns a new ApiIssueId struct

func ParseApiIssueID ¶ 

func ParseApiIssueID(input string) (*ApiIssueId, error)

ParseApiIssueID parses 'input' into a ApiIssueId

func ParseApiIssueIDInsensitively ¶ 

func ParseApiIssueIDInsensitively(input string) (*ApiIssueId, error)

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

func (*ApiIssueId) FromParseResult ¶ 

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

func (ApiIssueId) ID ¶ 

func (id ApiIssueId) ID() string

ID returns the formatted Api Issue ID

func (ApiIssueId) Segments ¶ 

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

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

func (ApiIssueId) String ¶ 

func (id ApiIssueId) String() string

String returns a human-readable description of this Api Issue ID

type CommentId ¶ 

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

CommentId is a struct representing the Resource ID for a Comment

func NewCommentID ¶ 

func NewCommentID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, issueId string, commentId string) CommentId

NewCommentID returns a new CommentId struct

func ParseCommentID ¶ 

func ParseCommentID(input string) (*CommentId, error)

ParseCommentID parses 'input' into a CommentId

func ParseCommentIDInsensitively ¶ 

func ParseCommentIDInsensitively(input string) (*CommentId, error)

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

func (*CommentId) FromParseResult ¶ 

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

func (CommentId) ID ¶ 

func (id CommentId) ID() string

ID returns the formatted Comment ID

func (CommentId) Segments ¶ 

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

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

func (CommentId) String ¶ 

func (id CommentId) String() string

String returns a human-readable description of this Comment ID

type CreateOrUpdateOperationOptions ¶ 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions ¶ 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders ¶ 

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

func (CreateOrUpdateOperationOptions) ToOData ¶ 

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

func (CreateOrUpdateOperationOptions) ToQuery ¶ 

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

type CreateOrUpdateOperationResponse ¶ 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IssueCommentContract
}

type DeleteOperationOptions ¶ 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions ¶ 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders ¶ 

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

func (DeleteOperationOptions) ToOData ¶ 

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

func (DeleteOperationOptions) ToQuery ¶ 

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

type DeleteOperationResponse ¶ 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetEntityTagOperationResponse ¶ 

type GetEntityTagOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse ¶ 

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

type IssueCommentContract ¶ 

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

type IssueCommentContractOperationPredicate ¶ 

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

func (IssueCommentContractOperationPredicate) Matches ¶ 

func (p IssueCommentContractOperationPredicate) Matches(input IssueCommentContract) bool

type IssueCommentContractProperties ¶ 

type IssueCommentContractProperties struct {
	CreatedDate *string `json:"createdDate,omitempty"`
	Text        string  `json:"text"`
	UserId      string  `json:"userId"`
}

func (*IssueCommentContractProperties) GetCreatedDateAsTime ¶ 

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

func (*IssueCommentContractProperties) SetCreatedDateAsTime ¶ 

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

type ListByServiceCompleteResult ¶ 

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

type ListByServiceCustomPager ¶ added in v0.20240628.1153531 

type ListByServiceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByServiceCustomPager) NextPageLink() *odata.Link

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        *[]IssueCommentContract
}

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.