apiissuecomment

package
v0.20230208.1154850 Latest Latest
Warning

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

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

README

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

The apiissuecomment 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/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.NewIssueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "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 ValidateCommentID 

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

ValidateCommentID checks that 'input' can be parsed as a Comment 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 ApiIssueCommentClient 

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

func NewApiIssueCommentClientWithBaseURI 

func NewApiIssueCommentClientWithBaseURI(endpoint string) ApiIssueCommentClient

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 IssueId, options ListByServiceOperationOptions) (resp ListByServiceOperationResponse, err error)

ListByService ...

func (ApiIssueCommentClient) ListByServiceComplete 

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

ListByServiceComplete retrieves all of the results into a single object

func (ApiIssueCommentClient) ListByServiceCompleteMatchingPredicate 

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

ListByServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

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

type CreateOrUpdateOperationResponse 

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

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 GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	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 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 ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	Items []IssueCommentContract
}

type ListByServiceOperationOptions 

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

func DefaultListByServiceOperationOptions 

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

type ListByServiceOperationResponse 

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

func (ListByServiceOperationResponse) HasMore 

func (r ListByServiceOperationResponse) HasMore() bool

func (ListByServiceOperationResponse) LoadMore 

func (r ListByServiceOperationResponse) LoadMore(ctx context.Context) (resp ListByServiceOperationResponse, err 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.